fix(docs): warning normalized

siemens · Aug 25, 2022 · 036a100 · 036a100
1 parent 29200e3
commit 036a100
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 12 deletions.
diff --git a/packages/documentation/.eslintrc.json 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
@@ -8,6 +8,13 @@ import path, { join } from 'path';
 
 const __dirname = path.resolve();
 
+function autoGenerationWarning(previewPath) {
+  // unix/win normalization
+  previewPath = previewPath.replace(/\\/g, '/')
+
+  return `<!-- Auto generated! Please edit here: ${previewPath.substring(previewPath.indexOf('siemens-ix/packages/'))} -->`;
+}
+
 function formatMultiline(str) {
   return str.split('\n\n').join('<br /><br />').split('\n').join(' ');
 }
@@ -95,9 +102,7 @@ function writeWebComponentPreviews() {
         .trimEnd();
     }
 
-    const markdown = `<!-- Auto generated! Please edit here: ${previewPath.substring(
-      previewPath.indexOf('siemens-ix/packages/')
-    )} -->
+    const markdown = `${autoGenerationWarning(previewPath)}
 \`\`\`html
 ${code}
 \`\`\`
@@ -154,9 +159,7 @@ function writeReactPreviews() {
 
     const code = fs.readFileSync(previewPath).toString();
 
-    const markdown = `<!-- Auto generated! Please edit here: ${previewPath.substring(
-      previewPath.indexOf('siemens-ix/packages/')
-    )} -->
+    const markdown = `${autoGenerationWarning(previewPath)}
 \`\`\`tsx
 ${code.trimEnd()}
 \`\`\`
@@ -215,9 +218,7 @@ function writeAngularPreviews() {
 
     const code = fs.readFileSync(previewPath).toString();
 
-    const markdown = `<!-- Auto generated! Please edit here: ${previewPath.substring(
-      previewPath.indexOf('siemens-ix/packages/')
-    )} -->
+    const markdown = `${autoGenerationWarning(previewPath)}
 \`\`\`typescript
 ${code.trimEnd()}
 \`\`\`

diff --git 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