build(web-components): fix web-components build

IPS-LMU · Nov 8, 2024 · d5f1e0f · d5f1e0f
1 parent 4bc818c
commit d5f1e0f
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 51 deletions.
diff --git a/apps/web-components/src/LICENSE.txt → apps/web-components/LICENSE.txt b/apps/web-components/src/LICENSE.txt → apps/web-components/LICENSE.txt
diff --git a/apps/web-components/README.md b/apps/web-components/README.md
@@ -1 +1,35 @@
-[GO TO README HERE](./src/README.md)
+# @octra/web-components
+
+This library offers the same components from @octra/ngx-components without the limitation of using it in Angular projects.
+
+## Installation
+
+### Vanilla JS (plain Javascript)
+Currently, the libraries are not published on npm because Octra 2.0 and the libraries are still in development. If you
+want to use the libraries in your project you have to manually install.
+
+1. Clone the OCTRA repository next to the project folder you want to use the libraries for.
+2. Switch tu branch "static".
+
+```shell
+git checkout static
+```
+
+3. Add to HTML file ([see full example here](../../../apps/web-components-demo/index.html)).
+
+````html
+    <head>
+        <!-- ... -->
+        <script type="application/javascript" src="../octra/libs/web-components/web-components.js"></script>
+        <!-- ... -->
+    </head>
+````
+
+## Update
+
+1. Go to the cloned octra repository. Make sure you are in branch `static`.
+2. Update directory:
+
+```shell
+git pull
+```
diff --git a/apps/web-components/project.json b/apps/web-components/project.json
@@ -16,10 +16,7 @@
         "main": "apps/web-components/src/main.ts",
         "polyfills": ["zone.js"],
         "tsConfig": "apps/web-components/tsconfig.app.json",
-        "assets": [
-          "apps/web-components/src/LICENSE.txt",
-          "apps/web-components/src/README.md"
-        ],
+        "assets": [],
         "styles": ["apps/web-components/styles.css"],
         "scripts": []
       },

diff --git a/apps/web-components/src/README.md b/apps/web-components/src/README.md
diff --git a/apps/web-components/tsconfig.editor.json b/apps/web-components/tsconfig.editor.json
@@ -2,6 +2,6 @@
   "extends": "./tsconfig.json",
   "include": ["src/**/*.ts"],
   "compilerOptions": {
-    "types": []
+    "types": ["jest", "node"]
   }
 }
diff --git a/apps/web-components/tsconfig.json b/apps/web-components/tsconfig.json
@@ -2,13 +2,13 @@
   "compilerOptions": {
     "target": "es2022",
     "useDefineForClassFields": false,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "esModuleInterop": true
+    "forceConsistentCasingInFileNames": false,
+    "strict": false,
+    "noImplicitOverride": false,
+    "noPropertyAccessFromIndexSignature": false,
+    "noImplicitReturns": false,
+    "noFallthroughCasesInSwitch": false,
+    "allowSyntheticDefaultImports": true
   },
   "files": [],
   "include": [],
@@ -28,6 +28,7 @@
     "enableI18nLegacyMessageIdFormat": false,
     "strictInjectionParameters": true,
     "strictInputAccessModifiers": true,
-    "strictTemplates": true
+    "strictTemplates": true,
+    "commonChunk": false
   }
 }
diff --git a/apps/web-components/typedoc.cjs b/apps/web-components/typedoc.cjs
@@ -3,5 +3,5 @@ module.exports = {
   extends: ['../../typedoc.base.config.cjs'],
   entryPoints: ['src/main.ts'],
   out: './docs',
-  readme: 'src/README.md',
+  readme: 'README.md',
 };
diff --git a/prepare_web-components.js b/prepare_web-components.js
@@ -19,7 +19,11 @@ const build = async () => {
     'dist/libs/web-components/3rdpartylicenses.txt'
   );
   await fs.copyFile(
-    'tmp/web-components/LICENSE.txt',
+    'apps/web-components/README.md',
+    'dist/libs/web-components/README.md'
+  );
+  await fs.copyFile(
+    'apps/web-components/LICENSE.txt',
     'dist/libs/web-components/LICENSE.txt'
   );