fix: the tsconfig spec generated for library contains several issues (#…

…2584)

## Proposed change

Only use composite for library generated for workspace set up with jest.
Ensure path do not target any invalid files.

## Related issues

* 🐛 Fix #2481
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- *  Pull Request #issue -->

packages/@o3r/components/schematics/index.it.spec.ts

@@ -5,6 +5,7 @@
  */
 const o3rEnvironment = globalThis.o3rEnvironment;
 
+import * as fs from 'node:fs';
 import * as path from 'node:path';
 import {
   getDefaultExecSyncOptions,
@@ -50,7 +51,17 @@ describe('ng add components', () => {
     expect(diff.modified).toContain('package.json');
     expect(diff.modified).toContain('angular.json');
     expect(diff.modified).toContain('libs/test-lib/package.json');
-    expect(diff.modified.length).toBe(8);
+    const vscodeContent = fs.readFileSync(`${workspacePath}/.vscode/extensions.json`, 'utf8');
+    const angularJSON = JSON.parse(fs.readFileSync(`${workspacePath}/angular.json`, 'utf8'));
+    expect(vscodeContent).toContain('"Orta.vscode-jest"');
+    expect(angularJSON.schematics['@o3r/core:component']).toBeDefined();
+    expect(angularJSON.schematics['@o3r/core:component-container']).toBeDefined();
+    expect(angularJSON.schematics['@o3r/core:component-presenter']).toBeDefined();
+    expect(angularJSON.cli?.schematicCollections?.indexOf('@o3r/components') > -1).toBe(true);
+
+    const packageJson = JSON.parse(fs.readFileSync(`${workspacePath}/package.json`, 'utf8'));
+    expect(packageJson.dependencies['@o3r/components']).toBeDefined();
+
     expect(diff.added).toContain('libs/test-lib/cms.json');
     expect(diff.added).toContain('libs/test-lib/placeholders.metadata.json');
     expect(diff.added).toContain('libs/test-lib/tsconfig.cms.json');

packages/@o3r/configuration/schematics/index.it.spec.ts

@@ -5,6 +5,7 @@
  */
 const o3rEnvironment = globalThis.o3rEnvironment;
 
+import * as fs from 'node:fs';
 import * as path from 'node:path';
 import {
   addImportToAppModule,
@@ -49,7 +50,7 @@ describe('new otter application with configuration', () => {
     expect(() => packageManagerRunOnProject(appName, isInWorkspace, { script: 'build' }, execAppOptions)).not.toThrow();
   });
   test('should add configuration to a library', () => {
-    const { applicationPath, workspacePath, libName, libraryPath, isInWorkspace, untouchedProjectsPaths, o3rVersion } = o3rEnvironment.testEnvironment;
+    const { workspacePath, untouchedProjectsPaths, isInWorkspace, applicationPath, libName, libraryPath, o3rVersion } = o3rEnvironment.testEnvironment;
     const execAppOptions = { ...getDefaultExecSyncOptions(), cwd: workspacePath };
     const relativeLibraryPath = path.relative(workspacePath, libraryPath);
     packageManagerExec({ script: 'ng', args: ['add', `@o3r/configuration@${o3rVersion}`, '--skip-confirmation', '--project-name', libName] }, execAppOptions);
@@ -66,8 +67,16 @@ describe('new otter application with configuration', () => {
 
     const diff = getGitDiff(workspacePath);
     expect(diff.added.length).toEqual(20);
-    expect(diff.modified.length).toEqual(7);
-    expect(diff.modified).toContain('package.json');
+    const vscodeContent = fs.readFileSync(`${workspacePath}/.vscode/extensions.json`, 'utf8');
+    const angularJSON = JSON.parse(fs.readFileSync(`${workspacePath}/angular.json`, 'utf8'));
+    expect(vscodeContent).toContain('"Orta.vscode-jest"');
+    expect(angularJSON.schematics['@o3r/core:component']).toBeDefined();
+    expect(angularJSON.schematics['@o3r/core:component-container']).toBeDefined();
+    expect(angularJSON.schematics['@o3r/core:component-presenter']).toBeDefined();
+    expect(angularJSON.cli?.schematicCollections?.indexOf('@o3r/configuration') > -1).toBe(true);
+
+    const packageJson = JSON.parse(fs.readFileSync(`${workspacePath}/package.json`, 'utf8'));
+    expect(packageJson.dependencies['@o3r/configuration']).toBeDefined();
     expect(diff.added).toContain(path.posix.join(relativeLibraryPath, 'src/components/test-component/test-component.config.ts').replace(/[/\\]+/g, '/'));
     expect(diff.added).toContain(path.posix.join(relativeLibraryPath, 'src/components/test-signal/test-signal.config.ts').replace(/[/\\]+/g, '/'));
 

packages/@o3r/eslint-config/schematics/index.it.spec.ts

@@ -63,7 +63,7 @@ describe('new otter application with eslint config', () => {
     untouchedProjectsPaths.forEach((untouchedProject) => {
       expect(diff.all.some((file) => file.startsWith(path.posix.relative(workspacePath, untouchedProject)))).toBe(false);
     });
-    // TODO: reactivate this check once #2481 is fixed
+    // TODO This command can be re-activated once #2730 is fixed
     // expect(() => packageManagerExec({ script: 'ng', args: ['lint', libName, '--fix'] }, execAppOptions)).not.toThrow();
   });
 

packages/@o3r/testing/package.json

@@ -249,6 +249,9 @@
     "typescript-eslint": "~8.21.0",
     "zone.js": "~0.14.2"
   },
+  "generatorDependencies": {
+    "@angular-builders/jest": "~18.0.0"
+  },
   "schematics": "./collection.json",
   "ng-update": {
     "migrations": "./migration.json"

packages/@o3r/testing/schematics/ng-add/index.ts

@@ -55,6 +55,8 @@ const devDependenciesToInstall = [
   'jest-environment-jsdom',
   'jest-preset-angular',
   'ts-jest',
+  '@angular-builders/jest',
+  '@angular-devkit/build-angular',
   '@types/jest'
 ];
 
@@ -162,7 +164,8 @@ function ngAddFn(options: NgAddSchematicsSchema): Rule {
 
           const jestConfigFilesForWorkspace = () => mergeWith(apply(url('./templates/workspace'), [
             template({
-              ...options
+              ...options,
+              tsconfigPath: `./${['tsconfig.base.json', 'tsconfig.json'].find((tsconfigBase) => tree.exists(`./${tsconfigBase}`))}`
             }),
             move(tree.root.path),
             renameTemplateFiles()

packages/@o3r/testing/schematics/ng-add/templates/workspace/tsconfig.jest.json.template

@@ -0,0 +1,11 @@
+{
+  "extends": "<%= tsconfigPath %>",
+  "compilerOptions": {
+    "strictPropertyInitialization": false,
+    "strictNullChecks": false,
+    "types": ["node", "jest"],
+    "composite": true,
+    "esModuleInterop": true
+  },
+  "include": []
+}

packages/@o3r/workspace/package.json

@@ -123,6 +123,7 @@
     "zone.js": "~0.14.2"
   },
   "generatorDependencies": {
+    "@angular-builders/jest": "~18.0.0",
     "@angular/material": "~18.2.0",
     "@ngrx/router-store": "~18.1.0",
     "@ngrx/effects": "~18.1.0",

packages/@o3r/workspace/schematics/index.it.spec.ts

@@ -114,6 +114,8 @@ describe('new otter workspace', () => {
     expect(() => packageManagerExec({ script: 'ng', args: ['g', 'library', libName] }, execAppOptions)).not.toThrow();
     expect(existsSync(path.join(workspacePath, 'project'))).toBe(false);
     generatedLibFiles.forEach((file) => expect(existsSync(path.join(inLibraryPath, file))).toBe(true));
+    // TODO apps are generated without jest full configuration - needs to be fixed before removing this part
+    expect(() => packageManagerExec({ script: 'ng', args: ['test', libName] }, execAppOptions)).not.toThrow();
     expect(() => packageManagerRunOnProject(libName, true, { script: 'build' }, execAppOptions)).not.toThrow();
 
     // check tsconfig.lib.prod.json override

packages/@o3r/workspace/schematics/library/index.spec.ts

@@ -17,12 +17,21 @@ jest.mock('@angular-devkit/schematics', () => {
 });
 
 const collectionPath = path.join(__dirname, '..', '..', 'collection.json');
+const angularJsonFile = JSON.stringify({
+  version: 1,
+  projects: {
+    'my-new-module': {
+      projectType: 'library',
+      root: 'packages-test/my-new-module'
+    }
+  }
+}, null, 2);
 
 describe('New module generator', () => {
   let initialTree: Tree;
   beforeEach(() => {
     initialTree = Tree.empty();
-    initialTree.create('angular.json', '{"version": 1, "projects": {} }');
+    initialTree.create('angular.json', angularJsonFile);
     initialTree.create('package.json', '{ "version": "0.0.0-test" }');
   });
 
@@ -51,6 +60,9 @@ describe('New module generator', () => {
     expect(JSON.parse(tree.readContent('/tsconfig.base.json')).compilerOptions.paths['@my/new-module']).not.toContain('packages-test/my-new-module/dist');
     expect(tree.exists('/tsconfig.build.json')).toBe(true);
     expect(JSON.parse(tree.readContent('/tsconfig.build.json')).compilerOptions.paths['@my/new-module']).toContain('packages-test/my-new-module/dist');
+    expect(tree.exists('/packages-test/my-new-module/testing/setup-jest.ts')).toBe(false);
+    expect(JSON.parse(tree.readContent('/packages-test/my-new-module/package.json')).scripts.test).toContain('ng test my-new-module');
+    expect(tree.exists('/packages-test/my-new-module/jest.config.js')).toBe(false);
     expect(tree.files.length).toBeGreaterThanOrEqual(9);
   });
 
@@ -95,8 +107,21 @@ describe('New module generator', () => {
         skipLinter: true
       }, initialTree);
 
+      expect(tree.exists('/packages-test/my-new-module/testing/setup-jest.ts')).toBe(true);
+      expect(tree.exists('/packages-test/my-new-module/jest.config.js')).toBe(true);
+      const packageJsonContent = tree.readJson('/packages-test/my-new-module/package.json') as any;
+      expect(packageJsonContent.scripts.test).toBe('ng test my-new-module');
+      expect(packageJsonContent.devDependencies['@angular-builders/jest']).toBeDefined();
+      (tree.readJson('/packages-test/my-new-module/tsconfig.spec.json') as { references: { path: string }[] })
+        .references
+        .forEach((ref) => {
+          expect(tree.exists(path.join('/packages-test/my-new-module', ref.path))).toBe(true);
+        });
       expect(tree.exists('/packages-test/my-new-module/project.json')).toBe(true);
-      expect(tree.readContent('/packages-test/my-new-module/project.json')).toContain('"name": "test-module-name"');
+      const projectJson: any = tree.readJson('/packages-test/my-new-module/project.json');
+      expect(projectJson.name).toBe('test-module-name');
+      expect(tree.exists(projectJson.targets.test.options.jestConfig)).toBe(true);
+      expect(projectJson.targets.test.executor).toBe('@nx/jest:jest');
     });
   });
 });

packages/@o3r/workspace/schematics/library/rules/rules.ng.ts

@@ -14,6 +14,9 @@ import {
   template,
   url,
 } from '@angular-devkit/schematics';
+import type {
+  Tree,
+} from '@angular-devkit/schematics';
 import {
   findConfigFileRelativePath,
 } from '@o3r/schematics';
@@ -32,6 +35,44 @@ import {
   updatePackageDependenciesFactory,
 } from './shared';
 
+/**
+ * Set jest files and script in the generated library.
+ * @param options
+ */
+function setUpAngularTestPackageJson(options: NgGenerateModuleSchema & { targetPath: string }): Rule {
+  return (tree: Tree) => {
+    const packageJsonPath = path.join(options.targetPath, 'package.json');
+    const packageJsonContent = tree.readJson(packageJsonPath) as PackageJson;
+    packageJsonContent.scripts ||= {};
+    packageJsonContent.scripts.test ||= `ng test ${options.name}`;
+    tree.overwrite(packageJsonPath, JSON.stringify(packageJsonContent, null, 2));
+    return tree;
+  };
+}
+
+/**
+ * Set jest files and script in the generated library.
+ * @param options
+ */
+function setUpJestForAngularJson(options: NgGenerateModuleSchema & { targetPath: string }) {
+  return (tree: Tree) => {
+    const angularFile = tree.readJson('/angular.json') as { projects: any };
+    const project: any = angularFile.projects[options.name];
+    project.architect ||= {};
+    project.architect.test = {
+      builder: '@angular-builders/jest:run',
+      options: {
+        tsConfig: `tsconfig.spec.json`,
+        configPath: `jest.config.js`,
+        setupFilesAfterEnv: './testing/setup-jest.ts'
+      }
+    };
+
+    tree.overwrite('/angular.json', JSON.stringify(angularFile, null, 2));
+    return tree;
+  };
+}
+
 /**
  * generate the rules to adapt the library generated by ng cli
  * @param options Schematic options
@@ -50,21 +91,50 @@ export function ngGenerateModule(options: NgGenerateModuleSchema & { targetPath:
     const o3rCorePackageJson: PackageJson & { generatorDependencies?: Record<string, string> } = JSON.parse(readFileSync(o3rCorePackageJsonPath).toString());
     const otterVersion = o3rCorePackageJson.dependencies!['@o3r/schematics'];
 
-    const templateNg = apply(url('./templates/ng'), [
+    const templateNg = apply(url('./templates/ng/common'), [
       template({
         ...options,
-        tsconfigSpecPath: findConfigFileRelativePath(tree,
-          ['tsconfig.test.json', 'tsconfig.spec.json', 'tsconfig.jest.json', 'tsconfig.jasmine.json', 'tsconfig.base.json', 'tsconfig.json'], options.targetPath),
         tsconfigBasePath: findConfigFileRelativePath(tree, ['tsconfig.base.json', 'tsconfig.json'], options.targetPath),
         tsconfigBuildPath: findConfigFileRelativePath(tree, ['tsconfig.build.json', 'tsconfig.base.json', 'tsconfig.json'], options.targetPath)
       }),
       renameTemplateFiles(),
       move(options.targetPath)
     ]);
-
+    const templateCommonJest = apply(url('./templates/jest'), [
+      template({
+        ...options,
+        tsconfigBasePath: findConfigFileRelativePath(tree, ['tsconfig.base.json', 'tsconfig.json'], options.targetPath)
+      }),
+      renameTemplateFiles(),
+      move(options.targetPath)
+    ]);
+    const templateNgJest = apply(url('./templates/ng/jest'), [
+      template({
+        ...options,
+        tsconfigSpecPath: findConfigFileRelativePath(tree,
+          ['tsconfig.test.json', 'tsconfig.spec.json', 'tsconfig.jest.json', 'tsconfig.jasmine.json', 'tsconfig.base.json', 'tsconfig.json'], options.targetPath),
+        tsconfigBasePath: findConfigFileRelativePath(tree, ['tsconfig.base.json', 'tsconfig.json'], options.targetPath)
+      }),
+      renameTemplateFiles(),
+      move(options.targetPath)
+    ]);
+    const packageJsonContent = tree.readText('/package.json');
+    const hasJestInstalled = options.testingFramework === 'jest' || packageJsonContent.match('"jest"');
     return chain([
       mergeWith(templateNg, MergeStrategy.Overwrite),
-      updatePackageDependenciesFactory(options.targetPath, otterVersion!, o3rCorePackageJson, options),
+      ...hasJestInstalled
+        ? [
+          mergeWith(templateCommonJest, MergeStrategy.Overwrite),
+          mergeWith(templateNgJest, MergeStrategy.Overwrite),
+          setUpJestForAngularJson(options),
+          setUpAngularTestPackageJson({ ...options })
+        ]
+        : [
+          setUpAngularTestPackageJson(options)
+        ],
+      updatePackageDependenciesFactory(options.targetPath, otterVersion!, o3rCorePackageJson,
+        { ...options, useJest: !!hasJestInstalled }
+      ),
       updateNgPackagrFactory(options.targetPath),
       (t) => {
         const genPackageJsonPath = path.posix.join(options.targetPath, 'package.json');

packages/@o3r/workspace/schematics/library/rules/rules.nx.ts

@@ -105,25 +105,34 @@ export function nxGenerateModule(options: NgGenerateModuleSchema & { packageJson
     const o3rCorePackageJsonPath = path.resolve(__dirname, '..', '..', '..', 'package.json');
     const o3rCorePackageJson: PackageJson & { generatorDependencies?: Record<string, string> } = JSON.parse(readFileSync(o3rCorePackageJsonPath).toString());
     const otterVersion = o3rCorePackageJson.dependencies!['@o3r/schematics'];
-
     const templateNx = apply(url('./templates/nx'), [
       template({
         ...options,
         path: targetPath,
-        projectRoot: path.posix.resolve(targetPath, options.name),
+        projectRoot: targetPath,
         otterVersion,
         tsconfigBasePath: findConfigFileRelativePath(tree, ['tsconfig.base.json', 'tsconfig.json'], targetPath),
         runner: getPackageManagerRunner(getWorkspaceConfig(tree))
       }),
       renameTemplateFiles(),
       move(targetPath)
     ]);
+    const templateJest = apply(url('./templates/jest'), [
+      template({
+        ...options,
+        tsconfigBasePath: findConfigFileRelativePath(tree, ['tsconfig.base.json', 'tsconfig.json'], targetPath)
+      }),
+      renameTemplateFiles(),
+      move(targetPath)
+    ]);
     rules.push(mergeWith(templateNx, MergeStrategy.Overwrite));
-
     return chain([
       ...rules,
-      updatePackageDependenciesFactory(targetPath, otterVersion!, o3rCorePackageJson, options),
+      updatePackageDependenciesFactory(targetPath, otterVersion!, o3rCorePackageJson,
+        { ...options, useJest: true }
+      ),
       updateNgPackagrFactory(targetPath),
+      mergeWith(templateJest, MergeStrategy.Overwrite),
       (t) => {
         const packageJson = t.readJson(path.posix.join(targetPath, 'package.json')) as PackageJson;
         packageJson.name = options.packageJsonName;

packages/@o3r/workspace/schematics/library/rules/shared.ts

@@ -25,7 +25,7 @@ export function updatePackageDependenciesFactory(
     targetPath: string,
     otterVersion: string,
     o3rCorePackageJson: PackageJson & { generatorDependencies?: Record<string, string> },
-    options: NgGenerateModuleSchema): Rule {
+    options: NgGenerateModuleSchema & { useJest?: boolean }): Rule {
   return (tree) => {
     const packageJson = tree.readJson(path.posix.join(targetPath, 'package.json')) as PackageJson;
     const runner = getPackageManagerRunner(getWorkspaceConfig(tree));
@@ -41,7 +41,6 @@ export function updatePackageDependenciesFactory(
     packageJson.keywords ||= [];
     packageJson.keywords.push('otter-module');
     packageJson.version = '0.0.0-placeholder';
-
     packageJson.devDependencies = {
       ...packageJson.devDependencies,
       ...Object.fromEntries(Object.entries({
@@ -56,20 +55,19 @@ export function updatePackageDependenciesFactory(
         '@angular/platform-browser': packageJson.peerDependencies['@angular/common'],
         '@angular/platform-browser-dynamic': packageJson.peerDependencies['@angular/common'],
         '@schematics/angular': o3rCorePackageJson.peerDependencies!['@schematics/angular'],
-        '@types/jest': o3rCorePackageJson.generatorDependencies!['@types/jest'],
-        '@typescript-eslint/eslint-plugin': o3rCorePackageJson.generatorDependencies!['@typescript-eslint/parser'],
-        '@typescript-eslint/parser': o3rCorePackageJson.generatorDependencies!['@typescript-eslint/parser'],
         'cpy-cli': o3rCorePackageJson.generatorDependencies!['cpy-cli'],
-        eslint: o3rCorePackageJson.generatorDependencies!.eslint,
-        'eslint-import-resolver-node': o3rCorePackageJson.generatorDependencies!['eslint-import-resolver-node'],
-        'eslint-plugin-jest': o3rCorePackageJson.generatorDependencies!['eslint-plugin-jest'],
-        'eslint-plugin-jsdoc': o3rCorePackageJson.generatorDependencies!['eslint-plugin-jsdoc'],
-        'eslint-plugin-prefer-arrow': o3rCorePackageJson.generatorDependencies!['eslint-plugin-prefer-arrow'],
-        'eslint-plugin-unicorn': o3rCorePackageJson.generatorDependencies!['eslint-plugin-unicorn'],
-        jest: o3rCorePackageJson.generatorDependencies!.jest,
-        'jest-environment-jsdom': o3rCorePackageJson.generatorDependencies!.jest,
-        'jest-junit': o3rCorePackageJson.generatorDependencies!['jest-junit'],
-        'jest-preset-angular': o3rCorePackageJson.generatorDependencies!['jest-preset-angular'],
+        ...options.useJest
+          ? {
+            '@angular-builders/jest': o3rCorePackageJson.generatorDependencies!['@angular-builders/jest'],
+            '@angular-devkit/build-angular': o3rCorePackageJson.devDependencies!['@angular-devkit/build-angular'],
+            '@types/jest': o3rCorePackageJson.devDependencies!['@types/jest'],
+            jest: o3rCorePackageJson.devDependencies!.jest,
+            'jest-environment-jsdom': o3rCorePackageJson.devDependencies!.jest,
+            'jest-junit': o3rCorePackageJson.devDependencies!['jest-junit'],
+            'jest-preset-angular': o3rCorePackageJson.devDependencies!['jest-preset-angular'],
+            'ts-jest': o3rCorePackageJson.devDependencies!['ts-jest']
+          }
+          : {},
         rxjs: o3rCorePackageJson.peerDependencies!.rxjs,
         typescript: o3rCorePackageJson.peerDependencies!.typescript,
         'zone.js': o3rCorePackageJson.generatorDependencies!['zone.js']

packages/@o3r/workspace/schematics/library/templates/ng/jest.config.js.template → packages/@o3r/workspace/schematics/library/templates/jest/jest.config.js.template

@@ -10,7 +10,7 @@ module.exports = {
   displayName: require('./package.json').name,
   preset: 'jest-preset-angular',
   setupFilesAfterEnv: ['<rootDir>/testing/setup-jest.ts'],
-  rootDir: '.',
+  rootDir: __dirname,
   moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
   testPathIgnorePatterns: [
     '<rootDir>/dist',