@ocavue/tsconfig 0.1.0

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [ocavue]

package/.github/actions/setup/action.yml

@@ -0,0 +1,26 @@
+name: Setup
+description: Setup the environment
+
+inputs:
+  node-version:
+    description: The version of node.js
+    required: false
+    default: '18'
+
+runs:
+  using: composite
+  steps:
+    - name: Install pnpm
+      run: corepack enable
+      shell: bash
+
+    - name: Setup node
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+        cache: pnpm
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install
+      run: pnpm install
+      shell: bash

package/.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release-please
+        with:
+          release-type: node
+    outputs:
+      release_created: ${{ steps.release-please.outputs.release_created }}
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [version]
+    if: ${{ needs.version.outputs.release_created }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Publish to NPM
+        run: pnpm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 0.1.0 (2024-12-28)
+
+
+### Features
+
+* add tsconfig files ([b133827](https://github.com/ocavue/tsconfig/commit/b133827c08a645b0b7663e1ce0b2460a6798b12d))
+* enable composite ([bcd2ae4](https://github.com/ocavue/tsconfig/commit/bcd2ae46c81fd6a32c6d027b3f8092e1361be26c))
+* refactor ([b8e7992](https://github.com/ocavue/tsconfig/commit/b8e79926cb144cfc1e136604e15dce6b8667d4e1))
+* use different outDir paths ([f9b6d1e](https://github.com/ocavue/tsconfig/commit/f9b6d1e97f491bfceb7b52e6e3713f1cbeb5a9d3))
+
+
+### Bug Fixes
+
+* fix exports in package.json ([8c1edb3](https://github.com/ocavue/tsconfig/commit/8c1edb3b9405c6e23c1af57695eb677f08fb1b81))
+* set rootDir in tsc.json ([686e434](https://github.com/ocavue/tsconfig/commit/686e434dea0f6ee5a6e42855aa3d0a92cf3d24bc))
+
+
+### Miscellaneous Chores
+
+* trigger release ([2ff890b](https://github.com/ocavue/tsconfig/commit/2ff890bc7d3d070d9414895b2696a1647a302b00))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ocavue
+
+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/README.md

@@ -0,0 +1,137 @@
+# @ocavue/tsconfig
+
+[![NPM version](https://img.shields.io/npm/v/@ocavue/tsconfig?color=a1b858&label=)](https://www.npmjs.com/package/@ocavue/tsconfig)
+
+## Installation
+
+```bash
+npm install @ocavue/tsconfig
+```
+
+## Usage
+
+### Application
+
+If you are building an application, create a `tsconfig.json` in the root of your project.
+
+```
+my-app/
+├── node_modules/
+├── components/
+│   └── button.ts
+├── pages/
+│   └── home.ts
+├── eslint.config.js
+├── vitest.config.ts
+├── package.json
+└── tsconfig.json
+```
+
+In `tsconfig.json`, add the following content based on your target environment.
+
+```jsonc
+// tsconfig.json
+{
+  // If you're building for the browser:
+  "extends": "@ocavue/tsconfig/dom/app",
+
+  // If you're building for non-browser environment:
+  "extends": "@ocavue/tsconfig/es/app"
+}
+```
+
+### Library
+
+If you are building a library, put all your source code in the `src` directory, and create `tsconfig.json` and `tsconfig.build.json` in the root of your project.
+
+```
+my-lib/
+├── dist/
+│   └── index.js
+├── src/
+│   └── index.ts
+├── eslint.config.js
+├── vitest.config.ts
+├── package.json
+├── tsconfig.build.json
+└── tsconfig.json
+```
+
+In `tsconfig.json`, add the following content:
+
+```jsonc
+// tsconfig.json
+{
+  "extends": "@ocavue/tsconfig/es/root",
+  "references": [{ "path": "./tsconfig.build.json" }]
+}
+```
+
+In `tsconfig.build.json`, add the following content based on your build tool and your target environment.
+
+```jsonc
+// tsconfig.build.json
+{
+  // If you're building for the browser and using a bundler like esbuild, vite, tsup etc:
+  "extends": "@ocavue/tsconfig/dom/build-bundler",
+
+  // If you're building for the browser and using tsc:
+  "extends": "@ocavue/tsconfig/dom/build-tsc",
+
+  // If you're building for non-browser environment and using a bundler like esbuild, vite, tsup etc:
+  "extends": "@ocavue/tsconfig/es/build-bundler",
+
+  // If you're building for non-browser environment and using tsc:
+  "extends": "@ocavue/tsconfig/es/build-tsc"
+}
+```
+
+### Monorepo
+
+If you are using a monorepo that might have multiple packages and applications, you should have a file structure like this:
+
+```
+my-monorepo/
+├── node_modules/
+├── packages/
+│   └── my-lib/
+│       ├── src/
+│       ├── dist/
+│       ├── vitest.config.ts
+│       ├── package.json
+│       └── tsconfig.json
+├── apps/
+│   └── my-app/
+│       ├── pages/
+│       ├── components/
+│       ├── vitest.config.ts
+│       ├── package.json
+│       ├── tsconfig.build.json
+│       └── tsconfig.json
+├── eslint.config.js
+├── package.json
+└── tsconfig.json
+```
+
+In the root `tsconfig.json`, add the following content:
+
+```jsonc
+// tsconfig.json
+{
+  "extends": "@ocavue/tsconfig/es/root",
+  "references": [
+    { "path": "./apps/my-app/tsconfig.json" },
+    { "path": "./packages/my-lib/tsconfig.json" }
+  ]
+}
+```
+
+Configure each package and application's `tsconfig.json` based on the instructions above.
+
+## Version Requirements
+
+The [`${configDir}`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-5.html#the-configdir-template-variable-for-configuration-files) template variable is used so you need to install TypeScript v5.5 or higher.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@ocavue/tsconfig",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "A collection of reusable TypeScript configurations",
+  "author": "ocavue <ocavue@gmail.com>",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/ocavue",
+  "homepage": "https://github.com/ocavue/tsconfig#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ocavue/tsconfig.git"
+  },
+  "bugs": "https://github.com/ocavue/tsconfig/issues",
+  "keywords": [
+    "tsconfig",
+    "typescript",
+    "config"
+  ],
+  "exports": {
+    "./es/app": "./src/es/app.json",
+    "./es/build-bundler": "./src/es/build-bundler.json",
+    "./es/build-tsc": "./src/es/build-tsc.json",
+    "./es/root": "./src/es/root.json",
+    "./dom/app": "./src/dom/app.json",
+    "./dom/build-bundler": "./src/dom/build-bundler.json",
+    "./dom/build-tsc": "./src/dom/build-tsc.json",
+    "./dom/root": "./src/dom/root.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/dom/app.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": [
+        "../es/app.json",
+        "../shared/dom.json",
+    ]
+}

package/src/dom/build-bundler.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": [
+        "../es/build-bundler.json",
+        "../shared/dom.json",
+    ]
+}

package/src/dom/build-tsc.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": [
+        "../es/build-tsc.json",
+        "../shared/dom.json",
+    ]
+}

package/src/dom/root.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": [
+        "../es/root.json",
+        "../shared/dom.json",
+    ]
+}

package/src/es/app.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "outDir": "${configDir}/node_modules/.cache/ocavue-tsconfig/app",
+        "tsBuildInfoFile": "${configDir}/node_modules/.cache/ocavue-tsconfig/app/tsconfig.tsbuildinfo"
+    },
+    "extends": [
+        "../shared/base.json",
+        "../include/all.json",
+        "../module/bundler.json",
+    ]
+}

package/src/es/build-bundler.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "outDir": "${configDir}/node_modules/.cache/ocavue-tsconfig/build-bundler",
+        "tsBuildInfoFile": "${configDir}/node_modules/.cache/ocavue-tsconfig/build-bundler/tsconfig.tsbuildinfo"
+    },
+    "extends": [
+        "../shared/base.json",
+        "../include/src.json",
+        "../module/bundler.json",
+    ]
+}

package/src/es/build-tsc.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "outDir": "${configDir}/dist",
+        "tsBuildInfoFile": "${configDir}/dist/tsconfig.tsbuildinfo"
+    },
+    "extends": [
+        "../shared/base.json",
+        "../include/src.json",
+        "../module/node.json",
+    ]
+}

package/src/es/root.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "outDir": "${configDir}/node_modules/.cache/ocavue-tsconfig/root",
+        "tsBuildInfoFile": "${configDir}/node_modules/.cache/ocavue-tsconfig/root/tsconfig.tsbuildinfo"
+    },
+    "extends": [
+        "../shared/base.json",
+        "../include/root.json",
+        "../module/bundler.json",
+    ]
+}

package/src/include/all.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "include": [
+        "${configDir}/**/*"
+    ]
+}

package/src/include/root.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "include": [
+        "${configDir}/*"
+    ]
+}

package/src/include/src.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "include": [
+        "${configDir}/src/**/*"
+    ]
+}

package/src/module/bundler.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "module": "preserve",
+        "moduleResolution": "bundler",
+        "emitDeclarationOnly": true,
+    }
+}

package/src/module/node.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+    }
+}

package/src/shared/base.json

@@ -0,0 +1,43 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "target": "ES2020",
+        "lib": [
+            "ESNext",
+            "ESNext.AsyncIterable"
+        ],
+        // Enable all strict type-checking options.
+        "strict": true,
+        // Disable unused local variables.
+        "noUnusedLocals": true,
+        // Force you to use `override` keyword when overriding a method.
+        "noImplicitOverride": true,
+        // Disable fallthrough cases in switch statements.
+        "noFallthroughCasesInSwitch": true,
+        // Emit additional JavaScript to ease support for importing CommonJS
+        // modules. This is necessary for some libraries with CommonJS/AMD/UMD
+        // modules.
+        "esModuleInterop": true,
+        // Skip type checking all .d.ts files. This improves performance and
+        // reduces the number of errors that you cannot fix directly.
+        "skipLibCheck": true,
+        // Allow JavaScript files to be included in the project.
+        "allowJs": true,
+        // Allow JSON files to be imported as modules.
+        "resolveJsonModule": true,
+        // Force TypeScript to consider all files as modules. This helps to avoid
+        // ['cannot redeclare block-scoped variable'](https://www.totaltypescript.com/cannot-redeclare-block-scoped-variable)
+        // errors.
+        "moduleDetection": "force",
+        // Prevents a few TS features which are unsafe when treating modules as
+        // isolated files.
+        "isolatedModules": true,
+        // Force you to use import type and export type
+        "verbatimModuleSyntax": true,
+        // Ensure that casing is correct in imports.
+        "forceConsistentCasingInFileNames": true,
+        // Allow TypeScript to cache build information and skip compilation
+        // when no changes are detected.
+        "composite": true,
+    }
+}

package/src/shared/dom.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "lib": [
+            "ESNext",
+            "ESNext.AsyncIterable",
+            "DOM",
+            "DOM.Iterable",
+            "DOM.AsyncIterable"
+        ],
+    }
+}