merge-tsconfigs 0.1.3 → 0.2.0

package/README.md

@@ -8,7 +8,7 @@
 [![Github](https://badgen.net/badge/icon/github?icon=github&label&color=grey)](https://github.com/yowainwright/merge-tsconfigs)
 ![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fyowainwright%2Fmerge-tsconfigs)
 
-**WIP:** _Merge-tsconfigs_ is a CLI and node tool for merging tsconfig files into the exact tsconfig file you want. 💪
+_Merge-tsconfigs_ is a CLI and node tool for merging tsconfig files into the exact tsconfig file you want. 💪
 
 ---
 
@@ -82,10 +82,11 @@ Options:
   -o, --out [out]             output file
   -i, --include [include...]  files to include, matches a glob or array pattern
   -e, --exclude [exclude...]  files to exclude, matches a glob or array pattern
+  -p, --path <path>           a json parseable string wrapped object, e.g. {"item/*": ["foo": "bar"]}
   -h, --help                  display help for command
 ```
 
-\*`compilerOptions` are not added above for readability (but they can be leveraged). To view all cli options, run `merge-tsconfigs --help`! `compilerOptions.paths` aren't implemented.
+\*`compilerOptions` are not added above for readability (but they can be leveraged). To view all cli options, run `merge-tsconfigs --help`! `compilerOptions.paths` is a string wrapped object.
 
 #### Recipes
 
@@ -173,6 +174,24 @@ merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --allowJS --noEmit 'delete
 }
 ```
 
+Add a path to `compilerOptions.paths`
+
+```sh
+merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --path '{"item/*": ["foo": "bar"]}'
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
+```
+
+```ts
+// tsconfig.merged.json
+{
+  "compilerOptions": {
+    "paths": {
+      "item/*": ["foo": "bar"]
+    }
+  }
+}
+```
+
 ---
 
 ### Node API

package/dist/index.cjs

@@ -31,6 +31,7 @@ __export(src_exports, {
   mergeConfigContent: () => mergeConfigContent,
   mergeConfigObjects: () => mergeConfigObjects,
   mergeTsConfigs: () => mergeTsConfigs,
+  parsePath: () => parsePath,
   resolveJSON: () => resolveJSON,
   script: () => script,
   updateCompilerOptions: () => updateCompilerOptions,
@@ -72,7 +73,6 @@ function resolveJSON(path, debug = false) {
     const json = import_json5.default.parse((0, import_fs.readFileSync)(path, "utf8"));
     return json;
   } catch (err) {
-    console.log({ err });
     if (debug)
       logger({ isDebugging: debug })("error")("resolveJSON")("There was an error:")(err);
     return {};
@@ -126,7 +126,7 @@ var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
   (0, import_fs.writeFileSync)(path, JSON.stringify(tsconfig, null, 2));
   return tsconfig;
 };
-var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
+var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions, updatedPath) => {
   const compilerOptionKeys = compilerOptions2 ? Object.keys(compilerOptions2) : [];
   const hasCompilerOptions = compilerOptionKeys.length > 0;
   if (!hasCompilerOptions)
@@ -138,9 +138,26 @@ var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
       delete updatedOptions[key];
       return updatedOptions || {};
     }
-    return { ...updatedOptions, [key]: value };
+    const paths = {
+      ...updatedOptions.paths || {},
+      ...key === "paths" ? { value } : {},
+      ...updatedPath ? { ...updatedPath } : {}
+    };
+    return { ...updatedOptions, [key]: value, ...Object.keys(paths).length > 0 ? { paths } : {} };
   }, {});
 };
+var parsePath = (path = "", debug = false) => {
+  if (!path)
+    return {};
+  try {
+    const json = import_json5.default.parse(path);
+    return json;
+  } catch (err) {
+    if (debug)
+      logger({ isDebugging: debug })("error")("parsePath")("There was an error:")(err);
+    return {};
+  }
+};
 var mergeTsConfigs = ({
   tsconfigs = [],
   exclude,
@@ -148,6 +165,7 @@ var mergeTsConfigs = ({
   compilerOptions: compilerOptions2,
   debug = false,
   out = "tsconfig.merged.json",
+  path,
   isTesting = false
 }) => {
   if (tsconfigs.length === 0) {
@@ -159,7 +177,12 @@ var mergeTsConfigs = ({
   const updatedTsconfig = mergeConfigContent(tsconfigs, cwd, debug);
   if (debug)
     logger({ isDebugging: debug })("debug")("mergeTsConfig")("Updated tsconfig:")(updatedTsconfig);
-  const updatedCompilerOptions = updateCompilerOptions(compilerOptions2, updatedTsconfig?.compilerOptions || {});
+  const updatedPath = parsePath(path, debug);
+  const updatedCompilerOptions = updateCompilerOptions(
+    compilerOptions2,
+    updatedTsconfig?.compilerOptions || {},
+    updatedPath
+  );
   const updatedExclude = exclude ? { exclude: [...updatedTsconfig?.exclude || [], ...exclude] } : {};
   const updatedInclude = include ? { include: [...updatedTsconfig.include || [], ...include] } : {};
   const tsconfig = {
@@ -228,20 +251,21 @@ function action(files, options = {}) {
       isTesting = false,
       isTestingCLI = false,
       out,
+      path,
       ...compilerOptions2
     } = options;
     if (isTestingCLI) {
       console.info({ files, options });
       return;
     }
-    script({ debug, exclude, include, isTesting, out, tsconfigs: files, compilerOptions: compilerOptions2 });
+    script({ debug, exclude, include, isTesting, path, out, tsconfigs: files, compilerOptions: compilerOptions2 });
   } catch (err) {
     logger({ isDebugging: options.debug })("error")("action")("There was an error:")(err);
   }
 }
 import_commander.program.name("merge-tsconfigs").description(
   "Merge-tsconfigs is a CLI and node tool for merging tsconfig files into the exact tsconfig file you want \u{1F6E3}\uFE0F"
-).argument("[files...]", "files to check, matches an array pattern").option("-d, --debug", "enable debugging").option("-e, --exclude [exclude...]", "files to exclude, matches a glob or array pattern").option("-i, --include [include...]", "files to include, matches a glob or array pattern").option("--isTesting", "enable testing").option("-o, --out <file>", "output file, otherwise, the file will be written to tsconfig.merged.json").option("--isTesting", "enable testing").option("-t, --isTestingCLI", "enable CLI only testing");
+).argument("[files...]", "files to check, matches an array pattern").option("-d, --debug", "enable debugging").option("-e, --exclude [exclude...]", "files to exclude, matches a glob or array pattern").option("-i, --include [include...]", "files to include, matches a glob or array pattern").option("--isTesting", "enable testing").option("-o, --out <file>", "output file, otherwise, the file will be written to tsconfig.merged.json").option("--isTesting", "enable testing").option("-t, --isTestingCLI", "enable CLI only testing").option("-p, --path <path>", 'a json parseable string wrapped object, e.g. {"item/*": ["foo": "bar"]}');
 Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name] })).forEach(({ name, value }) => {
   if (value === "boolean") {
     import_commander.program.option(`--${name}`, `tsconfig.compilerOptions.${name}`);
@@ -263,6 +287,7 @@ var src_default = scripts_default;
   mergeConfigContent,
   mergeConfigObjects,
   mergeTsConfigs,
+  parsePath,
   resolveJSON,
   script,
   updateCompilerOptions,

package/dist/index.d.ts

@@ -14,6 +14,7 @@ interface ConfigOptions {
     tsconfigs?: string[];
     exclude?: string[];
     include?: string[];
+    path?: string;
     isTesting?: boolean;
 }
 type LoggerParams = {
@@ -136,8 +137,9 @@ declare const mergeConfigObjects: (tsconfig1: TsConfig, tsconfig2: TsConfig) =>
 };
 declare const mergeConfigContent: (tsconfigs: string[], cwd: string, debug?: boolean) => TsConfig;
 declare const writeTsconfig: (tsconfig: TsConfig, cwd: string, out: string, isTesting: boolean) => TsConfig;
-declare const updateCompilerOptions: (compilerOptions: PartialCompilerOptions | undefined, currentCompilerOptions: PartialCompilerOptions) => PartialCompilerOptions;
-declare const mergeTsConfigs: ({ tsconfigs, exclude, include, compilerOptions, debug, out, isTesting, }: ConfigOptions) => TsConfig | undefined;
-declare const script: ({ tsconfigs, exclude, include, compilerOptions, debug, out, isTesting, }: ConfigOptions) => TsConfig | undefined;
+declare const updateCompilerOptions: (compilerOptions: PartialCompilerOptions | undefined, currentCompilerOptions: PartialCompilerOptions, updatedPath: CompilerOptions['paths']) => PartialCompilerOptions;
+declare const parsePath: (path?: string, debug?: boolean) => CompilerOptions['paths'];
+declare const mergeTsConfigs: ({ tsconfigs, exclude, include, compilerOptions, debug, out, path, isTesting, }: ConfigOptions) => TsConfig | undefined;
+declare const script: ({ tsconfigs, exclude, include, compilerOptions, debug, out, path, isTesting, }: ConfigOptions) => TsConfig | undefined;
 
-export { mergeTsConfigs as default, logger, mergeConfigContent, mergeConfigObjects, mergeTsConfigs, resolveJSON, script, updateCompilerOptions, writeTsconfig };
+export { mergeTsConfigs as default, logger, mergeConfigContent, mergeConfigObjects, mergeTsConfigs, parsePath, resolveJSON, script, updateCompilerOptions, writeTsconfig };

package/dist/index.js

@@ -32,7 +32,6 @@ function resolveJSON(path, debug = false) {
     const json = JSON5.parse(readFileSync(path, "utf8"));
     return json;
   } catch (err) {
-    console.log({ err });
     if (debug)
       logger({ isDebugging: debug })("error")("resolveJSON")("There was an error:")(err);
     return {};
@@ -86,7 +85,7 @@ var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
   writeFileSync(path, JSON.stringify(tsconfig, null, 2));
   return tsconfig;
 };
-var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
+var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions, updatedPath) => {
   const compilerOptionKeys = compilerOptions2 ? Object.keys(compilerOptions2) : [];
   const hasCompilerOptions = compilerOptionKeys.length > 0;
   if (!hasCompilerOptions)
@@ -98,9 +97,26 @@ var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
       delete updatedOptions[key];
       return updatedOptions || {};
     }
-    return { ...updatedOptions, [key]: value };
+    const paths = {
+      ...updatedOptions.paths || {},
+      ...key === "paths" ? { value } : {},
+      ...updatedPath ? { ...updatedPath } : {}
+    };
+    return { ...updatedOptions, [key]: value, ...Object.keys(paths).length > 0 ? { paths } : {} };
   }, {});
 };
+var parsePath = (path = "", debug = false) => {
+  if (!path)
+    return {};
+  try {
+    const json = JSON5.parse(path);
+    return json;
+  } catch (err) {
+    if (debug)
+      logger({ isDebugging: debug })("error")("parsePath")("There was an error:")(err);
+    return {};
+  }
+};
 var mergeTsConfigs = ({
   tsconfigs = [],
   exclude,
@@ -108,6 +124,7 @@ var mergeTsConfigs = ({
   compilerOptions: compilerOptions2,
   debug = false,
   out = "tsconfig.merged.json",
+  path,
   isTesting = false
 }) => {
   if (tsconfigs.length === 0) {
@@ -119,7 +136,12 @@ var mergeTsConfigs = ({
   const updatedTsconfig = mergeConfigContent(tsconfigs, cwd, debug);
   if (debug)
     logger({ isDebugging: debug })("debug")("mergeTsConfig")("Updated tsconfig:")(updatedTsconfig);
-  const updatedCompilerOptions = updateCompilerOptions(compilerOptions2, updatedTsconfig?.compilerOptions || {});
+  const updatedPath = parsePath(path, debug);
+  const updatedCompilerOptions = updateCompilerOptions(
+    compilerOptions2,
+    updatedTsconfig?.compilerOptions || {},
+    updatedPath
+  );
   const updatedExclude = exclude ? { exclude: [...updatedTsconfig?.exclude || [], ...exclude] } : {};
   const updatedInclude = include ? { include: [...updatedTsconfig.include || [], ...include] } : {};
   const tsconfig = {
@@ -188,20 +210,21 @@ function action(files, options = {}) {
       isTesting = false,
       isTestingCLI = false,
       out,
+      path,
       ...compilerOptions2
     } = options;
     if (isTestingCLI) {
       console.info({ files, options });
       return;
     }
-    script({ debug, exclude, include, isTesting, out, tsconfigs: files, compilerOptions: compilerOptions2 });
+    script({ debug, exclude, include, isTesting, path, out, tsconfigs: files, compilerOptions: compilerOptions2 });
   } catch (err) {
     logger({ isDebugging: options.debug })("error")("action")("There was an error:")(err);
   }
 }
 program.name("merge-tsconfigs").description(
   "Merge-tsconfigs is a CLI and node tool for merging tsconfig files into the exact tsconfig file you want \u{1F6E3}\uFE0F"
-).argument("[files...]", "files to check, matches an array pattern").option("-d, --debug", "enable debugging").option("-e, --exclude [exclude...]", "files to exclude, matches a glob or array pattern").option("-i, --include [include...]", "files to include, matches a glob or array pattern").option("--isTesting", "enable testing").option("-o, --out <file>", "output file, otherwise, the file will be written to tsconfig.merged.json").option("--isTesting", "enable testing").option("-t, --isTestingCLI", "enable CLI only testing");
+).argument("[files...]", "files to check, matches an array pattern").option("-d, --debug", "enable debugging").option("-e, --exclude [exclude...]", "files to exclude, matches a glob or array pattern").option("-i, --include [include...]", "files to include, matches a glob or array pattern").option("--isTesting", "enable testing").option("-o, --out <file>", "output file, otherwise, the file will be written to tsconfig.merged.json").option("--isTesting", "enable testing").option("-t, --isTestingCLI", "enable CLI only testing").option("-p, --path <path>", 'a json parseable string wrapped object, e.g. {"item/*": ["foo": "bar"]}');
 Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name] })).forEach(({ name, value }) => {
   if (value === "boolean") {
     program.option(`--${name}`, `tsconfig.compilerOptions.${name}`);
@@ -223,6 +246,7 @@ export {
   mergeConfigContent,
   mergeConfigObjects,
   mergeTsConfigs,
+  parsePath,
   resolveJSON,
   script,
   updateCompilerOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merge-tsconfigs",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Merge-tsconfigs is a CLI and node tool for merging tsconfig files into the exact tsconfig file you want 🛣️",
   "type": "module",
   "module": "dist/index.js",
@@ -28,7 +28,7 @@
     "lint": "eslint src --ext .ts",
     "lint-fix": "pnpm run lint --fix",
     "pre-commit": "lint-staged",
-    "prepare": "husky install",
+    "prepare": "husky install && pnpm env use --global 18",
     "prepublishOnly": "pnpm run test && pnpm run build",
     "release": "release-it",
     "setup:config": "mkdir config && cd config npx tsc --init",
@@ -51,6 +51,7 @@
     "eslint-config-prettier": "^8.6.0",
     "husky": "^8.0.3",
     "lint-staged": "^13.1.0",
+    "pnpm": "^7.28.0",
     "prettier": "^2.8.3",
     "release-it": "^15.6.0",
     "rimraf": "^3.0.2",
@@ -109,10 +110,6 @@
       "commitMessage": "chore: release v$npm_package_version"
     }
   },
-  "engines": {
-    "node": ">=18.0.0",
-    "pnpm": ">=7.0.0"
-  },
   "keywords": [
     "tsconfig",
     "typescript",