feat!: adding basic support for jsconfig.json files (#52)

Author: MKruschke

README.md

@@ -15,7 +15,7 @@ npx update-ts-references --help
   Usage: update-ts-references [options]
 
   Options:
-    --configName    The name of the config files which needs to be updated. Default: tsconfig.json
+    --configName    The name of the config files which needs to be updated. Default: tsconfig.json 
     --rootConfigName    The name of the root config file which needs to be updated. Default: tsconfig.json
     --withoutRootConfig  If you will not have a tsconfig in the root directory or don't want to update it. Default: false
     --check         Checks if updates would be necessary (without applying them)
@@ -70,7 +70,7 @@ The output for the created file looks like the following
 ```
 
 ## using --createPathMappings
-will create path mappings under `compilerOptions` for a better IDE support. It assumes the source files are under `src`.
+will create path mappings under `compilerOptions` for a better IDE support. The generated mappings respect the `rootDir` defined in the referenced `tsconfig.json` or `jsconfig.json` and only fall back to `src` when no `rootDir` is provided.
 
 ```json
 {
@@ -106,6 +106,14 @@ Example configuration see [here](./test-scenarios/ts-options-yaml/update-ts-refe
 ### using multiple configurations for different usecases
 Executing update-ts-references with different configurations via the parameter `--usecase`.
 
+## about jsconfig.json support 
+When a dependency does not ship a `tsconfig.json` but provides a `jsconfig.json`, the reference automatically targets that file and the path mappings pick up its `rootDir` as well, if `--createPathMappings` is enabled. `jsconfig.json` files participate in package-level `references`, but they stay out of the root `tsconfig.json`.
+
+### in combination with the --configName argument
+Currently the name of the config file derives from the the configName which is `tsconfig.json` and would look for `jsconfig.json`. 
+
+Example: ` --configName tsconfig.test.json` would look for `jsconfig.test.json`
+
 ## FAQ
 ### Why is my pnpm workspace alias not working?
 

src/update-ts-references.js

@@ -12,6 +12,7 @@ const assert = require('assert').strict;
 
 const PACKAGE_JSON = 'package.json';
 const TSCONFIG_JSON = 'tsconfig.json'
+const JSCONFIG_JSON = 'jsconfig.json'
 
 const defaultOptions = {
     configName: TSCONFIG_JSON,
@@ -72,6 +73,15 @@ const getAllPackageJsons = async (workspaces, cwd) => {
         );
 };
 
+const detectJSConfig = (directory, configName) => {
+    const jsConfigName = configName.replace(/^ts/, 'js')
+    let detectedConfig = fs.existsSync(path.join(directory, jsConfigName)) ? jsConfigName : null
+    if (jsConfigName !== JSCONFIG_JSON && detectedConfig === null) {
+        detectedConfig = fs.existsSync(path.join(directory, JSCONFIG_JSON)) ? JSCONFIG_JSON : null
+    }
+    return detectedConfig
+}
+
 const detectTSConfig = (directory, configName, createConfig, cwd) => {
     let detectedConfig = fs.existsSync(path.join(directory, configName)) ? configName : null
     if (configName !== TSCONFIG_JSON && detectedConfig === null) {
@@ -154,6 +164,18 @@ const getReferencesFromDependencies = (
                             folder: relativePath,
                         },
                     ];
+                } else {
+                    const detectedJsConfig = detectJSConfig(dependencyDir, configName)
+                    if (detectedJsConfig !== null) {
+                        return [
+                            ...referenceArray,
+                            {
+                                name: dependency,
+                                path: path.join(relativePath, detectedJsConfig),
+                                folder: relativePath,
+                            },
+                        ];
+                    }
                 }
             }
             return referenceArray;
@@ -225,11 +247,12 @@ const updateTsConfig = (
     }
 };
 
-function getPathsFromReferences(references, tsconfigMap, ignorePathMappings
+function getPathsFromReferences(references, tsconfigMap, jsconfigMap, ignorePathMappings
     = []) {
     return references.reduce((paths, ref) => {
         if (ignorePathMappings.includes(ref.name)) return paths
-        const rootFolder = tsconfigMap[ref.name]?.compilerOptions?.rootDir ?? 'src'
+        const config = tsconfigMap[ref.name] ?? jsconfigMap[ref.name]
+        const rootFolder = config?.compilerOptions?.rootDir ?? 'src'
         return {
             ...paths,
             [`${ref.name}`]: [`${ref.folder}${rootFolder === '.' ? '' : `/${rootFolder}`}`],
@@ -316,6 +339,7 @@ const execute = async ({
     let rootReferences = [];
     let rootPaths = [];
     let tsconfigMap = {}
+    let jsconfigMap = {}
     packagesMap.forEach((packageEntry, packageName) => {
         const detectedConfig = detectTSConfig(packageEntry.packageDir, configName, packageEntry.hasTsEntry && createTsConfig, cwd)
 
@@ -329,6 +353,25 @@ const execute = async ({
                     compilerOptions
                 }
             }
+        } else {
+            const detectedJsConfig = detectJSConfig(packageEntry.packageDir, configName)
+            if (detectedJsConfig) {
+
+                let compilerOptions
+                try {
+                    compilerOptions = parse(fs.readFileSync(path.join(packageEntry.packageDir, detectedJsConfig)).toString()).compilerOptions
+                } catch {
+                    //ignore
+                }
+
+                jsconfigMap = {
+                    ...jsconfigMap,
+                    [packageName]: {
+                        detectedConfig,
+                        compilerOptions
+                    }
+                }
+            }
         }
     });
 
@@ -349,7 +392,7 @@ const execute = async ({
                 verbose
             ) || []).map(ensurePosixPathStyle);
 
-            const paths = getPathsFromReferences(references, tsconfigMap, ignorePathMappings)
+            const paths = getPathsFromReferences(references, tsconfigMap, jsconfigMap, ignorePathMappings)
 
             if (verbose) {
                 console.log(`references of ${packageName}`, references);
@@ -366,8 +409,11 @@ const execute = async ({
                 packageEntry
             );
         } else {
-            // eslint-disable-next-line no-console
-            console.log(`NO ${configName === TSCONFIG_JSON ? configName : `${configName} nor ${TSCONFIG_JSON}`} for ${packageName}`);
+            const detectedJsConfig = jsconfigMap[packageName]?.detectedConfig
+            if (!detectedJsConfig) {
+                // eslint-disable-next-line no-console
+                console.log(`NO ${configName === TSCONFIG_JSON ? configName : `${configName} nor ${TSCONFIG_JSON}`} for ${packageName}`);
+            }
             rootPaths.push({
                 name: packageName,
                 path: path.relative(cwd, packageEntry.packageDir),
@@ -377,7 +423,7 @@ const execute = async ({
     });
 
     rootReferences = (rootReferences || []).map(ensurePosixPathStyle);
-    rootPaths = getPathsFromReferences((rootReferences || []).map(ensurePosixPathStyle), tsconfigMap, ignorePathMappings)
+    rootPaths = getPathsFromReferences((rootReferences || []).map(ensurePosixPathStyle), tsconfigMap, {}, ignorePathMappings)
 
     if (verbose) {
         console.log('rootReferences', rootReferences);

test-scenarios/ts-paths/utils/foos/js-only/jsconfig.json

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

test-scenarios/ts-paths/utils/foos/js-only/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "js-only",
+  "version": "1.0.0",
+  "dependencies": {}
+}

test-scenarios/ts-paths/workspace-a/package.json

@@ -2,9 +2,11 @@
   "name": "workspace-a",
   "version": "1.0.0",
   "dependencies": {
-    "workspace-b": "1.0.0"
+    "workspace-b": "1.0.0",
+    "js-only": "1.0.0",
+    "js-only2": "1.0.0"
   },
   "devDependencies": {
-      "foo-a": "1.0.0"
+    "foo-a": "1.0.0"
   }
 }

test-scenarios/yarn-ws-check-paths/package.json

@@ -5,6 +5,7 @@
   "workspaces": [
     "workspace-a",
     "workspace-b",
+    "workspace-c",
     "shared/*",
     "utils/**"
   ],

test-scenarios/yarn-ws-check-paths/utils/foos/js-only/jsconfig.json

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

test-scenarios/yarn-ws-check-paths/utils/foos/js-only/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "js-only",
+  "version": "1.0.0",
+  "dependencies": {}
+}

test-scenarios/yarn-ws-check-paths/workspace-a/package.json

@@ -5,6 +5,6 @@
     "workspace-b": "1.0.0"
   },
   "devDependencies": {
-      "foo-a": "1.0.0"
+    "foo-a": "1.0.0"
   }
 }

test-scenarios/yarn-ws-check-paths/workspace-c/package.json

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