merge-tsconfigs 0.0.7 → 0.1.1

package/README.md

@@ -10,6 +10,10 @@ _Merge-tsconfigs_ is a CLI and node tool for merging tsconfig files into the exa
 
 ---
 
+**[Why do I want this?](#why-do-i-want-this)** | **[Example](#for-example)** | **[How do I use this?](#how-do-i-use-this)** | **[CLI API](#cli-api)** | **[Node API](#node-api)** | **[Install](#how-do-i-start-using-this)**
+
+---
+
 ## Why do I want this?
 
 Tsconfig files are copied, pasted, or left as out-of-sync widows 😥 throughout projects. _Merge-tsconfigs_ provides a CLI and node functions to merge tsconfigs files and compilerOptions into _the single tsconfig file you want at a given time_.
@@ -20,6 +24,41 @@ By providing an easy way to create the tsconfig you want, your everyday tsconfig
 
 ---
 
+### _For example_
+
+By running `merge-tsconfigs ./tsconfig.build.json` you'll merge `tsconfig.json`
+```ts
+{
+  "compilerOptions": {
+    "allowJS": true
+  }
+}
+```
+
+and, `tsconfig.build.json`
+```ts
+{
+  "compilerOptions": {
+    "target": "esnext"
+  },
+  "extends": "./tsconfig.json"
+}
+```
+
+into `tsconfig.merged.json`
+```ts
+{
+  "compilerOptions": {
+    "allowJS": true,
+    "target": "esnext"
+  }
+}
+```
+
+Which you can now use for deployment, dockerfiles, or any other use case. And, you don't have to worry about copying, pasting, or keeping track of multiple tsconfigs! 🎉
+
+---
+
 ## How do I use this?
 
 Merge-tsconfigs is built to be uses as a CLI first and foremost. It also exports node functions which can be used to preform the same merge operation.

package/dist/index.cjs

@@ -63,21 +63,30 @@ function resolveJSON(path, debug = false) {
     const json = JSON.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 {};
   }
 }
-var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
-  let tsconfigJSON = resolveJSON(tsconfig, true);
-  if (tsconfigJSON?.extends) {
-    const parentTsconfig = resolveJSON(tsconfigJSON.extends, true);
+var mergeConfigContent = (tsconfigs, cwd, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
+  const path = `${cwd}/${tsconfig}`;
+  let tsconfigJSON = resolveJSON(path, debug);
+  const parentPath = tsconfigJSON?.extends;
+  if (parentPath) {
+    const relativeParentPath = (0, import_path.join)((0, import_path.dirname)(path), parentPath);
+    const parentTsconfig = resolveJSON(relativeParentPath, debug);
     if (parentTsconfig?.extends) {
-      logger({ isDebugging: false })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
+      logger({ isDebugging: debug })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
     }
+    const { extends: _, ...tsconfigWithoutExtends } = tsconfigJSON;
     tsconfigJSON = {
       ...parentTsconfig,
-      ...tsconfigJSON
+      ...tsconfigWithoutExtends,
+      compilerOptions: {
+        ...parentTsconfig?.compilerOptions,
+        ...tsconfigWithoutExtends?.compilerOptions
+      }
     };
   }
   if (!tsconfigJSON) {
@@ -87,38 +96,49 @@ var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {
   }
   return {
     ...acc,
-    ...tsconfigJSON
+    ...tsconfigJSON,
+    compilerOptions: {
+      ...acc?.compilerOptions,
+      ...tsconfigJSON?.compilerOptions
+    }
   };
 }, {});
-var writeTsconfig = (tsconfig, out) => {
-  const path = out.length ? out : "./tsconfig.merged.json";
+var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
+  if (isTesting)
+    return tsconfig;
+  const path = out.length ? out : `${cwd}/tsconfig.merged.json`;
   (0, import_fs.mkdirSync)((0, import_path.dirname)(path), { recursive: true });
   (0, import_fs.writeFileSync)(path, JSON.stringify(tsconfig, null, 2));
   return tsconfig;
 };
 var mergeTsConfigs = ({
   tsconfigs = [],
-  exclude = [],
-  include = [],
-  compilerOptions: compilerOptions2 = {},
+  exclude,
+  include,
+  compilerOptions: compilerOptions2,
   debug = false,
-  out = ""
+  out = "",
+  isTesting = false
 }) => {
   if (tsconfigs.length === 0) {
     if (debug)
       logger({ isDebugging: debug })("error")("mergeTsConfig")("No tsconfig files were provided.")(null);
     return;
   }
-  const updatedTsconfig = mergeConfigContent(tsconfigs, debug);
+  const cwd = process.cwd();
+  const updatedTsconfig = mergeConfigContent(tsconfigs, cwd, debug);
   if (debug)
     logger({ isDebugging: debug })("debug")("mergeTsConfig")("Updated tsconfig:")(updatedTsconfig);
   const tsconfig = {
     ...updatedTsconfig,
-    exclude: [...updatedTsconfig.exclude || [], ...exclude],
-    include: [...updatedTsconfig.include || [], ...include],
-    ...compilerOptions2
+    ...exclude ? [...updatedTsconfig?.exclude || [], ...exclude] : updatedTsconfig?.exclude,
+    ...include ? [...updatedTsconfig.include || [], ...include] : updatedTsconfig?.include,
+    compilerOptions: {
+      ...updatedTsconfig?.compilerOptions,
+      ...compilerOptions2
+    }
   };
-  return writeTsconfig(tsconfig, out);
+  return writeTsconfig(tsconfig, cwd, out, isTesting);
 };
 var script = mergeTsConfigs;
 var scripts_default = mergeTsConfigs;
@@ -183,7 +203,7 @@ async function action(files, options = {}) {
 }
 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("-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");
 Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name] })).forEach(({ name, value }) => {
   if (value === "boolean") {
     import_commander.program.option(`--${name}`, `tsconfig.compilerOptions.${name}`);

package/dist/index.d.ts

@@ -8,6 +8,7 @@ interface ConfigOptions {
     tsconfigs?: string[];
     exclude?: string[];
     include?: string[];
+    isTesting?: boolean;
 }
 type LoggerParams = {
     isDebugging?: boolean;
@@ -17,16 +18,16 @@ type LoggerParams = {
 };
 interface TsConfig {
     extends?: string;
-    compilerOptions?: CompilerOptions;
+    compilerOptions?: PartialDeep<CompilerOptions>;
     include?: string[];
     exclude?: string[];
 }
 
 declare const logger: ({ isDebugging, emoji, gap, name }: LoggerParams) => (type: string) => (section: string) => (message: string) => (err: unknown) => void;
 declare function resolveJSON(path: string, debug?: boolean): TsConfig;
-declare const mergeConfigContent: (tsconfigs: string[], debug?: boolean) => TsConfig;
-declare const writeTsconfig: (tsconfig: TsConfig, out: string) => TsConfig;
-declare const mergeTsConfigs: ({ tsconfigs, exclude, include, compilerOptions, debug, out, }: ConfigOptions) => TsConfig | undefined;
-declare const script: ({ tsconfigs, exclude, include, compilerOptions, debug, out, }: ConfigOptions) => TsConfig | undefined;
+declare const mergeConfigContent: (tsconfigs: string[], cwd: string, debug?: boolean) => TsConfig;
+declare const writeTsconfig: (tsconfig: TsConfig, cwd: string, out: string, isTesting: boolean) => TsConfig;
+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;
 
 export { mergeTsConfigs as default, logger, mergeConfigContent, mergeTsConfigs, resolveJSON, script, writeTsconfig };

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/scripts.ts
 import { mkdirSync, readFileSync, writeFileSync } from "fs";
-import { dirname } from "path";
+import { dirname, join } from "path";
 var logger = ({ isDebugging = false, emoji = `\u{1F6E3}\uFE0F`, gap = ` => `, name = "merge-tsconfigs" }) => (type) => (section) => (message) => (err) => {
   const debugMsg = isDebugging ? "debugging:" : "";
   const sectionMsg = section.length ? `${section}:` : "";
@@ -31,21 +31,30 @@ function resolveJSON(path, debug = false) {
     const json = JSON.parse(readFileSync(path, "utf8"));
     return json;
   } catch (err) {
+    console.log({ err });
     if (debug)
       logger({ isDebugging: debug })("error")("resolveJSON")("There was an error:")(err);
     return {};
   }
 }
-var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
-  let tsconfigJSON = resolveJSON(tsconfig, true);
-  if (tsconfigJSON?.extends) {
-    const parentTsconfig = resolveJSON(tsconfigJSON.extends, true);
+var mergeConfigContent = (tsconfigs, cwd, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
+  const path = `${cwd}/${tsconfig}`;
+  let tsconfigJSON = resolveJSON(path, debug);
+  const parentPath = tsconfigJSON?.extends;
+  if (parentPath) {
+    const relativeParentPath = join(dirname(path), parentPath);
+    const parentTsconfig = resolveJSON(relativeParentPath, debug);
     if (parentTsconfig?.extends) {
-      logger({ isDebugging: false })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
+      logger({ isDebugging: debug })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
     }
+    const { extends: _, ...tsconfigWithoutExtends } = tsconfigJSON;
     tsconfigJSON = {
       ...parentTsconfig,
-      ...tsconfigJSON
+      ...tsconfigWithoutExtends,
+      compilerOptions: {
+        ...parentTsconfig?.compilerOptions,
+        ...tsconfigWithoutExtends?.compilerOptions
+      }
     };
   }
   if (!tsconfigJSON) {
@@ -55,38 +64,49 @@ var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {
   }
   return {
     ...acc,
-    ...tsconfigJSON
+    ...tsconfigJSON,
+    compilerOptions: {
+      ...acc?.compilerOptions,
+      ...tsconfigJSON?.compilerOptions
+    }
   };
 }, {});
-var writeTsconfig = (tsconfig, out) => {
-  const path = out.length ? out : "./tsconfig.merged.json";
+var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
+  if (isTesting)
+    return tsconfig;
+  const path = out.length ? out : `${cwd}/tsconfig.merged.json`;
   mkdirSync(dirname(path), { recursive: true });
   writeFileSync(path, JSON.stringify(tsconfig, null, 2));
   return tsconfig;
 };
 var mergeTsConfigs = ({
   tsconfigs = [],
-  exclude = [],
-  include = [],
-  compilerOptions: compilerOptions2 = {},
+  exclude,
+  include,
+  compilerOptions: compilerOptions2,
   debug = false,
-  out = ""
+  out = "",
+  isTesting = false
 }) => {
   if (tsconfigs.length === 0) {
     if (debug)
       logger({ isDebugging: debug })("error")("mergeTsConfig")("No tsconfig files were provided.")(null);
     return;
   }
-  const updatedTsconfig = mergeConfigContent(tsconfigs, debug);
+  const cwd = process.cwd();
+  const updatedTsconfig = mergeConfigContent(tsconfigs, cwd, debug);
   if (debug)
     logger({ isDebugging: debug })("debug")("mergeTsConfig")("Updated tsconfig:")(updatedTsconfig);
   const tsconfig = {
     ...updatedTsconfig,
-    exclude: [...updatedTsconfig.exclude || [], ...exclude],
-    include: [...updatedTsconfig.include || [], ...include],
-    ...compilerOptions2
+    ...exclude ? [...updatedTsconfig?.exclude || [], ...exclude] : updatedTsconfig?.exclude,
+    ...include ? [...updatedTsconfig.include || [], ...include] : updatedTsconfig?.include,
+    compilerOptions: {
+      ...updatedTsconfig?.compilerOptions,
+      ...compilerOptions2
+    }
   };
-  return writeTsconfig(tsconfig, out);
+  return writeTsconfig(tsconfig, cwd, out, isTesting);
 };
 var script = mergeTsConfigs;
 var scripts_default = mergeTsConfigs;
@@ -151,7 +171,7 @@ async function action(files, options = {}) {
 }
 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("-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");
 Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name] })).forEach(({ name, value }) => {
   if (value === "boolean") {
     program.option(`--${name}`, `tsconfig.compilerOptions.${name}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merge-tsconfigs",
-  "version": "0.0.7",
+  "version": "0.1.1",
   "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",