Rename defaultSyntaxLanguage to defaultCodeDirectiveLanguage

Trinovantes · Aug 14, 2024 · f83801b · f83801b
1 parent fa16f5f
commit f83801b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/src/Generator/RstGeneratorOptions.ts b/src/Generator/RstGeneratorOptions.ts
@@ -92,18 +92,18 @@ export type RstGeneratorOptions = {
     defaultLiteralBlockLanguage: string
 
     /**
-     * Default language for syntax highlighting in `code` and `code-block` Directive
+     * Default language for syntax highlighting in `code` and `code-block` Directives
      *
-     * Default: `''`
+     * Default: `'txt'`
      */
-    defaultSyntaxLanguage: string
+    defaultCodeDirectiveLanguage: string
 
     /**
      * ### HTML ONLY
      *
-     * Options for syntax highlighting with shiki
+     * Options for syntax highlighting `code` and `code-block` Directives with shiki
      *
-     * If not set, code blocks will output as `<pre>` and inline code will output as `<code>`
+     * If not set, `code` and `code-block` Directives will output code inside plain `<pre>`
      */
     shiki?: {
         highlighter: Awaited<ReturnType<typeof createHighlighter>>
@@ -166,7 +166,7 @@ export function createDefaultGeneratorOptions(opts?: Partial<RstGeneratorOptions
         } satisfies Required<RstGeneratorOptions['htmlClass']>,
 
         defaultLiteralBlockLanguage: 'txt',
-        defaultSyntaxLanguage: '',
+        defaultCodeDirectiveLanguage: 'txt',
 
         directivesWillOutputMdContainers: [],
     }

diff --git a/src/Plugins/Code/CodePlugin.ts b/src/Plugins/Code/CodePlugin.ts
@@ -16,13 +16,13 @@ export const highlightDirectiveGenerators = createDirectiveGenerators(
 
     (generatorState, node) => {
         generatorState.opts.defaultLiteralBlockLanguage = node.initContentText
-        generatorState.opts.defaultSyntaxLanguage = node.initContentText
+        generatorState.opts.defaultCodeDirectiveLanguage = node.initContentText
         generatorState.writeLineHtmlComment(node.toShortString())
     },
 
     (generatorState, node) => {
         generatorState.opts.defaultLiteralBlockLanguage = node.initContentText
-        generatorState.opts.defaultSyntaxLanguage = node.initContentText
+        generatorState.opts.defaultCodeDirectiveLanguage = node.initContentText
         generatorState.writeLineMdComment(node.toShortString())
     },
 )
@@ -34,12 +34,12 @@ export const codeDirectiveGenerators = createDirectiveGenerators(
     ],
 
     (generatorState, node) => {
-        const language = getCodeLanguage(node) ?? generatorState.opts.defaultSyntaxLanguage
+        const language = getCodeLanguage(node) ?? generatorState.opts.defaultCodeDirectiveLanguage
         renderCodeBlockHtml(generatorState, language, node.rawBodyText, node)
     },
 
     (generatorState, node) => {
-        const language = getCodeLanguage(node) ?? generatorState.opts.defaultSyntaxLanguage
+        const language = getCodeLanguage(node) ?? generatorState.opts.defaultCodeDirectiveLanguage
         renderCodeBlockMd(generatorState, language, node.rawBodyText)
     },
 )

diff --git a/tests/playground/server.ts b/tests/playground/server.ts
@@ -14,7 +14,7 @@ Bun.serve({
         const dirname = path.dirname(filename)
         const rst = fs.readFileSync(path.join(dirname, 'playground.rst')).toString('utf-8')
         const { body, header } = new RstToHtmlCompiler().compile(rst, {}, {
-            defaultSyntaxLanguage: 'python',
+            defaultCodeDirectiveLanguage: 'python',
             shiki: {
                 theme: 'github-light',
                 highlighter: await createHighlighter({

diff --git a/tests/unit/Plugins/Code/CodePlugin.test.ts b/tests/unit/Plugins/Code/CodePlugin.test.ts
@@ -52,7 +52,7 @@ describe('highlight Directive changes default language of code Directive', () =>
 
         <pre class="code">text 2</pre>
     `, `
-        \`\`\`
+        \`\`\`txt
         text 1
         \`\`\`