feat: Schematic for extracting libraries from projects

jeka-gom · jeka-gom · commit b1e54f1fd614 · 2024-01-03T17:08:56.000+01:00
JIRA-Ticket: AV-27910
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "avrios-schematics",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "A blank schematics",
   "scripts": {
     "build": "tsc -p tsconfig.json"
diff --git a/src/collection.json b/src/collection.json
@@ -30,6 +30,11 @@
       "description": "Create an Avrios library",
       "factory": "./library",
       "schema": "./library/schema.json"
+    },
+    "extract-app-libs": {
+      "description": "Extract app libs from an Avrios project",
+      "factory": "./extract-app-libs",
+      "schema": "./extract-app-libs/schema.json"
     }
   }
 }
diff --git a/src/extract-app-libs/files/.eslintrc.json.template b/src/extract-app-libs/files/.eslintrc.json.template
@@ -0,0 +1,41 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "**/*.stories.ts"],
+  "overrides": [
+  {
+    "files": ["*.ts"],
+    "extends": ["plugin:@nrwl/nx/angular", "plugin:@angular-eslint/template/process-inline-templates"],
+    "rules": {
+      "@angular-eslint/directive-selector": [
+        "error",
+        {
+          "type": "attribute",
+          "prefix": "avr",
+          "style": "camelCase"
+        }
+      ],
+      "@angular-eslint/component-selector": [
+        "error",
+        {
+          "type": "element",
+          "prefix": "avr",
+          "style": "kebab-case"
+        }
+      ],
+      "@angular-eslint/no-output-on-prefix": "off",
+      "@typescript-eslint/no-namespace": "off"
+    },
+    "plugins": ["@typescript-eslint"],
+    "parserOptions": {
+      "project": "libs/<%= dasherize(name) %>/tsconfig-linter.json"
+    }
+  }, {
+    "files": ["*.html"],
+    "extends": ["plugin:@nrwl/nx/angular-template"],
+    "rules": {
+      "@angular-eslint/template/no-negated-async": "off",
+      "@angular-eslint/template/eqeqeq": "warn"
+    }
+    }
+  ]
+}
diff --git a/src/extract-app-libs/files/jest.config.ts.template b/src/extract-app-libs/files/jest.config.ts.template
@@ -0,0 +1,31 @@
+const esModules = ['design-system-toolkit', '.*\\.mjs$'].join('|');
+
+module.exports = {
+    displayName: '<%= dasherize(name) %>',
+    preset: '../../jest.config.ts',
+    coverageDirectory: '../../coverage/libs/<%= dasherize(name) %>',
+    setupFilesAfterEnv: ['<rootDir>../../setupJest.ts'],
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json',
+            stringifyContentPathRegex: '\\.(html|svg)$',
+        },
+    },
+    transform: {
+        '^.+\\.(ts|mjs|js|html)$': 'jest-preset-angular',
+        [`(${esModules}).+\\.js$`]: 'babel-jest',
+    },
+    transformIgnorePatterns: [`node_modules/(?!${esModules})`],
+
+
+    moduleNameMapper: {
+        '^@shared(.*)$': '<rootDir>../shared/src/lib$1',
+        '^@<%= dasherize(name) %>(.*)$': '<rootDir>/src/lib$1'
+    },
+    snapshotSerializers: [
+        'jest-preset-angular/build/serializers/no-ng-attributes',
+        'jest-preset-angular/build/serializers/ng-snapshot',
+        'jest-preset-angular/build/serializers/html-comment',
+    ],
+    testRunner: 'jest-jasmine2'
+};
diff --git a/src/extract-app-libs/files/tsconfig-linter.json.template b/src/extract-app-libs/files/tsconfig-linter.json.template
@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "./**/*.ts",
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "../../dist/**/*",
+    "../../release/**/*",
+    "../../node_modules/**/*",
+    "../../tmp/**/*",
+    "**/*.stories.ts",
+    "**/*.stories.js"
+  ]
+}
diff --git a/src/extract-app-libs/files/tsconfig.json.template b/src/extract-app-libs/files/tsconfig.json.template
@@ -0,0 +1,19 @@
+{
+  "extends": "../../tsconfig.json",
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "paths": {
+      "@shared/*": ["libs/shared/src/lib/*"],
+      "@<%= dasherize(namespace) %>/*": ["libs/<%= dasherize(name) %>/src/lib/*"]
+    },
+    "target": "es2020"
+  }
+}
diff --git a/src/extract-app-libs/files/tsconfig.lib.json.template b/src/extract-app-libs/files/tsconfig.lib.json.template
@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": [
+      "angular-loading-bar",
+      "angular-promise-tracker",
+      "angular-translate",
+      "ng-file-upload",
+      "node"
+    ]
+  },
+  "exclude": [
+    "**/*.spec.ts"
+  ],
+  "include": [
+    "**/*.ts"
+  ]
+}
diff --git a/src/extract-app-libs/files/tsconfig.spec.json.template b/src/extract-app-libs/files/tsconfig.spec.json.template
@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": [
+      "angular-ui-bootstrap",
+      "jest",
+      "node"
+    ]
+  },
+  "include": [
+    "../../libs/**/*.d.ts",
+    "**/*.spec.ts",
+    "**/*.test.ts"
+  ]
+}
diff --git a/src/extract-app-libs/index.js b/src/extract-app-libs/index.js
diff --git a/src/extract-app-libs/index.ts b/src/extract-app-libs/index.ts
@@ -0,0 +1,149 @@
+import { strings } from '@angular-devkit/core';
+import {
+    Rule,
+    SchematicsException,
+    Tree,
+    apply,
+    applyTemplates,
+    chain,
+    mergeWith,
+    move,
+    url
+} from '@angular-devkit/schematics';
+
+import { validateName } from '../utilities/validation';
+import { parseName } from '../utilities/parse-name';
+
+interface LibraryOptions {
+    name: string;
+    prefix: string;
+    tags?: string;
+    namespace?: string;
+    path?: string;
+}
+
+export default function (options: LibraryOptions): Rule {
+    return (host: Tree) => {
+        const projectJsonFile = '/project.json';
+        const { prefix, name, tags: tagsString } = options;
+        const dasherizedName = strings.dasherize(name);
+        
+        const projectLibsRoot = `libs/${dasherizedName}`;
+
+        const parsedPath = parseName(projectLibsRoot, name);
+        validateName(parsedPath.name);
+
+        const appScope = `scope:${dasherizedName}`;
+        const namespace = options.namespace ? options.namespace : parsedPath.name;
+        const paths: Record<string, string[]>= {};
+        
+        const libraryNames = host.getDir(`${projectLibsRoot}/src/lib`).subdirs;
+        libraryNames.forEach(libraryName => {
+            validateName(libraryName);
+            const sourceRoot = `${projectLibsRoot}/src/lib/${libraryName}`;
+            paths[`@${namespace}/${libraryName}/*`] = [`${projectLibsRoot}/src/lib/${libraryName}/*`];
+
+            const projectConfig = {
+                name: `${dasherizedName}-${libraryName}`,
+                sourceRoot,
+                prefix,
+                tags: [appScope],
+                projectType: 'library',
+                generators: {},
+                targets: {
+                    lint: {
+                        executor: '@nrwl/linter:eslint',
+                        options: {
+                            lintFilePatterns: [
+                                `${sourceRoot}/**/*.ts`,
+                                `${sourceRoot}/**/*.html`
+                            ],
+                            eslintConfig: `${projectLibsRoot}/.eslintrc.json`
+                        }
+                    },
+                    test: {
+                        executor: '@nrwl/jest:jest',
+                        options: {
+                            jestConfig: `${projectLibsRoot}/jest.config.ts`,
+                            passWithNoTests: true,
+                            testPathPattern: [`lib/${libraryName}/`]
+                        }
+                    }
+                }
+            };
+
+            host.exists(`${sourceRoot}/${projectJsonFile}`) || host.create(`${sourceRoot}/${projectJsonFile}`, JSON.stringify(projectConfig));
+        });
+
+        const appTsConfigPath = `apps/${dasherizedName}/tsconfig.json`;
+        const appEslintrcPath = `apps/${dasherizedName}/.eslintrc.json`;
+        const eslintrcPath = `/.eslintrc.json`;
+
+        const appTsConfig = host.read(appTsConfigPath);
+        const appEslintrc = host.read(appEslintrcPath);
+        const eslintrc = host.read(eslintrcPath);
+
+        if (!appTsConfig) {
+            throw new SchematicsException(`Could not find ${dasherizedName}/tsConfig.json file.`);
+        }
+
+        if (!appEslintrc) {
+            throw new SchematicsException(`Could not find ${dasherizedName}/.eslintrc.json file.`);
+        }
+
+        if (!eslintrc) {
+            throw new SchematicsException(`Could not find /.eslintrc.json file.`);
+        }
+
+        // Add new libs paths to tsconfig.json
+        const appTsConfigJson = JSON.parse(appTsConfig.toString());
+        appTsConfigJson.compilerOptions.paths = {
+            ...paths,
+            ...appTsConfigJson.compilerOptions.paths
+        };
+
+        // Remove deactivated eslint rule @nrwl/nx/enforce-module-boundaries rule from app's .eslintrc.json
+        const appEslintrcJson = JSON.parse(appEslintrc.toString());
+        appEslintrcJson.overrides.forEach((elem: any) => {
+            if (elem.rules && elem.rules['@nrwl/nx/enforce-module-boundaries'] === 'off') {
+                delete elem.rules['@nrwl/nx/enforce-module-boundaries'];
+            }
+        });
+
+        const eslintrcJson = JSON.parse(eslintrc.toString());
+        const tags = tagsString ? tagsString.split(',').map(s => s.trim()) : [];
+        eslintrcJson.overrides.forEach((elem: any) => {
+            if (elem.rules && elem.rules['@nrwl/nx/enforce-module-boundaries']) {
+                const found = elem.rules['@nrwl/nx/enforce-module-boundaries'][1].depConstraints.filter((constraint: any) => constraint.sourceTag === appScope);
+                if (!found || !found.length) {
+                    elem.rules['@nrwl/nx/enforce-module-boundaries'][1].depConstraints.push(
+                        {
+                            sourceTag: appScope,
+                            onlyDependOnLibsWithTags: [...tags, appScope]
+                        }
+                    );
+                }
+            }
+        });
+
+        host.overwrite(appTsConfigPath, JSON.stringify(appTsConfigJson));
+        host.overwrite(appEslintrcPath, JSON.stringify(appEslintrcJson));
+        host.overwrite(eslintrcPath, JSON.stringify(eslintrcJson));
+
+        options.name = parsedPath.name;
+        options.path = parsedPath.path;
+        options.namespace = namespace;
+
+        const templateSource = apply(
+            url('./files'), [
+                applyTemplates({ ...strings, ...options }),
+                move(projectLibsRoot),
+
+        ]);
+
+        return chain([
+            _ => host,
+            mergeWith(templateSource)
+        ]);
+    };
+}
diff --git a/src/extract-app-libs/schema.json b/src/extract-app-libs/schema.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "avrios-schematics",`
`3`		`- "version": "2.5.0",`
	`3`	`+ "version": "2.6.0",`
`4`	`4`	`"description": "A blank schematics",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"build": "tsc -p tsconfig.json"`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@`
`30`	`30`	`"description": "Create an Avrios library",`
`31`	`31`	`"factory": "./library",`
`32`	`32`	`"schema": "./library/schema.json"`
	`33`	`+ },`
	`34`	`+ "extract-app-libs": {`
	`35`	`+ "description": "Extract app libs from an Avrios project",`
	`36`	`+ "factory": "./extract-app-libs",`
	`37`	`+ "schema": "./extract-app-libs/schema.json"`
`33`	`38`	`}`
`34`	`39`	`}`
`35`	`40`	`}`