feat: introduce update-ts-reference.yaml (#34)

README.md

@@ -59,12 +59,18 @@ The output for the created file looks like the following
   },
   "references": [ // will be added after running update-ts-references 
     {
-      "path": "../some-other-package
+      "path": "../some-other-package"
     }
   ]
 }
 ```
 
+## using update-ts-references.yaml for configurations
+You can configure paths via the _update-ts-references.yaml_ file. This is useful if your repo is having **no** _package.json_ or _pnp-workspace.yaml_ in the root folder. Additional to that it can also being used to extend the paths config next to the normal workspace setup via npm, pnpm, yarn and lerna so you can include or exclude some packages. 
+
+Example configuration see [here](./test-scenarios/ts-ref-yaml/update-ts-references.yaml)
+
+
 
 ## FAQ
 ### Why is my pnpm workspace alias not working?

package.json

@@ -1,6 +1,6 @@
 {
   "name": "update-ts-references",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Updates TypeScript references automatically while using workspaces",
   "bin": "src/index.js",
   "scripts": {

src/update-ts-references.js

@@ -28,7 +28,7 @@ const getAllPackageJsons = async (workspaces,cwd) => {
 
   workspaces.forEach((workspaceGlob) => {
     if (workspaceGlob.startsWith('!')) {
-      ignoreGlobs.push(workspaceGlob);
+      ignoreGlobs.push(!workspaceGlob.includes('/') ? `${workspaceGlob}/${PACKAGE_JSON}`:  workspaceGlob);
     } else {
       workspaceGlobs.push(workspaceGlob);
     }
@@ -60,6 +60,7 @@ const getAllPackageJsons = async (workspaces,cwd) => {
         (packageName) =>
           ignoreGlobs.reduce((prev, actualPattern) => {
             if (!prev) return prev;
+
             return minimatch(packageName, actualPattern);
           }, true) && !packageName.includes('node_modules')
       )
@@ -134,7 +135,6 @@ const getReferencesFromDependencies = (
   }
 
   return Object.keys(mergedDependencies)
-      .filter(name => !name.includes('test-utils'))
     .reduce((referenceArray, dependency) => {
       if (packagesMap.has(dependency)) {
         const { packageDir: dependencyDir } = packagesMap.get(dependency);
@@ -214,6 +214,10 @@ const execute = async ({
   const packageJson = require(path.join(cwd, PACKAGE_JSON));
 
   let workspaces = packageJson.workspaces;
+  if(workspaces && !Array.isArray(workspaces)) {
+    workspaces = workspaces.packages;
+  }
+
   if (!workspaces && fs.existsSync(path.join(cwd, 'lerna.json'))) {
     const lernaJson = require(path.join(cwd, 'lerna.json'));
     workspaces = lernaJson.packages;
@@ -226,16 +230,24 @@ const execute = async ({
     workspaces = pnpmConfig.packages;
   }
 
+  if (fs.existsSync(path.join(cwd, 'update-ts-references.yaml'))) {
+    const config = yaml.load(
+        fs.readFileSync(path.join(cwd, 'update-ts-references.yaml'))
+    );
+
+    workspaces = [...(config.packages ? config.packages : []), ...(workspaces ? workspaces : [])];
+
+    if (verbose) {
+      console.log('joined workspaces config', workspaces);
+    }
+  }
+
   if (!workspaces) {
     throw new Error(
       'could not detect yarn/npm/pnpm workspaces or lerna in this repository'
     );
   }
 
-  if (!Array.isArray(workspaces)) {
-    workspaces = workspaces.packages;
-  }
-
   const packageFilePaths = await getAllPackageJsons(workspaces, cwd);
   if (verbose) {
     console.log('packageFilePaths', packageFilePaths);

test-scenarios/ts-ref-yaml/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "ts-ref-yaml-workspace",
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "workspace-b",
+    "shared/*",
+    "utils/**/"
+  ],
+  "devDependencies": {
+    "typescript": "latest"
+  }
+}

test-scenarios/ts-ref-yaml/shared/workspace-c/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "workspace-c",
+  "version": "1.0.0",
+  "dependencies": {
+    "cross-env": "5.0.5"
+  },
+  "peerDependencies": {
+    "foo-a": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/shared/workspace-c/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/shared/workspace-d/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "workspace-d",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-c": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/shared/workspace-d/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "files": [],
+  "compilerOptions": {
+    /* Basic Options */
+    // "allowJs": true,
+    "composite": true
+  }
+}

test-scenarios/ts-ref-yaml/update-ts-references.yaml

@@ -0,0 +1,6 @@
+packages:
+  # all packages in subdirs of packages/ and components/
+  - 'workspace-a'
+  # exclude packages that are inside test directories
+  - '!**/tests/**'
+  - '!workspace-ignore'

test-scenarios/ts-ref-yaml/utils/foos/foo-a/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "foo-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "foo-b": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/utils/foos/foo-a/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/utils/foos/foo-b/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "foo-b",
+  "version": "1.0.0"
+}

test-scenarios/ts-ref-yaml/utils/foos/foo-b/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/utils/foos/tests/test-a/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "test-a",
+  "version": "1.0.0"
+}

test-scenarios/ts-ref-yaml/utils/foos/tests/test-a/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-a/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "workspace-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
+  "devDependencies": {
+      "foo-a": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-a/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-b/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "workspace-b",
+  "version": "1.0.0",
+  "dependencies": {
+    "cross-env": "5.0.5"
+  },
+  "devDependencies": {
+    "foo-b": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-b/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-ignore/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "ignore",
+  "version": "1.0.0",
+  "dependencies": {
+    "cross-env": "5.0.5"
+  },
+  "devDependencies": {
+    "foo-b": "1.0.0"
+  }
+}

test-scenarios/ts-ref-yaml/workspace-ignore/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}

tests/update-ts-references.test.js

@@ -16,6 +16,7 @@ const rootFolderYarnCreate = path.join(
     'yarn-ws-create'
 );
 const rootFolderPnpm = path.join(process.cwd(), 'test-run', 'pnpm');
+const rootFolderTsRefYaml = path.join(process.cwd(), 'test-run', 'ts-ref-yaml');
 const rootFolderYarnCheck = path.join(
   process.cwd(),
   'test-run',
@@ -247,6 +248,23 @@ test('Support pnpm workspaces', async () => {
   });
 });
 
+test('Support update-ts-reference.yaml workspaces', async () => {
+  await setup(rootFolderTsRefYaml);
+
+  tsconfigs.forEach((tsconfig) => {
+    const [configPath, config] = tsconfig;
+
+    expect(
+        parse(fs.readFileSync(path.join(rootFolderTsRefYaml, configPath, 'tsconfig.json')).toString())
+    ).toEqual(config);
+  });
+
+  // should not touch the ignore config
+  expect(
+      parse(fs.readFileSync(path.join(rootFolderTsRefYaml,'workspace-ignore', 'tsconfig.json')).toString())
+  ).toEqual( {compilerOptions});
+});
+
 test('Test create tsconfig', async () => {
   await setup(rootFolderYarnCreate, undefined, true);
   const r = [