7576 - rename "enableHTML" option to "allowHTML"

withastro · Jul 7, 2023 · 10e0eec · 10e0eec
1 parent a1fecae
commit 10e0eec
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/packages/integrations/markdoc/src/content-entry-type.ts b/packages/integrations/markdoc/src/content-entry-type.ts
@@ -36,7 +36,7 @@ export async function getContentEntryType({
       const tokenizer = getMarkdocTokenizer(options);
 			let tokens = tokenizer.tokenize(entry.body);
 
-      if (options?.enableHTML) {
+      if (options?.allowHTML) {
         tokens = htmlTokenTransform(tokenizer, tokens);
       }
 

diff --git a/packages/integrations/markdoc/src/options.ts b/packages/integrations/markdoc/src/options.ts
@@ -1,3 +1,3 @@
 export interface MarkdocIntegrationOptions {
-  enableHTML?: boolean;
+  allowHTML?: boolean;
 }
diff --git a/packages/integrations/markdoc/src/runtime.ts b/packages/integrations/markdoc/src/runtime.ts
@@ -33,7 +33,7 @@ export async function setupConfig(userConfig: AstroMarkdocConfig = {}, options:
 
 	let merged = mergeConfig(defaultConfig, userConfig);
 
-  if (options?.enableHTML) {
+  if (options?.allowHTML) {
     merged = mergeConfig(merged, HTML_CONFIG);
   }
 
@@ -46,7 +46,7 @@ export function setupConfigSync(userConfig: AstroMarkdocConfig = {}, options: Ma
 
 	let merged = mergeConfig(defaultConfig, userConfig);
 
-  if (options?.enableHTML) {
+  if (options?.allowHTML) {
     merged = mergeConfig(merged, HTML_CONFIG);
   }
 
@@ -197,7 +197,7 @@ export function createContentComponent(
 	});
 }
 
-// statically define a partial MarkdocConfig which registers the required "html-tag" Markdoc tag when the "enableHTML" feature is enabled
+// statically define a partial MarkdocConfig which registers the required "html-tag" Markdoc tag when the "allowHTML" feature is enabled
 const HTML_CONFIG: AstroMarkdocConfig = {
   tags: {
     "html-tag": htmlTag,

diff --git a/packages/integrations/markdoc/src/tokenizer.ts b/packages/integrations/markdoc/src/tokenizer.ts
@@ -16,7 +16,7 @@ export function getMarkdocTokenizer(options: MarkdocIntegrationOptions | undefin
       allowComments: true,
     }
 
-    if (options?.enableHTML) {
+    if (options?.allowHTML) {
       // we want to allow indentation for Markdoc tags that are interleaved inside HTML block elements
       tokenizerOptions.allowIndentation = true;
       // enable HTML token detection in markdown-it

diff --git a/packages/integrations/markdoc/test/fixtures/render-html/astro.config.mjs b/packages/integrations/markdoc/test/fixtures/render-html/astro.config.mjs
@@ -3,5 +3,5 @@ import markdoc from '@astrojs/markdoc';
 
 // https://astro.build/config
 export default defineConfig({
-  integrations: [markdoc({ enableHTML: true })],
+  integrations: [markdoc({ allowHTML: true })],
 });