@langri-sha/projen-typescript-config 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@langri-sha/projen-typescript-config",
+  "entries": [
+    {
+      "date": "Tue, 14 May 2024 20:39:52 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-typescript-config_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-typescript-config",
+            "commit": "bb5eca0acea87c11cf873197bea7383eef3f8465",
+            "comment": "feat(typescript-config): Add support for managing TypeScript config files\""
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @langri-sha/projen-typescript-config
+
+This log was last generated on Tue, 14 May 2024 20:39:52 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Tue, 14 May 2024 20:39:52 GMT
+
+### Minor changes
+
+- feat(typescript-config): Add support for managing TypeScript config files" (filip.dupanovic@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,37 @@
+import type { JSONSchemaForTheTypeScriptCompilerSConfigurationFile } from '@schemastore/tsconfig';
+import { Component, Project } from 'projen';
+export interface TypeScriptConfigOptions {
+    config?: JSONSchemaForTheTypeScriptCompilerSConfigurationFile & {
+        /**
+         * Referenced projects. Requires TypeScript version 3.0 or later.
+         */
+        references?: {
+            /**
+             * Path to referenced tsconfig or to folder containing tsconfig.
+             */
+            path: string;
+        }[];
+    };
+    fileName?: string;
+}
+export declare class TypeScriptConfig extends Component {
+    #private;
+    constructor(project: Project, options: TypeScriptConfigOptions);
+    /**
+     * Appends to the list of filenames and patterns to exclude in the program.
+     */
+    addExclude(fileNameOrPattern: string): void;
+    /**
+     * Appends to the list of filenames and patterns to include in the program.
+     */
+    addInclude(fileNameOrPattern: string): void;
+    /**
+     * Appends to the list of filenames to include in the program.
+     */
+    addFile(fileName: string): void;
+    /**
+     * Adds a reference project.
+     */
+    addReference(path: string): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oDAAoD,EAAE,MAAM,uBAAuB,CAAA;AACjG,OAAO,EAAE,SAAS,EAAY,OAAO,EAAE,MAAM,QAAQ,CAAA;AAErD,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,oDAAoD,GAAG;QAC9D;;WAEG;QACH,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAA;SACb,EAAE,CAAA;KACJ,CAAA;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,qBAAa,gBAAiB,SAAQ,SAAS;;gBAIjC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,uBAAuB;IAmB9D;;OAEG;IACH,UAAU,CAAC,iBAAiB,EAAE,MAAM;IAIpC;;OAEG;IACH,UAAU,CAAC,iBAAiB,EAAE,MAAM;IAIpC;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM;IAIxB;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM;CAK1B"}

package/lib/index.js

@@ -0,0 +1,60 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _TypeScriptConfig_file, _TypeScriptConfig_options;
+import { Component, JsonFile } from 'projen';
+export class TypeScriptConfig extends Component {
+    constructor(project, options) {
+        const fileName = options.fileName ?? 'tsconfig.json';
+        super(project, fileName);
+        _TypeScriptConfig_file.set(this, void 0);
+        _TypeScriptConfig_options.set(this, void 0);
+        __classPrivateFieldSet(this, _TypeScriptConfig_options, {
+            config: options.config ?? {},
+            fileName,
+        }, "f");
+        __classPrivateFieldSet(this, _TypeScriptConfig_file, new JsonFile(this, 'tsconfig.json', {
+            allowComments: true,
+            obj: {
+                $schema: 'http://json.schemastore.org/tsconfig',
+                ...__classPrivateFieldGet(this, _TypeScriptConfig_options, "f").config,
+            },
+        }), "f");
+    }
+    /**
+     * Appends to the list of filenames and patterns to exclude in the program.
+     */
+    addExclude(fileNameOrPattern) {
+        __classPrivateFieldGet(this, _TypeScriptConfig_file, "f").addToArray('exclude', fileNameOrPattern);
+    }
+    /**
+     * Appends to the list of filenames and patterns to include in the program.
+     */
+    addInclude(fileNameOrPattern) {
+        __classPrivateFieldGet(this, _TypeScriptConfig_file, "f").addToArray('include', fileNameOrPattern);
+    }
+    /**
+     * Appends to the list of filenames to include in the program.
+     */
+    addFile(fileName) {
+        __classPrivateFieldGet(this, _TypeScriptConfig_file, "f").addToArray('files', fileName);
+    }
+    /**
+     * Adds a reference project.
+     */
+    addReference(path) {
+        __classPrivateFieldGet(this, _TypeScriptConfig_file, "f").addToArray('references', {
+            path,
+        });
+    }
+}
+_TypeScriptConfig_file = new WeakMap(), _TypeScriptConfig_options = new WeakMap();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAW,MAAM,QAAQ,CAAA;AAiBrD,MAAM,OAAO,gBAAiB,SAAQ,SAAS;IAI7C,YAAY,OAAgB,EAAE,OAAgC;QAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAA;QAEpD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QAN1B,yCAAe;QACf,4CAA2C;QAOzC,uBAAA,IAAI,6BAAY;YACd,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;YAC5B,QAAQ;SACT,MAAA,CAAA;QAED,uBAAA,IAAI,0BAAS,IAAI,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE;YAC/C,aAAa,EAAE,IAAI;YACnB,GAAG,EAAE;gBACH,OAAO,EAAE,sCAAsC;gBAC/C,GAAG,uBAAA,IAAI,iCAAS,CAAC,MAAM;aACxB;SACF,CAAC,MAAA,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,iBAAyB;QAClC,uBAAA,IAAI,8BAAM,CAAC,UAAU,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAA;IACrD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,iBAAyB;QAClC,uBAAA,IAAI,8BAAM,CAAC,UAAU,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAA;IACrD,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAgB;QACtB,uBAAA,IAAI,8BAAM,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC1C,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,IAAY;QACvB,uBAAA,IAAI,8BAAM,CAAC,UAAU,CAAC,YAAY,EAAE;YAClC,IAAI;SACL,CAAC,CAAA;IACJ,CAAC;CACF"}

package/license

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@langri-sha/projen-typescript-config",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf lib; tsc --project tsconfig.build.json"
+  },
+  "dependencies": {
+    "@schemastore/tsconfig": "0.0.11"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.7.1",
+    "@langri-sha/tsconfig": "0.9.0",
+    "@types/node": "20.12.11",
+    "projen": "0.81.10"
+  },
+  "peerDependencies": {
+    "projen": "^0.81.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "lib/index.d.ts"
+}

package/readme

@@ -0,0 +1,45 @@
+# @langri-sha/typescript-config
+
+A [projen] component for managing [TSConfig] files for [TypeScript] projects.
+
+Offers full support for configuring TypeScript via [`@schemastore/tsconfig`], as
+well as a handful of helpers that make it easy to maintain several TypeScript
+projects inside a monorepo.
+
+## Usage
+
+Install required dependencies:
+
+```sh
+npm install projen @langri-sha/typescript-config
+```
+
+Create a TypeScript configuration for your project:
+
+```sh
+import { Project } from 'projen'
+import { TypeScriptConfig } from '@langri-sha/typescript-config'
+
+const project = new Project({
+  name: 'test',
+})
+
+const tsconfig = new TypeScriptConfig(project)
+
+const tsconfigBuild = new TypeScriptConfig(project, {
+  fileName: 'tsconfig.build.json',
+  config: {
+    extends: ['tsconfig.json'],
+    compilerOptions: {
+      target: 'es2020',
+    },
+  }
+})
+
+project.synth()
+```
+
+[@schemastore/tsconfig]: https://github.com/schemastore/tsconfig
+[projen]: https://projen.io/
+[tsconfig]: https://www.typescriptlang.org/tsconfig.
+[typescript]: https://www.typescriptlang.org/

package/src/index.ts

@@ -0,0 +1,71 @@
+import type { JSONSchemaForTheTypeScriptCompilerSConfigurationFile } from '@schemastore/tsconfig'
+import { Component, JsonFile, Project } from 'projen'
+
+export interface TypeScriptConfigOptions {
+  config?: JSONSchemaForTheTypeScriptCompilerSConfigurationFile & {
+    /**
+     * Referenced projects. Requires TypeScript version 3.0 or later.
+     */
+    references?: {
+      /**
+       * Path to referenced tsconfig or to folder containing tsconfig.
+       */
+      path: string
+    }[]
+  }
+  fileName?: string
+}
+
+export class TypeScriptConfig extends Component {
+  #file: JsonFile
+  #options: Required<TypeScriptConfigOptions>
+
+  constructor(project: Project, options: TypeScriptConfigOptions) {
+    const fileName = options.fileName ?? 'tsconfig.json'
+
+    super(project, fileName)
+
+    this.#options = {
+      config: options.config ?? {},
+      fileName,
+    }
+
+    this.#file = new JsonFile(this, 'tsconfig.json', {
+      allowComments: true,
+      obj: {
+        $schema: 'http://json.schemastore.org/tsconfig',
+        ...this.#options.config,
+      },
+    })
+  }
+
+  /**
+   * Appends to the list of filenames and patterns to exclude in the program.
+   */
+  addExclude(fileNameOrPattern: string) {
+    this.#file.addToArray('exclude', fileNameOrPattern)
+  }
+
+  /**
+   * Appends to the list of filenames and patterns to include in the program.
+   */
+  addInclude(fileNameOrPattern: string) {
+    this.#file.addToArray('include', fileNameOrPattern)
+  }
+
+  /**
+   * Appends to the list of filenames to include in the program.
+   */
+  addFile(fileName: string) {
+    this.#file.addToArray('files', fileName)
+  }
+
+  /**
+   * Adds a reference project.
+   */
+  addReference(path: string) {
+    this.#file.addToArray('references', {
+      path,
+    })
+  }
+}