@brillout/docpress 0.15.10-commit-317b144 → 0.15.10-commit-05c2883

package/detypePlugin.ts

@@ -1,179 +0,0 @@
-export { detypePlugin }
-
-import type { PluginOption } from 'vite'
-import module from 'node:module'
-import { assertUsage } from './utils/assert.js'
-import pc from '@brillout/picocolors'
-import { getMagicString } from './utils/getMagicString.js'
-// Cannot use `import { transform } from 'detype'` as it results in errors,
-// and the package has no default export. Using `module.createRequire` instead.
-const { transform: detype } = module.createRequire(import.meta.url)('detype') as typeof import('detype')
-
-const prettierOptions: NonNullable<Parameters<typeof detype>[2]>['prettierOptions'] = {
-  semi: false,
-  singleQuote: true,
-  printWidth: 100,
-  trailingComma: 'none',
-}
-// RegExp to find TypeScript code blocks.
-//
-// For example:
-// ~~~mdx
-// ```ts
-// const hello: string = 'world'
-// ```
-// ~~~
-//
-// But also indented code blocks:
-// ~~~mdx
-// > Also works:
-// > - In blockquotes
-// > - In bullet points
-// >   ```ts
-// >   const hello: string = 'world'
-// >   ```
-// ~~~
-const codeBlockRE = /^(.*)```(tsx?|vue|yaml)[^\n]*\n([\s\S]*?)```/gm
-
-function detypePlugin(): PluginOption {
-  return {
-    name: '@brillout/docpress:detypePlugin',
-    enforce: 'pre',
-    transform: async (code: string, moduleId: string) => {
-      if (!moduleId.endsWith('.mdx')) return
-      return await transformCode(code, moduleId)
-    },
-  }
-}
-
-async function transformCode(code: string, moduleId: string) {
-  const matches = Array.from(code.matchAll(codeBlockRE))
-  if (matches.length === 0) return
-
-  const { magicString, getMagicStringResult } = getMagicString(code, moduleId)
-
-  magicString.prepend(`import { CodeSnippets, CodeSnippet } from '@brillout/docpress';\n\n`)
-
-  // [Claude AI] Process matches in reverse order to avoid offset issues
-  for (let i = matches.length - 1; i >= 0; i--) {
-    const match = matches[i]
-    const [codeBlockOuterStr, codeBlockIndent, codeBlockLang, codeBlockContentWithIndent] = match
-    const isYaml = codeBlockLang === 'yaml'
-
-    // Remove indentation
-    const codeBlockOpen = codeBlockOuterStr.split('\n')[0].slice(codeBlockIndent.length)
-    const codeBlockContent = removeCodeBlockIndent(codeBlockContentWithIndent, codeBlockIndent, moduleId)
-
-    let replacement: string
-    if (codeBlockOpen.includes('ts-only') && !isYaml) {
-      replacement = `${codeBlockIndent}<CodeSnippet codeLang="ts" tsOnly>\n${codeBlockOuterStr}\n${codeBlockIndent}</CodeSnippet>`
-    } else {
-      // someFileName.ts => someFileName.js
-      let codeBlockContentJs = codeBlockContent.replaceAll('.ts', '.js')
-      const codeBlockClose = '```'
-      if (isYaml && codeBlockContentJs === codeBlockContent) {
-        continue
-      }
-
-      // Remove TypeScript
-      if (!isYaml) {
-        codeBlockContentJs = await detype(codeBlockContentJs, `some-dummy-filename.${codeBlockLang}`, {
-          customizeBabelConfig(config) {
-            // Add `onlyRemoveTypeImports: true` to the internal `@babel/preset-typescript` config
-            // See https://github.com/cyco130/detype/blob/main/src/transform.ts#L206
-            assertUsage(config.presets && config.presets.length === 1, 'Unexpected Babel config presets')
-            config.presets = [[config.presets[0], { onlyRemoveTypeImports: true }]]
-          },
-          removeTsComments: true,
-          prettierOptions,
-        })
-        // Correct code diff comments
-        codeBlockContentJs = correctCodeDiffComments(codeBlockContentJs)
-      }
-
-      // Update code block open delimiter
-      const codeBlockLangJs =
-        codeBlockLang === 'vue'
-          ? 'vue'
-          : // ts => js | tsx => jsx
-            codeBlockLang.replace('t', 'j')
-      const codeBlockOpenJs = codeBlockOpen.replace(codeBlockLang, codeBlockLangJs)
-
-      // Wrap each with <CodeSnippet>
-      let codeSnippets = [
-        wrapCodeSnippet('ts', `${codeBlockOpen}\n${codeBlockContent}${codeBlockClose}`),
-        wrapCodeSnippet('js', `${codeBlockOpenJs}\n${codeBlockContentJs}${codeBlockClose}`),
-      ].join('\n')
-
-      // Wrap with <CodeSnippets> (if not YAML)
-      codeSnippets = isYaml
-        ? codeSnippets
-        : // Rename/Replace Words via Custom Magic Comments
-          processMagicComments(`<CodeSnippets>\n${codeSnippets}\n</CodeSnippets>`)
-
-      // Restore indentation
-      codeSnippets = restoreCodeBlockIndent(codeSnippets, codeBlockIndent)
-
-      // Done
-      replacement = codeSnippets
-    }
-
-    const blockStartIndex = match.index!
-    const blockEndIndex = blockStartIndex + codeBlockOuterStr.length
-    magicString.overwrite(blockStartIndex, blockEndIndex, replacement)
-  }
-
-  return getMagicStringResult()
-}
-
-function wrapCodeSnippet(lang: string, content: string) {
-  return `<CodeSnippet codeLang="${lang}">\n${content}\n</CodeSnippet>`
-}
-function removeCodeBlockIndent(code: string, codeBlockIndent: string, moduleId: string) {
-  if (!codeBlockIndent.length) return code
-  return code
-    .split('\n')
-    .map((line) => {
-      const lineStart = codeBlockIndent.trimEnd()
-      assertUsage(
-        line.startsWith(lineStart),
-        `In ${pc.bold(pc.blue(moduleId))} the line '${pc.bold(line)}' must start with '${pc.bold(lineStart)}'`,
-      )
-      return line.slice(codeBlockIndent.length)
-    })
-    .join('\n')
-}
-function restoreCodeBlockIndent(code: string, codeBlockIndent: string) {
-  if (!codeBlockIndent.length) return code
-  return code
-    .split('\n')
-    .map((line) => `${codeBlockIndent}${line}`)
-    .join('\n')
-}
-function processMagicComments(code: string) {
-  // @detype-rename DummyLayout>Layout
-  const renameCommentRE = /^\/\/\s@detype-rename\s(\w+)>(\w+)\n/gm
-  const matches = Array.from(code.matchAll(renameCommentRE))
-
-  if (matches.length) {
-    for (let i = 0; i < matches.length / 2; i++) {
-      const match = matches[i]
-      const [fullMatch, renameFrom, renameTo] = match
-      code = code.split(fullMatch).join('').replaceAll(renameFrom, renameTo)
-    }
-  }
-
-  return code.replaceAll('//~', '')
-}
-/**
- * Correct code diff comments that detype() unexpectedly reformatted (using Prettier and Babel internally)
- * after removing TypeScript.
- * See https://github.com/brillout/docpress/pull/47#issuecomment-3263953899
- * @param code Transformed Javascript code.
- * @returns The corrected code.
- */
-function correctCodeDiffComments(code: string) {
-  // Expected to match the code diff comments: `// [!code ++]` and `// [!code --]` started with newline and optional spaces
-  const codeDiffRE = /\n\s*\/\/\s\[!code.+\]/g
-  return code.replaceAll(codeDiffRE, (codeDiff) => codeDiff.trimStart())
-}

package/dist/detypePlugin.d.ts

@@ -1,3 +0,0 @@
-export { detypePlugin };
-import type { PluginOption } from 'vite';
-declare function detypePlugin(): PluginOption;

package/dist/detypePlugin.js

@@ -1,159 +0,0 @@
-export { detypePlugin };
-import module from 'node:module';
-import { assertUsage } from './utils/assert.js';
-import pc from '@brillout/picocolors';
-import { getMagicString } from './utils/getMagicString.js';
-// Cannot use `import { transform } from 'detype'` as it results in errors,
-// and the package has no default export. Using `module.createRequire` instead.
-const { transform: detype } = module.createRequire(import.meta.url)('detype');
-const prettierOptions = {
-    semi: false,
-    singleQuote: true,
-    printWidth: 100,
-    trailingComma: 'none',
-};
-// RegExp to find TypeScript code blocks.
-//
-// For example:
-// ~~~mdx
-// ```ts
-// const hello: string = 'world'
-// ```
-// ~~~
-//
-// But also indented code blocks:
-// ~~~mdx
-// > Also works:
-// > - In blockquotes
-// > - In bullet points
-// >   ```ts
-// >   const hello: string = 'world'
-// >   ```
-// ~~~
-const codeBlockRE = /^(.*)```(tsx?|vue|yaml)[^\n]*\n([\s\S]*?)```/gm;
-function detypePlugin() {
-    return {
-        name: '@brillout/docpress:detypePlugin',
-        enforce: 'pre',
-        transform: async (code, moduleId) => {
-            if (!moduleId.endsWith('.mdx'))
-                return;
-            return await transformCode(code, moduleId);
-        },
-    };
-}
-async function transformCode(code, moduleId) {
-    const matches = Array.from(code.matchAll(codeBlockRE));
-    if (matches.length === 0)
-        return;
-    const { magicString, getMagicStringResult } = getMagicString(code, moduleId);
-    magicString.prepend(`import { CodeSnippets, CodeSnippet } from '@brillout/docpress';\n\n`);
-    // [Claude AI] Process matches in reverse order to avoid offset issues
-    for (let i = matches.length - 1; i >= 0; i--) {
-        const match = matches[i];
-        const [codeBlockOuterStr, codeBlockIndent, codeBlockLang, codeBlockContentWithIndent] = match;
-        const isYaml = codeBlockLang === 'yaml';
-        // Remove indentation
-        const codeBlockOpen = codeBlockOuterStr.split('\n')[0].slice(codeBlockIndent.length);
-        const codeBlockContent = removeCodeBlockIndent(codeBlockContentWithIndent, codeBlockIndent, moduleId);
-        let replacement;
-        if (codeBlockOpen.includes('ts-only') && !isYaml) {
-            replacement = `${codeBlockIndent}<CodeSnippet codeLang="ts" tsOnly>\n${codeBlockOuterStr}\n${codeBlockIndent}</CodeSnippet>`;
-        }
-        else {
-            // someFileName.ts => someFileName.js
-            let codeBlockContentJs = codeBlockContent.replaceAll('.ts', '.js');
-            const codeBlockClose = '```';
-            if (isYaml && codeBlockContentJs === codeBlockContent) {
-                continue;
-            }
-            // Remove TypeScript
-            if (!isYaml) {
-                codeBlockContentJs = await detype(codeBlockContentJs, `some-dummy-filename.${codeBlockLang}`, {
-                    customizeBabelConfig(config) {
-                        // Add `onlyRemoveTypeImports: true` to the internal `@babel/preset-typescript` config
-                        // See https://github.com/cyco130/detype/blob/main/src/transform.ts#L206
-                        assertUsage(config.presets && config.presets.length === 1, 'Unexpected Babel config presets');
-                        config.presets = [[config.presets[0], { onlyRemoveTypeImports: true }]];
-                    },
-                    removeTsComments: true,
-                    prettierOptions,
-                });
-                // Correct code diff comments
-                codeBlockContentJs = correctCodeDiffComments(codeBlockContentJs);
-            }
-            // Update code block open delimiter
-            const codeBlockLangJs = codeBlockLang === 'vue'
-                ? 'vue'
-                : // ts => js | tsx => jsx
-                    codeBlockLang.replace('t', 'j');
-            const codeBlockOpenJs = codeBlockOpen.replace(codeBlockLang, codeBlockLangJs);
-            // Wrap each with <CodeSnippet>
-            let codeSnippets = [
-                wrapCodeSnippet('ts', `${codeBlockOpen}\n${codeBlockContent}${codeBlockClose}`),
-                wrapCodeSnippet('js', `${codeBlockOpenJs}\n${codeBlockContentJs}${codeBlockClose}`),
-            ].join('\n');
-            // Wrap with <CodeSnippets> (if not YAML)
-            codeSnippets = isYaml
-                ? codeSnippets
-                : // Rename/Replace Words via Custom Magic Comments
-                    processMagicComments(`<CodeSnippets>\n${codeSnippets}\n</CodeSnippets>`);
-            // Restore indentation
-            codeSnippets = restoreCodeBlockIndent(codeSnippets, codeBlockIndent);
-            // Done
-            replacement = codeSnippets;
-        }
-        const blockStartIndex = match.index;
-        const blockEndIndex = blockStartIndex + codeBlockOuterStr.length;
-        magicString.overwrite(blockStartIndex, blockEndIndex, replacement);
-    }
-    return getMagicStringResult();
-}
-function wrapCodeSnippet(lang, content) {
-    return `<CodeSnippet codeLang="${lang}">\n${content}\n</CodeSnippet>`;
-}
-function removeCodeBlockIndent(code, codeBlockIndent, moduleId) {
-    if (!codeBlockIndent.length)
-        return code;
-    return code
-        .split('\n')
-        .map((line) => {
-        const lineStart = codeBlockIndent.trimEnd();
-        assertUsage(line.startsWith(lineStart), `In ${pc.bold(pc.blue(moduleId))} the line '${pc.bold(line)}' must start with '${pc.bold(lineStart)}'`);
-        return line.slice(codeBlockIndent.length);
-    })
-        .join('\n');
-}
-function restoreCodeBlockIndent(code, codeBlockIndent) {
-    if (!codeBlockIndent.length)
-        return code;
-    return code
-        .split('\n')
-        .map((line) => `${codeBlockIndent}${line}`)
-        .join('\n');
-}
-function processMagicComments(code) {
-    // @detype-rename DummyLayout>Layout
-    const renameCommentRE = /^\/\/\s@detype-rename\s(\w+)>(\w+)\n/gm;
-    const matches = Array.from(code.matchAll(renameCommentRE));
-    if (matches.length) {
-        for (let i = 0; i < matches.length / 2; i++) {
-            const match = matches[i];
-            const [fullMatch, renameFrom, renameTo] = match;
-            code = code.split(fullMatch).join('').replaceAll(renameFrom, renameTo);
-        }
-    }
-    return code.replaceAll('//~', '');
-}
-/**
- * Correct code diff comments that detype() unexpectedly reformatted (using Prettier and Babel internally)
- * after removing TypeScript.
- * See https://github.com/brillout/docpress/pull/47#issuecomment-3263953899
- * @param code Transformed Javascript code.
- * @returns The corrected code.
- */
-function correctCodeDiffComments(code) {
-    // Expected to match the code diff comments: `// [!code ++]` and `// [!code --]` started with newline and optional spaces
-    const codeDiffRE = /\n\s*\/\/\s\[!code.+\]/g;
-    return code.replaceAll(codeDiffRE, (codeDiff) => codeDiff.trimStart());
-}

package/dist/utils/getMagicString.d.ts

@@ -1,9 +0,0 @@
-export { getMagicString };
-import MagicString from 'magic-string';
-declare function getMagicString(code: string, id: string): {
-    magicString: MagicString;
-    getMagicStringResult: () => {
-        code: string;
-        map: import("magic-string").SourceMap;
-    };
-};

package/dist/utils/getMagicString.js

@@ -1,13 +0,0 @@
-export { getMagicString };
-import MagicString from 'magic-string';
-// Used everywhere instead of `new MagicString()` for consistent source map generation
-function getMagicString(code, id) {
-    const magicString = new MagicString(code);
-    const getMagicStringResult = () => {
-        return {
-            code: magicString.toString(),
-            map: magicString.generateMap({ hires: true, source: id }),
-        };
-    };
-    return { magicString, getMagicStringResult };
-}

package/utils/getMagicString.ts

@@ -1,17 +0,0 @@
-export { getMagicString }
-
-import MagicString from 'magic-string'
-
-// Used everywhere instead of `new MagicString()` for consistent source map generation
-function getMagicString(code: string, id: string) {
-  const magicString = new MagicString(code)
-
-  const getMagicStringResult = () => {
-    return {
-      code: magicString.toString(),
-      map: magicString.generateMap({ hires: true, source: id }),
-    }
-  }
-
-  return { magicString, getMagicStringResult }
-}