Skip to content

Add a language definition for ddn CLI #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/theme/prism-include-languages.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import siteConfig from '@generated/docusaurus.config';
import type * as PrismNamespace from 'prismjs';
import type { Optional } from 'utility-types';

export default function prismIncludeLanguages(PrismObject: typeof PrismNamespace): void {
const {
themeConfig: { prism },
} = siteConfig;
const { additionalLanguages } = prism as { additionalLanguages: string[] };

// Prism components work on the Prism instance on the window, while prism-
// react-renderer uses its own Prism instance. We temporarily mount the
// instance onto window, import components to enhance it, then remove it to
// avoid polluting global namespace.
// You can mutate PrismObject: registering plugins, deleting languages... As
// long as you don't re-assign it
globalThis.Prism = PrismObject;

additionalLanguages.forEach(lang => {
if (lang === 'php') {
// eslint-disable-next-line global-require
require('prismjs/components/prism-markup-templating.js');
}
// eslint-disable-next-line global-require, import/no-dynamic-require
require(`prismjs/components/prism-${lang}`);
});

require('/static/prismjs/ddn.js');

delete (globalThis as Optional<typeof globalThis, 'Prism'>).Prism;
}
47 changes: 47 additions & 0 deletions static/prismjs/ddn.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Prism.languages.ddn = {
cli: {
pattern: /\bddn\b/,
alias: 'keyword',
},
flag: {
pattern: /--?[\w-]+/,
alias: 'attr-name',
},
// Specific argument types first
path: {
// Optional ./ ../ / prefix, segments with word chars/hyphens, optional extension
pattern: /(?:\.\.?\/|\/)?(?:[\w-]+(?:\/[\w-]+)*)(?:\.\w+)?/,
greedy: true, // Match longest path first
alias: 'string',
},
'connector-type': {
pattern: /\b\w+\/\w+\b/, // e.g., hasura/postgres
alias: 'class-name',
},
'versioned-name': {
// e.g., globals:c15b0b4031 or subgraph:version
pattern: /\b[a-zA-Z_][\w-]*:[a-zA-Z0-9][\w-]*\b/,
alias: 'namespace',
},
'key-value': {
// e.g. key=value used in --env flag
pattern: /\b\w+=\S+/,
alias: 'property',
},
number: {
pattern: /\b\d+\b/,
alias: 'number',
},
// Subcommands before general arguments
subcommand: {
// List all known subcommand parts from filenames + common ones
pattern:
/\b(?:project|command|connector|connector-link|model|relationship|subgraph|supergraph|auth|codemod|completion|console|context|help|plugins|run|update-cli|version|init|add|list|remove|show|update|bash|fish|powershell|zsh|generate-promptql-secret-key|login|upgrade-context-v2-to-v3|upgrade-graphqlconfig-aggregate|upgrade-graphqlconfig-subscriptions|upgrade-model-v1-to-v2|upgrade-object-boolean-expression-types|upgrade-project-config-v2-to-v3|upgrade-supergraph-config-v1-to-v2|create-context|get-context|get-current-context|get|set-current-context|set|unset|doctor|build|delete|diff|local|set-self-hosted-engine-url|prune|apply|create|env|introspect|plugin|setenv|show-resources|add-resources|install|uninstall|upgrade|set-api-access-mode|logs)\b/,
alias: 'function',
},
// General argument should be last
argument: {
pattern: /\b[a-zA-Z_][\w-]*\b/, // Allows leading underscore
alias: 'variable',
},
};