test: isolated integration tests

Previously:
1. Integration tests were run in a subfolder within the root project, allowing 
   them to inherit missing dependencies from the root.
2. `npm/yarn link` was used to integrate Sheriff, resulting in Sheriff using 
   the TypeScript version from the root project instead of the version within 
   the integration tests.

These issues prevented the tests from detecting missing dependencies, such as 
the "typescript-eslint" package (as reported in #114), and caused failures due 
to version mismatches in TypeScript.

**Changes:**
- Integration tests have been moved to a temporary directory outside the root 
  project, ensuring complete isolation.
- `yalc` is now used instead of `npm/yarn link`, eliminating symlinks and 
  enforcing the use of the correct dependencies.

Author: rainerhahnekamp

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
         with:
           node-version: '18'
           cache: 'yarn'
-      - run: npm install -g yarn
+      - run: npm install -g yarn yalc
       - run: yarn
       - run: yarn lint:all
       - run: yarn link:sheriff

.gitignore

@@ -38,4 +38,7 @@ testem.log
 .DS_Store
 Thumbs.db
 
-.nx/cache
+.nx
+.yalc
+yalc.lock
+.test-projects

DEVELOPMENT.md

@@ -0,0 +1,10 @@
+Sheriff consists of three processes:
+
+1. File Graph: `traverseFilesystem` gets and entry file and returns a graph of all the files that are required to run
+   the entry file. The final type of the graph is `UnassignedFileInfo`, meaning graph without modules.
+2. Modules: Based on `FileInfo`, `createModules` detects the existing modules and their dependencies. The final type of
+   the modules is `ModuleInfo`.
+3. Merging FileGraph and Modules: `FileInfo` is the final type of the graph that contains all the information about the
+   files and modules. It is done by
+
+The entry point is always the `init` function.

package.json

@@ -7,7 +7,7 @@
     "build:all": "npx nx run-many --target=build && chmod +x dist/packages/core/src/bin/main.js",
     "commit": "commit",
     "lint:all": "eslint ./packages",
-    "link:sheriff": "npm run build:all && yarn link --cwd dist/packages/core && yarn link --cwd dist/packages/eslint-plugin && yarn link @softarc/sheriff-core @softarc/eslint-plugin-sheriff",
+    "link:sheriff": "npm run build:all && yalc publish dist/packages/core && yalc publish dist/packages/eslint-plugin && yalc link @softarc/sheriff-core @softarc/eslint-plugin-sheriff",
     "run:cli": "nx build core && chmod +x dist/packages/core/src/bin/main.js",
     "test": "vitest",
     "test:ci": "vitest -c vitest.config.ci.ts"

packages/core/src/lib/file-info/traverse-filesystem.ts

@@ -2,7 +2,7 @@ import UnassignedFileInfo from './unassigned-file-info';
 import getFs from '../fs/getFs';
 import * as ts from 'typescript';
 import { TsData, TsPaths } from './ts-data';
-import { FsPath, toFsPath } from './fs-path';
+import { FsPath, isFsPath, toFsPath } from './fs-path';
 
 export type ResolveFn = (
   moduleName: string,
@@ -21,6 +21,9 @@ export type ResolveFn = (
  * filesystem happens. In case the abstraction does not emulate the original's
  * behaviour, "strange bugs" might occur. Look out for them.
  *
+ * fixPathSeparators is necessary to replace the static '/' path separator
+ * with the one from the OS.
+ *
  * @param fsPath Filename to traverse from
  * @param fileInfoDict Dictionary of traversed files to catch circularity
  * @param tsData
@@ -57,14 +60,21 @@ const traverseFilesystem = (
           throw new Error(`${importPath} is outside of root ${rootDir}`);
         }
       }
-    } else if (fileName.endsWith('.json')) {
-      // just skip it
-    } else if (fileName.startsWith('.')) {
-      // might be an undetected dependency in node_modules
-      // or an incomplete import (= developer is still typing),
-      // if we read from an unsaved file via ESLint.
+    }
+
+    // just skip it
+    else if (fileName.endsWith('.json')) {
+    }
+
+    // might be an undetected dependency in node_modules
+    // or an incomplete import (= developer is still typing),
+    // if we read from an unsaved file via ESLint.
+    else if (fileName.startsWith('.')) {
       fileInfo.addUnresolvableImport(fileName);
-    } else {
+    }
+
+    // check for path/alias mapping
+    else {
       const resolvedTsPath = resolvePotentialTsPath(
         fileName,
         paths,
@@ -103,27 +113,36 @@ export function resolvePotentialTsPath(
   let unpathedImport: string | undefined;
   for (const tsPath in tsPaths) {
     const { isWildcard, clearedTsPath } = clearTsPath(tsPath);
+    // import from '@app/app.component' & paths: {'@app/*': ['src/app/*']}
     if (isWildcard && moduleName.startsWith(clearedTsPath)) {
       const pathMapping = tsPaths[tsPath];
       unpathedImport = moduleName.replace(clearedTsPath, pathMapping);
-    } else if (tsPath === moduleName) {
+    }
+    // import from '@app' & paths: { '@app': [''] }
+    else if (tsPath === moduleName) {
       unpathedImport = tsPaths[tsPath];
     }
 
     if (unpathedImport) {
-      const resolvedImport = resolveFn(unpathedImport);
-
-      if (
-        !resolvedImport.resolvedModule ||
-        resolvedImport.resolvedModule.isExternalLibraryImport === true
-      ) {
-        throw new Error(
-          `unable to resolve import ${moduleName} in ${filename}`,
+      // path is file -> return as is
+      if (isPathFile(unpathedImport)) {
+        return fixPathSeparators(toFsPath(unpathedImport));
+      }
+      // path is directory or something else -> rely on TypeScript resolvers
+      else {
+        const resolvedImport = resolveFn(unpathedImport);
+        if (
+          !resolvedImport.resolvedModule ||
+          resolvedImport.resolvedModule.isExternalLibraryImport === true
+        ) {
+          throw new Error(
+            `unable to resolve import ${moduleName} in ${filename}`,
+          );
+        }
+        return toFsPath(
+          fixPathSeparators(resolvedImport.resolvedModule.resolvedFileName),
         );
       }
-      return toFsPath(
-        fixPathSeparators(resolvedImport.resolvedModule.resolvedFileName),
-      );
     }
   }
 
@@ -137,6 +156,12 @@ function clearTsPath(tsPath: string) {
   return { isWildcard, clearedTsPath: clearedPath };
 }
 
+
+/**
+ * Ensures that `FsPath` uses the separator from the OS and not always '/'
+ *
+ * @param path
+ */
 function fixPathSeparators(path: string): FsPath {
   const fs = getFs();
 
@@ -147,4 +172,24 @@ function fixPathSeparators(path: string): FsPath {
   return toFsPath(path);
 }
 
+/**
+ * Checks if the path is a file.
+ *
+ * For example in tsconfig.json:
+ * ```json
+ *   "paths": {
+ *     "@app": ["src/app/index"]
+ *   }
+ * ```
+ *
+ * 'src/app/index' comes already as absolute path with ts extension from
+ * pre-processing of @generateTsData.
+ *
+ * @param path '/.../src/app/index.ts' according to the example above
+ */
+function isPathFile(path: string): boolean {
+  const fs = getFs();
+  return fs.exists(path) && isFsPath(path) && fs.isFile(path);
+}
+
 export default traverseFilesystem;

packages/core/src/lib/fs/default-fs.ts

@@ -89,6 +89,10 @@ export class DefaultFs extends Fs {
   override split = (p: string) => p.split(path.sep);
 
   print = () => void true;
+
+  override isFile(path: FsPath): boolean {
+    return fs.lstatSync(path).isFile();
+  }
 }
 
 const defaultFs = new DefaultFs();

packages/core/src/lib/fs/fs.ts

@@ -45,4 +45,6 @@ export abstract class Fs {
   abstract split(path: string): string[];
 
   abstract isAbsolute(path: string): boolean;
+
+  abstract isFile(path: FsPath): boolean
 }

packages/core/src/lib/fs/virtual-fs.ts

@@ -286,6 +286,11 @@ export class VirtualFs extends Fs {
   override split(path: string): string[] {
     return path.split('/');
   }
+
+  override isFile(path: FsPath): boolean {
+    const node  = this.#getNodeOrThrow(path);
+    return node.node.type === 'file'
+  }
 }
 
 const virtualFs = new VirtualFs();

run-integration-tests.sh

@@ -1,14 +1,24 @@
 set -e
 
-# This is necessary because @angular-eslint uses nx and would
-# use root as workspace... ending up in strange error messages.
-# This can go away as soon as angular-eslint switches to flat
-# config.
+# We copy the test projects to a temporary directory to avoid any potential
+# issues with the dependencies from the root project.
 
-mv nx.json nx.json.bak
+# Check if .test-projects exists and is a symbolic link
+if [ -L .test-projects ]; then
+  TARGET_DIR=$(readlink .test-projects)
+  rm .test-projects
+  rm -rf "$TARGET_DIR"
+  echo "Removing $TARGET_DIR"
+fi
+
+export TMP_DIR=$(mktemp -d)
+rsync -a --exclude node_modules --exclude .angular test-projects/ "$TMP_DIR"
+ln -sf "$TMP_DIR" .test-projects
+
+echo "Temporary directory created at $TMP_DIR"
 
 echo "Testing against Angular 15 (ESLint Legacy)"
-cd test-projects/angular-i
+cd .test-projects/angular-i
 bash ./integration-test.sh
 
 echo "Testing against Angular 18 (ESLint Flat)"
@@ -19,4 +29,5 @@ cd ../typescript-i
 bash ./integration-test.sh
 
 cd ../..
-mv nx.json.bak nx.json
+
+echo "Tests finished successfully"

test-projects/angular-i/integration-test.sh

@@ -1,19 +1,24 @@
 set -e
 yarn
+yalc add @softarc/sheriff-core @softarc/eslint-plugin-sheriff
+cd node_modules/.bin # yalc doesn't create symlink in node_modules/.bin
+ln -s ../@softarc/sheriff-core/src/bin/main.js ./sheriff
+cd ../../
+cp sheriff.config.ts sheriff.config.ts.original
 
 # CLI List Check
 echo 'checking for CLI list'
-sheriff list src/main.ts > tests/actual/cli-list.txt
+npx sheriff list src/main.ts > tests/actual/cli-list.txt
 diff tests/actual/cli-list.txt tests/expected/cli-list.txt
 
 # CLI Export Check
 echo 'checking for CLI export'
-sheriff export src/main.ts > tests/actual/cli-export.txt
+npx sheriff export src/main.ts > tests/actual/cli-export.txt
 diff tests/actual/cli-export.txt tests/expected/cli-export.txt
 
 # CLI Verify Check
 echo 'checking for CLI verify'
-sheriff verify src/main.ts > tests/actual/cli-verify.txt
+npx sheriff verify src/main.ts > tests/actual/cli-verify.txt
 diff tests/actual/cli-verify.txt tests/expected/cli-verify.txt
 
 # Dynamic Import Check
@@ -22,36 +27,38 @@ cp tests/dynamic-import-sheriff.config.ts sheriff.config.ts
 npx ng lint --force --format json --output-file tests/actual/dynamic-import-lint.json
 ../remove-paths.mjs tests/actual/dynamic-import-lint.json
 diff tests/actual/dynamic-import-lint.json tests/expected/dynamic-import-lint.json
-git checkout -q sheriff.config.ts
+cp sheriff.config.ts.original sheriff.config.ts
 
 ## Deep Import Check
 echo 'checking for deep import error'
+mv src/app/customers/feature/components/customers-container.component.ts src/app/customers/feature/components/customers-container.component.ts.original
 cp tests/customers-container.deep-import.component.ts src/app/customers/feature/components/customers-container.component.ts
 npx ng lint --force --format json --output-file tests/actual/deep-import-lint.json
 ../remove-paths.mjs tests/actual/deep-import-lint.json
 diff tests/actual/deep-import-lint.json tests/expected/deep-import-lint.json
-git checkout -q src/app/customers/feature/components/customers-container.component.ts
+mv src/app/customers/feature/components/customers-container.component.ts.original src/app/customers/feature/components/customers-container.component.ts
 
 ## Dependency Rule Check
 echo 'checking for dependency rule error'
+mv src/app/customers/ui/customer/customer.component.ts src/app/customers/ui/customer/customer.component.ts.original
 cp tests/customer.dependency-rule.component.ts src/app/customers/ui/customer/customer.component.ts
 npx ng lint --force --format json --output-file tests/actual/dependency-rule-lint.json
 ../remove-paths.mjs tests/actual/dependency-rule-lint.json
 diff tests/actual/dependency-rule-lint.json tests/expected/dependency-rule-lint.json
-git checkout -q src/app/customers/ui/customer/customer.component.ts
+mv src/app/customers/ui/customer/customer.component.ts.original src/app/customers/ui/customer/customer.component.ts
 
 ## User Error Processing
 echo 'checking for user error processing'
 cp tests/empty-sheriff.config.ts sheriff.config.ts
 npx ng lint --force --format json --output-file tests/actual/user-error-lint.json
 ../remove-paths.mjs tests/actual/user-error-lint.json
 diff tests/actual/user-error-lint.json tests/expected/user-error-lint.json
-git checkout -q sheriff.config.ts
+cp sheriff.config.ts.original sheriff.config.ts
 
 ## Auto Tagging
 echo 'checking for auto tagging'
 cp tests/auto-tagging.config.ts sheriff.config.ts
 npx ng lint --force --format json --output-file tests/actual/auto-tagging-lint.json
 ../remove-paths.mjs tests/actual/auto-tagging-lint.json
 diff tests/actual/auto-tagging-lint.json tests/expected/auto-tagging-lint.json
-git checkout -q sheriff.config.ts
+cp sheriff.config.ts.original sheriff.config.ts

test-projects/angular-i/tests/customers-container.deep-import.component.ts

@@ -1,7 +1,7 @@
 import { AsyncPipe, NgIf } from '@angular/common';
 import { Component, inject } from '@angular/core';
 import { CustomersComponent, CustomersViewModel } from '@eternal/customers/ui';
-import { CustomersRepository } from '../../data/customers-repository.service.ts';
+import { CustomersRepository } from '../../data/customers-repository.service';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
 

test-projects/angular-i/tests/expected/deep-import-lint.json

@@ -10,7 +10,7 @@
         "column": 1,
         "nodeType": "ImportDeclaration",
         "endLine": 4,
-        "endColumn": 82
+        "endColumn": 79
       }
     ],
     "suppressedMessages": [],
@@ -19,7 +19,7 @@
     "warningCount": 0,
     "fixableErrorCount": 0,
     "fixableWarningCount": 0,
-    "source": "import { AsyncPipe, NgIf } from '@angular/common';\nimport { Component, inject } from '@angular/core';\nimport { CustomersComponent, CustomersViewModel } from '@eternal/customers/ui';\nimport { CustomersRepository } from '../../data/customers-repository.service.ts';\nimport { Observable } from 'rxjs';\nimport { map } from 'rxjs/operators';\n\n@Component({\n  template: ` <eternal-customers\n    *ngIf=\"viewModel$ | async as viewModel\"\n    [viewModel]=\"viewModel\"\n    (setSelected)=\"setSelected($event)\"\n    (setUnselected)=\"setUnselected()\"\n    (switchPage)=\"switchPage($event)\"\n  ></eternal-customers>`,\n  standalone: true,\n  imports: [CustomersComponent, NgIf, AsyncPipe],\n})\nexport class CustomersContainerComponent {\n  #customersRepository = inject(CustomersRepository);\n  viewModel$: Observable<CustomersViewModel> =\n    this.#customersRepository.pagedCustomers$.pipe(\n      map((pagedCustomers) => ({\n        customers: pagedCustomers.customers,\n        pageIndex: pagedCustomers.page - 1,\n        length: pagedCustomers.total,\n      }))\n    );\n\n  setSelected(id: number) {\n    this.#customersRepository.select(id);\n  }\n\n  setUnselected() {\n    this.#customersRepository.unselect();\n  }\n\n  switchPage(page: number) {\n    console.log('switch to page ' + page + ' is not implemented');\n  }\n}\n",
+    "source": "import { AsyncPipe, NgIf } from '@angular/common';\nimport { Component, inject } from '@angular/core';\nimport { CustomersComponent, CustomersViewModel } from '@eternal/customers/ui';\nimport { CustomersRepository } from '../../data/customers-repository.service';\nimport { Observable } from 'rxjs';\nimport { map } from 'rxjs/operators';\n\n@Component({\n  template: ` <eternal-customers\n    *ngIf=\"viewModel$ | async as viewModel\"\n    [viewModel]=\"viewModel\"\n    (setSelected)=\"setSelected($event)\"\n    (setUnselected)=\"setUnselected()\"\n    (switchPage)=\"switchPage($event)\"\n  ></eternal-customers>`,\n  standalone: true,\n  imports: [CustomersComponent, NgIf, AsyncPipe],\n})\nexport class CustomersContainerComponent {\n  #customersRepository = inject(CustomersRepository);\n  viewModel$: Observable<CustomersViewModel> =\n    this.#customersRepository.pagedCustomers$.pipe(\n      map((pagedCustomers) => ({\n        customers: pagedCustomers.customers,\n        pageIndex: pagedCustomers.page - 1,\n        length: pagedCustomers.total,\n      }))\n    );\n\n  setSelected(id: number) {\n    this.#customersRepository.select(id);\n  }\n\n  setUnselected() {\n    this.#customersRepository.unselect();\n  }\n\n  switchPage(page: number) {\n    console.log('switch to page ' + page + ' is not implemented');\n  }\n}\n",
     "usedDeprecatedRules": []
   }
 ]