chore: init

Author: rainerhahnekamp

.eslintrc.json

@@ -1,10 +1,19 @@
 {
   "root": true,
-  "ignorePatterns": ["**/*"],
-  "plugins": ["@nx"],
+  "ignorePatterns": [
+    "**/*"
+  ],
+  "plugins": [
+    "@nx"
+  ],
   "overrides": [
     {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "files": [
+        "*.ts",
+        "*.tsx",
+        "*.js",
+        "*.jsx"
+      ],
       "rules": {
         "@nx/enforce-module-boundaries": [
           "error",
@@ -14,29 +23,54 @@
             "depConstraints": [
               {
                 "sourceTag": "*",
-                "onlyDependOnLibsWithTags": ["*"]
+                "onlyDependOnLibsWithTags": [
+                  "*"
+                ]
               }
             ]
           }
         ]
       }
     },
     {
-      "files": ["*.ts", "*.tsx"],
-      "extends": ["plugin:@nx/typescript"],
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "extends": [
+        "plugin:@nx/typescript"
+      ],
       "rules": {}
     },
     {
-      "files": ["*.js", "*.jsx"],
-      "extends": ["plugin:@nx/javascript"],
+      "files": [
+        "*.js",
+        "*.jsx"
+      ],
+      "extends": [
+        "plugin:@nx/javascript"
+      ],
       "rules": {}
     },
     {
-      "files": ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
+      "files": [
+        "*.spec.ts",
+        "*.spec.tsx",
+        "*.spec.js",
+        "*.spec.jsx"
+      ],
       "env": {
         "jest": true
       },
       "rules": {}
+    },
+    {
+      "files": [
+        "*.ts"
+      ],
+      "extends": [
+        "plugin:@softarc/sheriff/default"
+      ]
     }
   ]
 }

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

apps/ngrx-toolkit-e2e/.eslintrc.json renamed to apps/demo-e2e/.eslintrc.json

@@ -25,7 +25,7 @@ export default defineConfig({
   },
   /* Run your local dev server before starting the tests */
   webServer: {
-    command: 'npx nx serve ngrx-toolkit',
+    command: 'npx nx serve demo',
     url: 'http://localhost:4200',
     reuseExistingServer: !process.env.CI,
     cwd: workspaceRoot,

apps/ngrx-toolkit-e2e/playwright.config.ts renamed to apps/demo-e2e/playwright.config.ts

@@ -1,20 +1,20 @@
 {
-  "name": "ngrx-toolkit-e2e",
+  "name": "demo-e2e",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "projectType": "application",
-  "sourceRoot": "apps/ngrx-toolkit-e2e/src",
+  "sourceRoot": "apps/demo-e2e/src",
   "targets": {
     "e2e": {
       "executor": "@nx/playwright:playwright",
-      "outputs": ["{workspaceRoot}/dist/.playwright/apps/ngrx-toolkit-e2e"],
+      "outputs": ["{workspaceRoot}/dist/.playwright/apps/demo-e2e"],
       "options": {
-        "config": "apps/ngrx-toolkit-e2e/playwright.config.ts"
+        "config": "apps/demo-e2e/playwright.config.ts"
       }
     },
     "lint": {
       "executor": "@nx/eslint:lint",
       "outputs": ["{options.outputFile}"]
     }
   },
-  "implicitDependencies": ["ngrx-toolkit"]
+  "implicitDependencies": ["demo"]
 }

apps/ngrx-toolkit-e2e/project.json renamed to apps/demo-e2e/project.json

@@ -0,0 +1,22 @@
+/* eslint-disable */
+export default {
+  displayName: 'demo',
+  preset: '../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../coverage/apps/demo',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};

apps/ngrx-toolkit-e2e/src/example.spec.ts renamed to apps/demo-e2e/src/example.spec.ts

@@ -1,30 +1,27 @@
 {
-  "name": "ngrx-toolkit",
+  "name": "demo",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "projectType": "application",
   "prefix": "ngrx-toolkit",
-  "sourceRoot": "apps/ngrx-toolkit/src",
+  "sourceRoot": "apps/demo/src",
   "tags": [],
   "targets": {
     "build": {
       "executor": "@angular-devkit/build-angular:application",
       "outputs": ["{options.outputPath}"],
       "options": {
-        "outputPath": "dist/apps/ngrx-toolkit",
-        "index": "apps/ngrx-toolkit/src/index.html",
-        "browser": "apps/ngrx-toolkit/src/main.ts",
+        "outputPath": "dist/apps/demo",
+        "index": "apps/demo/src/index.html",
+        "browser": "apps/demo/src/main.ts",
         "polyfills": ["zone.js"],
-        "tsConfig": "apps/ngrx-toolkit/tsconfig.app.json",
-        "assets": [
-          "apps/ngrx-toolkit/src/favicon.ico",
-          "apps/ngrx-toolkit/src/assets"
-        ],
-        "styles": ["apps/ngrx-toolkit/src/styles.css"],
+        "tsConfig": "apps/demo/tsconfig.app.json",
+        "assets": ["apps/demo/src/favicon.ico", "apps/demo/src/assets"],
+        "styles": ["apps/demo/src/styles.css"],
         "scripts": [],
-        "server": "apps/ngrx-toolkit/src/main.server.ts",
+        "server": "apps/demo/src/main.server.ts",
         "prerender": true,
         "ssr": {
-          "entry": "apps/ngrx-toolkit/server.ts"
+          "entry": "apps/demo/server.ts"
         }
       },
       "configurations": {
@@ -55,18 +52,18 @@
       "executor": "@angular-devkit/build-angular:dev-server",
       "configurations": {
         "production": {
-          "buildTarget": "ngrx-toolkit:build:production"
+          "buildTarget": "demo:build:production"
         },
         "development": {
-          "buildTarget": "ngrx-toolkit:build:development"
+          "buildTarget": "demo:build:development"
         }
       },
       "defaultConfiguration": "development"
     },
     "extract-i18n": {
       "executor": "@angular-devkit/build-angular:extract-i18n",
       "options": {
-        "buildTarget": "ngrx-toolkit:build"
+        "buildTarget": "demo:build"
       }
     },
     "lint": {
@@ -77,7 +74,7 @@
       "executor": "@nx/jest:jest",
       "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
       "options": {
-        "jestConfig": "apps/ngrx-toolkit/jest.config.ts"
+        "jestConfig": "apps/demo/jest.config.ts"
       }
     }
   }

apps/ngrx-toolkit/.eslintrc.json renamed to apps/demo/.eslintrc.json

@@ -14,14 +14,12 @@ describe('AppComponent', () => {
     const fixture = TestBed.createComponent(AppComponent);
     fixture.detectChanges();
     const compiled = fixture.nativeElement as HTMLElement;
-    expect(compiled.querySelector('h1')?.textContent).toContain(
-      'Welcome ngrx-toolkit'
-    );
+    expect(compiled.querySelector('h1')?.textContent).toContain('Welcome demo');
   });
 
-  it(`should have as title 'ngrx-toolkit'`, () => {
+  it(`should have as title 'demo'`, () => {
     const fixture = TestBed.createComponent(AppComponent);
     const app = fixture.componentInstance;
-    expect(app.title).toEqual('ngrx-toolkit');
+    expect(app.title).toEqual('demo');
   });
 });

apps/demo/jest.config.ts

@@ -10,5 +10,5 @@ import { NxWelcomeComponent } from './nx-welcome.component';
   styleUrl: './app.component.css',
 })
 export class AppComponent {
-  title = 'ngrx-toolkit';
+  title = 'demo';
 }

apps/ngrx-toolkit/project.json renamed to apps/demo/project.json

@@ -432,7 +432,7 @@ import { CommonModule } from '@angular/common';
         <div id="welcome">
           <h1>
             <span> Hello there, </span>
-            Welcome ngrx-toolkit 👋
+            Welcome demo 👋
           </h1>
         </div>
         <!--  HERO  -->

apps/ngrx-toolkit/server.ts renamed to apps/demo/server.ts

@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <title>ngrx-toolkit</title>
+    <title>demo</title>
     <base href="/" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="icon" type="image/x-icon" href="favicon.ico" />

apps/ngrx-toolkit/src/app/app.component.css renamed to apps/demo/src/app/app.component.css

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']};

apps/ngrx-toolkit/src/app/app.component.html renamed to apps/demo/src/app/app.component.html

@@ -0,0 +1,43 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": [
+        "plugin:@nx/angular",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "ngrxToolkit",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "ngrx-toolkit",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "extends": ["plugin:@nx/angular-template"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

apps/ngrx-toolkit/src/app/app.component.spec.ts renamed to apps/demo/src/app/app.component.spec.ts

@@ -0,0 +1,7 @@
+# ngrx-toolkit
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test ngrx-toolkit` to execute the unit tests.

apps/ngrx-toolkit/src/app/app.component.ts renamed to apps/demo/src/app/app.component.ts

@@ -3,7 +3,7 @@ export default {
   displayName: 'ngrx-toolkit',
   preset: '../../jest.preset.js',
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
-  coverageDirectory: '../../coverage/apps/ngrx-toolkit',
+  coverageDirectory: '../../coverage/libs/ngrx-toolkit',
   transform: {
     '^.+\\.(ts|mjs|js|html)$': [
       'jest-preset-angular',

apps/ngrx-toolkit/src/app/app.config.server.ts renamed to apps/demo/src/app/app.config.server.ts

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/libs/ngrx-toolkit",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

apps/ngrx-toolkit/src/app/app.config.ts renamed to apps/demo/src/app/app.config.ts

@@ -0,0 +1,12 @@
+{
+  "name": "ngrx-toolkit",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@angular/common": "^17.0.0",
+    "@angular/core": "^17.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false
+}

apps/ngrx-toolkit/src/app/app.routes.ts renamed to apps/demo/src/app/app.routes.ts

@@ -0,0 +1,37 @@
+{
+  "name": "ngrx-toolkit",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/ngrx-toolkit/src",
+  "prefix": "ngrx-toolkit",
+  "tags": [],
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/angular:package",
+      "outputs": ["{workspaceRoot}/dist/{projectRoot}"],
+      "options": {
+        "project": "libs/ngrx-toolkit/ng-package.json"
+      },
+      "configurations": {
+        "production": {
+          "tsConfig": "libs/ngrx-toolkit/tsconfig.lib.prod.json"
+        },
+        "development": {
+          "tsConfig": "libs/ngrx-toolkit/tsconfig.lib.json"
+        }
+      },
+      "defaultConfiguration": "production"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/ngrx-toolkit/jest.config.ts"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"]
+    }
+  }
+}

apps/ngrx-toolkit/src/app/nx-welcome.component.ts renamed to apps/demo/src/app/nx-welcome.component.ts

@@ -0,0 +1 @@
+export * from './lib/ngrx-toolkit/ngrx-toolkit.component';

apps/ngrx-toolkit/src/assets/.gitkeep renamed to apps/demo/src/assets/.gitkeep

@@ -0,0 +1 @@
+<p>ngrx-toolkit works!</p>