From 036a10097bac04c5cbc746be8685863730eabecd Mon Sep 17 00:00:00 2001 From: Carlos Leandro Cruz Ferrer Date: Thu, 25 Aug 2022 15:16:18 +0100 Subject: [PATCH] fix(docs): warning normalized --- packages/documentation/.eslintrc.json | 5 +++++ .../documentation/scripts/generate-api.mjs | 19 ++++++++++--------- packages/documentation/tsconfig.json | 10 +++++++--- 3 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 packages/documentation/.eslintrc.json diff --git a/packages/documentation/.eslintrc.json b/packages/documentation/.eslintrc.json new file mode 100644 index 00000000000..ac97fbcb3e8 --- /dev/null +++ b/packages/documentation/.eslintrc.json @@ -0,0 +1,5 @@ +{ + "parserOptions": { + "sourceType": "module" + } +} diff --git a/packages/documentation/scripts/generate-api.mjs b/packages/documentation/scripts/generate-api.mjs index 6cb0ee0dff9..e909be0ea27 100644 --- a/packages/documentation/scripts/generate-api.mjs +++ b/packages/documentation/scripts/generate-api.mjs @@ -8,6 +8,13 @@ import path, { join } from 'path'; const __dirname = path.resolve(); +function autoGenerationWarning(previewPath) { + // unix/win normalization + previewPath = previewPath.replace(/\\/g, '/') + + return ``; +} + function formatMultiline(str) { return str.split('\n\n').join('

').split('\n').join(' '); } @@ -95,9 +102,7 @@ function writeWebComponentPreviews() { .trimEnd(); } - const markdown = ` + const markdown = `${autoGenerationWarning(previewPath)} \`\`\`html ${code} \`\`\` @@ -154,9 +159,7 @@ function writeReactPreviews() { const code = fs.readFileSync(previewPath).toString(); - const markdown = ` + const markdown = `${autoGenerationWarning(previewPath)} \`\`\`tsx ${code.trimEnd()} \`\`\` @@ -215,9 +218,7 @@ function writeAngularPreviews() { const code = fs.readFileSync(previewPath).toString(); - const markdown = ` + const markdown = `${autoGenerationWarning(previewPath)} \`\`\`typescript ${code.trimEnd()} \`\`\` diff --git a/packages/documentation/tsconfig.json b/packages/documentation/tsconfig.json index 37938243a1f..afc8ad58af7 100644 --- a/packages/documentation/tsconfig.json +++ b/packages/documentation/tsconfig.json @@ -1,10 +1,12 @@ { - "extends": "../../tsconfig.base.json", + "extends": "@tsconfig/docusaurus/tsconfig.json", "compilerOptions": { "allowJs": true, "esModuleInterop": true, "jsx": "react", - "lib": ["DOM"], + "lib": [ + "DOM" + ], "noEmit": true, "noImplicitAny": false, "types": [ @@ -14,7 +16,9 @@ ], "baseUrl": ".", "paths": { - "@site/*": ["./*"] + "@site/*": [ + "./*" + ] }, "resolveJsonModule": true, "preserveSymlinks": true