merge-tsconfigs 0.1.0 → 0.1.2

package/README.md

@@ -2,6 +2,8 @@
 
 ![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript&label&labelColor=blue&color=555555)
 [![npm version](https://badge.fury.io/js/merge-tsconfigs.svg)](https://badge.fury.io/js/merge-tsconfigs)
+[![unpkg](https://img.shields.io/badge/unpkg-blue.svg)](https://unpkg.com/merge-tsconfigs@0.1.1/dist/index.js)
+[![skypack](https://img.shields.io/badge/skypack-blueviolet.svg)](https://cdn.skypack.dev/merge-tsconfigs?min)
 ![ci](https://github.com/yowainwright/merge-tsconfigs/actions/workflows/ci.yml/badge.svg)
 [![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)
@@ -10,6 +12,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)** | **[How do I start using this?](#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 +26,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.
@@ -43,7 +84,8 @@ Options:
   -e, --exclude [exclude...]  files to exclude, matches a glob or array pattern
   -h, --help                  display help for command
 ```
-\*compiler options are not added above for readability (but they can be leveraged). To view all cli options, run `merge-tsconfigs --help`!
+
+\*`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.
 
 #### Recipes
 
@@ -51,34 +93,84 @@ Merge tsconfig files into a single tsconfig
 
 ```sh
 merge-tsconfigs ./tsconfig.json ./tsconfig.build.json
-# => ./tsconfig.merged.json
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
 ```
 
 Merge tsconfig files a specific tsconfig file
 
 ```sh
 merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --out ./tsconfig.out.json
-# => ./tsconfig.out.json
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.out.json
 ```
 
 Merge tsconfig files with unique `include` and `exclude` strings
 
 ```sh
 merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --include 'src/**.ts' --exclude 'test/**.ts'
-# => ./tsconfig.merged.json
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
+```
+
+```ts
+// tsconfig.merged.json
+{
+  "compilerOptions": {
+    // ...options
+  },
+  "include": ["src/**.ts"],
+  "exclude": ["test/**.ts", "config/*.ts"]
+}
 ```
 
 Merge tsconfig files with unique `include` and `exclude` or by using arrays
 
 ```sh
 merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --include 'src/**.ts' --exclude 'test/**.ts' 'config/*.ts'
-# => ./tsconfig.merged.json
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
+```
+
+```ts
+// tsconfig.merged.json
+{
+  "compilerOptions": {
+    // ...options
+  },
+  "include": ["src/**.ts"],
+  "exclude": ["test/**.ts", "config/*.ts"]
+}
 ```
 
 Sprinkle in some `compilerOptions` to the mix
 
 ```sh
 merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --out ./tsconfig.out.json --allowJs true --noEmit true
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.out.json
+```
+
+```ts
+// tsconfig.out.json
+{
+  "compilerOptions": {
+    "allowJS": true,
+    "noEmit": true,
+  }
+}
+```
+
+Delete a compiler option
+
+```sh
+merge-tsconfigs ./tsconfig.json ./tsconfig.build.json --allowJS --noEmit 'delete'
+# ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
+```
+
+```ts
+// tsconfig.merged.json
+{
+  "compilerOptions": {
+    "allowJS": true,
+    // "noEmit": true, // deleted
+  }
+}
 ```
 
 ---
@@ -113,7 +205,7 @@ Merge tsconfig files into a single tsconfig
 const config = mergeTsconfigs({
   files: ['./tsconfig.json', './tsconfig.build.json'],
 });
-// => config = { ... }
+// ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.merged.json
 ```
 
 Merge tsconfig files into a custom output file
@@ -123,7 +215,7 @@ const config = mergeTsconfigs({
   files: ['./tsconfig.json', './tsconfig.build.json'],
   out: './new-dir/tsconfig.out.json',
 });
-// => config = { ... }
+// ./tsconfig.json + ./tsconfig.build.json => ./tsconfig.out.json
 ```
 
 ---
@@ -136,7 +228,7 @@ Install merge-tsconfigs with your preferred package manager.
 npm install merge-tsconfigs --save-dev
 ```
 
-\*unpkg and skypack support coming very soon! 🚀
+\*[unpkg](https://unpkg.com/merge-tsconfigs@0.1.1/dist/index.js) and [skypack](https://cdn.skypack.dev/merge-tsconfigs?min) support coming very soon! 🚀
 
 ---
 

package/dist/index.cjs

@@ -26,6 +26,7 @@ __export(src_exports, {
   mergeTsConfigs: () => mergeTsConfigs,
   resolveJSON: () => resolveJSON,
   script: () => script,
+  updateCompilerOptions: () => updateCompilerOptions,
   writeTsconfig: () => writeTsconfig
 });
 module.exports = __toCommonJS(src_exports);
@@ -69,11 +70,12 @@ function resolveJSON(path, debug = false) {
     return {};
   }
 }
-var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
-  let tsconfigJSON = resolveJSON(tsconfig, debug);
+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)(tsconfig), parentPath);
+    const relativeParentPath = (0, import_path.join)((0, import_path.dirname)(path), parentPath);
     const parentTsconfig = resolveJSON(relativeParentPath, debug);
     if (parentTsconfig?.extends) {
       logger({ isDebugging: debug })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
@@ -102,19 +104,34 @@ var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {
     }
   };
 }, {});
-var writeTsconfig = (tsconfig, out, isTesting) => {
+var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
   if (isTesting)
     return tsconfig;
-  const path = out.length ? out : "./tsconfig.merged.json";
+  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 updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
+  const compilerOptionKeys = compilerOptions2 ? Object.keys(compilerOptions2) : [];
+  const hasCompilerOptions = compilerOptionKeys.length > 0;
+  if (!hasCompilerOptions)
+    return {};
+  return compilerOptionKeys.reduce((acc = {}, key) => {
+    const updatedOptions = { ...acc, ...currentCompilerOptions };
+    const value = compilerOptions2?.[key];
+    if (updatedOptions?.[key] === "delete") {
+      delete updatedOptions[key];
+      return updatedOptions || {};
+    }
+    return { ...updatedOptions, [key]: value };
+  }, {});
+};
 var mergeTsConfigs = ({
   tsconfigs = [],
-  exclude = [],
-  include = [],
-  compilerOptions: compilerOptions2 = {},
+  exclude,
+  include,
+  compilerOptions: compilerOptions2,
   debug = false,
   out = "",
   isTesting = false
@@ -124,16 +141,20 @@ var mergeTsConfigs = ({
       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 updatedCompilerOptions = updateCompilerOptions(compilerOptions2, updatedTsconfig?.compilerOptions || {});
+  const updatedExclude = exclude ? [...updatedTsconfig?.exclude || [], ...exclude] : updatedTsconfig?.exclude;
+  const updatedInclude = include ? [...updatedTsconfig.include || [], ...include] : updatedTsconfig?.include;
   const tsconfig = {
     ...updatedTsconfig,
-    exclude: [...updatedTsconfig.exclude || [], ...exclude],
-    include: [...updatedTsconfig.include || [], ...include],
-    ...compilerOptions2
+    ...updatedExclude,
+    ...updatedInclude,
+    ...Object.keys(updatedCompilerOptions).length > 0 ? { compilerOptions: updatedCompilerOptions } : {}
   };
-  return writeTsconfig(tsconfig, out, isTesting);
+  return writeTsconfig(tsconfig, cwd, out, isTesting);
 };
 var script = mergeTsConfigs;
 var scripts_default = mergeTsConfigs;
@@ -206,6 +227,8 @@ Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name]
     import_commander.program.option(`--${name} <${value}>`, `tsconfig.compilerOptions.${name}`);
   } else if (value === "array") {
     import_commander.program.option(`--${name} [${value}...]`, `tsconfig.compilerOptions.${name}`);
+  } else if (value === "object") {
+    import_commander.program.option(`--${name} <${value}>`, `tsconfig.compilerOptions.${name}`);
   }
 });
 import_commander.program.action(action).parse(process.argv);
@@ -219,5 +242,6 @@ var src_default = scripts_default;
   mergeTsConfigs,
   resolveJSON,
   script,
+  updateCompilerOptions,
   writeTsconfig
 });

package/dist/index.d.ts

@@ -1,8 +1,12 @@
 import { CompilerOptions } from 'typescript';
 import { PartialDeep } from 'type-fest';
 
+interface CompilerOptionOverrides {
+    [key: string]: string | boolean | string[] | undefined;
+}
+type PartialCompilerOptions = PartialDeep<CompilerOptions | CompilerOptionOverrides>;
 interface ConfigOptions {
-    compilerOptions?: PartialDeep<CompilerOptions>;
+    compilerOptions?: PartialCompilerOptions;
     debug?: boolean;
     out?: string;
     tsconfigs?: string[];
@@ -18,16 +22,17 @@ 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, isTesting: boolean) => 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;
 
-export { mergeTsConfigs as default, logger, mergeConfigContent, mergeTsConfigs, resolveJSON, script, writeTsconfig };
+export { mergeTsConfigs as default, logger, mergeConfigContent, mergeTsConfigs, resolveJSON, script, updateCompilerOptions, writeTsconfig };

package/dist/index.js

@@ -37,11 +37,12 @@ function resolveJSON(path, debug = false) {
     return {};
   }
 }
-var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {}, tsconfig) => {
-  let tsconfigJSON = resolveJSON(tsconfig, debug);
+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(tsconfig), parentPath);
+    const relativeParentPath = join(dirname(path), parentPath);
     const parentTsconfig = resolveJSON(relativeParentPath, debug);
     if (parentTsconfig?.extends) {
       logger({ isDebugging: debug })("error")("mergeConfigContent")("Parent tsconfig:merge-tsconfigs only handles extending from a parent, consider extending tsconfigs less.")(parentTsconfig);
@@ -70,19 +71,34 @@ var mergeConfigContent = (tsconfigs, debug = false) => tsconfigs.reduce((acc = {
     }
   };
 }, {});
-var writeTsconfig = (tsconfig, out, isTesting) => {
+var writeTsconfig = (tsconfig, cwd, out, isTesting) => {
   if (isTesting)
     return tsconfig;
-  const path = out.length ? out : "./tsconfig.merged.json";
+  const path = out.length ? out : `${cwd}/tsconfig.merged.json`;
   mkdirSync(dirname(path), { recursive: true });
   writeFileSync(path, JSON.stringify(tsconfig, null, 2));
   return tsconfig;
 };
+var updateCompilerOptions = (compilerOptions2 = {}, currentCompilerOptions) => {
+  const compilerOptionKeys = compilerOptions2 ? Object.keys(compilerOptions2) : [];
+  const hasCompilerOptions = compilerOptionKeys.length > 0;
+  if (!hasCompilerOptions)
+    return {};
+  return compilerOptionKeys.reduce((acc = {}, key) => {
+    const updatedOptions = { ...acc, ...currentCompilerOptions };
+    const value = compilerOptions2?.[key];
+    if (updatedOptions?.[key] === "delete") {
+      delete updatedOptions[key];
+      return updatedOptions || {};
+    }
+    return { ...updatedOptions, [key]: value };
+  }, {});
+};
 var mergeTsConfigs = ({
   tsconfigs = [],
-  exclude = [],
-  include = [],
-  compilerOptions: compilerOptions2 = {},
+  exclude,
+  include,
+  compilerOptions: compilerOptions2,
   debug = false,
   out = "",
   isTesting = false
@@ -92,16 +108,20 @@ var mergeTsConfigs = ({
       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 updatedCompilerOptions = updateCompilerOptions(compilerOptions2, updatedTsconfig?.compilerOptions || {});
+  const updatedExclude = exclude ? [...updatedTsconfig?.exclude || [], ...exclude] : updatedTsconfig?.exclude;
+  const updatedInclude = include ? [...updatedTsconfig.include || [], ...include] : updatedTsconfig?.include;
   const tsconfig = {
     ...updatedTsconfig,
-    exclude: [...updatedTsconfig.exclude || [], ...exclude],
-    include: [...updatedTsconfig.include || [], ...include],
-    ...compilerOptions2
+    ...updatedExclude,
+    ...updatedInclude,
+    ...Object.keys(updatedCompilerOptions).length > 0 ? { compilerOptions: updatedCompilerOptions } : {}
   };
-  return writeTsconfig(tsconfig, out, isTesting);
+  return writeTsconfig(tsconfig, cwd, out, isTesting);
 };
 var script = mergeTsConfigs;
 var scripts_default = mergeTsConfigs;
@@ -174,6 +194,8 @@ Object.keys(compilerOptions).map((name) => ({ name, value: compilerOptions[name]
     program.option(`--${name} <${value}>`, `tsconfig.compilerOptions.${name}`);
   } else if (value === "array") {
     program.option(`--${name} [${value}...]`, `tsconfig.compilerOptions.${name}`);
+  } else if (value === "object") {
+    program.option(`--${name} <${value}>`, `tsconfig.compilerOptions.${name}`);
   }
 });
 program.action(action).parse(process.argv);
@@ -187,5 +209,6 @@ export {
   mergeTsConfigs,
   resolveJSON,
   script,
+  updateCompilerOptions,
   writeTsconfig
 };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "merge-tsconfigs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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",
   "types": "dist/index.d.ts",
+  "unpkg": "dist/index.js",
   "exports": {
     ".": {
       "import": "./dist/index.js",