@sklv-labs/ts-dev-configs 0.1.1 → 0.1.2

package/README.md

@@ -32,8 +32,8 @@ npm install --save-dev @eslint/js typescript-eslint globals eslint-config-pretti
 # For React preset
 npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks @vitejs/plugin-react
 
-# For NestJS preset
-npm install --save-dev @nestjs/eslint-plugin-nestjs
+# For NestJS preset (optional but recommended)
+npm install --save-dev @darraghor/eslint-plugin-nestjs-typed
 
 # For testing
 npm install --save-dev jest@^29.7.0 ts-jest@^29.2.0 @types/jest
@@ -61,10 +61,14 @@ The base preset includes configurations for TypeScript, ESLint, Prettier, Jest,
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
-  }
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }
 ```
 
+**Note:** Preset configs only define `compilerOptions`. You must define `include` and `exclude` in your project's `tsconfig.json`.
+
 #### ESLint Config (Flat Config - ESLint 9)
 
 ```js
@@ -131,10 +135,14 @@ The React preset extends the base preset with React-specific configurations.
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
-  }
+  },
+  "include": ["src/**/*", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules", "dist", "build"]
 }
 ```
 
+**Note:** Preset configs only define `compilerOptions`. You must define `include` and `exclude` in your project's `tsconfig.json`.
+
 #### ESLint Config (Flat Config - ESLint 9)
 
 ```js
@@ -170,10 +178,14 @@ The NestJS preset extends the base preset with NestJS-specific configurations.
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
-  }
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test"]
 }
 ```
 
+**Note:** Preset configs only define `compilerOptions`. You must define `include` and `exclude` in your project's `tsconfig.json`.
+
 #### ESLint Config (Flat Config - ESLint 9)
 
 ```js
@@ -190,6 +202,22 @@ export default nestjsEslint;
 module.exports = require('@sklv-labs/ts-dev-configs/presets/nestjs/jest.config.js');
 ```
 
+#### TypeScript Config for Tests
+
+```json
+// tsconfig.spec.json
+{
+  "extends": "@sklv-labs/ts-dev-configs/presets/nestjs/tsconfig.spec.json",
+  "compilerOptions": {
+    "rootDir": "./src"
+  },
+  "include": [
+    "src/**/*.spec.ts",
+    "src/**/*.test.ts"
+  ]
+}
+```
+
 ## Additional Configs
 
 ### Git Hooks
@@ -326,6 +354,69 @@ const viteBasePath = configs.build.vite;
     └── index.ts       # Main exports
 ```
 
+## Local Development with Yalc
+
+For local development and testing, this package uses [yalc](https://github.com/wclr/yalc) to link the package locally without publishing to npm.
+
+### Setup
+
+1. **In the `ts-dev-configs` package directory:**
+
+   ```bash
+   cd ts-dev-configs
+   npm install
+   ```
+
+2. **Publish to yalc local repository:**
+
+   ```bash
+   npm run yalc:publish
+   ```
+
+   Or force update if already published:
+
+   ```bash
+   npm run yalc:publish:force
+   ```
+
+3. **In your consuming project (e.g., `ts-nestjs-openapi`):**
+
+   ```bash
+   cd ../ts-nestjs-openapi
+   npm run yalc:link
+   ```
+
+   This will replace the npm version with the local yalc version.
+
+4. **Update when you make changes:**
+
+   In `ts-dev-configs`:
+   ```bash
+   npm run yalc:publish
+   ```
+
+   In the consuming project:
+   ```bash
+   npm run yalc:update
+   ```
+
+5. **Remove yalc link and restore npm version:**
+
+   ```bash
+   npm run yalc:remove
+   npm install
+   ```
+
+### Workflow
+
+1. Make changes to `ts-dev-configs`
+2. Run `npm run yalc:publish` in `ts-dev-configs`
+3. Run `npm run yalc:update` in consuming projects
+4. Test your changes
+5. Repeat as needed
+
+**Note:** After using yalc, remember to remove the link before committing changes to ensure the package.json doesn't reference the local yalc version.
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sklv-labs/ts-dev-configs",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "description": "Unified development configurations for TypeScript projects with support for React, NestJS, and more",
     "keywords": [
         "typescript",
@@ -29,11 +29,24 @@
         "./presets/base": "./presets/base/index.js",
         "./presets/react": "./presets/react/index.js",
         "./presets/nestjs": "./presets/nestjs/index.js",
+        "./presets/base/tsconfig.json": "./presets/base/tsconfig.json",
+        "./presets/react/tsconfig.json": "./presets/react/tsconfig.json",
+        "./presets/nestjs/tsconfig.json": "./presets/nestjs/tsconfig.json",
+        "./presets/nestjs/tsconfig.spec.json": "./presets/nestjs/tsconfig.spec.json",
+        "./presets/base/prettier.js": "./presets/base/prettier.js",
+        "./presets/base/jest.config.js": "./presets/base/jest.config.js",
+        "./presets/nestjs/jest.config.js": "./presets/nestjs/jest.config.js",
+        "./presets/base/vitest.config.ts": "./presets/base/vitest.config.ts",
+        "./presets/react/vite.config.ts": "./presets/react/vite.config.ts",
         "./eslint/base": "./presets/base/eslint.config.mjs",
         "./eslint/react": "./presets/react/eslint.config.mjs",
         "./eslint/nestjs": "./presets/nestjs/eslint.config.mjs",
         "./configs/git": "./configs/git/index.js",
+        "./configs/git/commitlint.js": "./configs/git/commitlint.js",
+        "./configs/git/lint-staged.js": "./configs/git/lint-staged.js",
         "./configs/build": "./configs/build/index.js",
+        "./configs/build/vite.base.ts": "./configs/build/vite.base.ts",
+        "./configs/build/webpack.base.js": "./configs/build/webpack.base.js",
         "./configs/editor": "./configs/editor/index.js"
     },
     "files": [
@@ -46,7 +59,9 @@
     "peerDependencies": {
         "typescript": "^5.9.0",
         "eslint": "^9.0.0",
-        "prettier": "^3.6.0"
+        "prettier": "^3.6.0",
+        "eslint-plugin-prettier": "^5.5.4",
+        "@darraghor/eslint-plugin-nestjs-typed": "^7.0.0"
     },
     "peerDependenciesMeta": {
         "typescript": {
@@ -57,19 +72,28 @@
         },
         "prettier": {
             "optional": false
+        },
+        "eslint-plugin-prettier": {
+            "optional": true
+        },
+        "@darraghor/eslint-plugin-nestjs-typed": {
+            "optional": true
         }
     },
     "devDependencies": {
         "@types/node": "^24.0.0",
         "typescript": "^5.9.2",
-        "vitest": "^4.0.7"
+        "vitest": "^4.0.7",
+        "yalc": "^1.0.0-pre.53"
     },
     "scripts": {
         "type-check": "tsc --noEmit",
         "prepublishOnly": "npm run type-check",
         "version:patch": "npm version patch && git push --follow-tags",
         "version:minor": "npm version minor && git push --follow-tags",
-        "version:major": "npm version major && git push --follow-tags"
+        "version:major": "npm version major && git push --follow-tags",
+        "yalc:publish": "yalc push",
+        "yalc:publish:force": "yalc push --force"
     },
     "engines": {
         "node": ">=24.0.0"

package/presets/base/tsconfig.json

@@ -26,9 +26,5 @@
         "isolatedModules": true,
         "allowSyntheticDefaultImports": true
     },
-    "exclude": [
-        "node_modules",
-        "dist",
-        "build"
-    ]
+    "files": []
 }

package/presets/nestjs/eslint.config.mjs

@@ -1,10 +1,12 @@
 import eslint from '@eslint/js';
 import { defineConfig } from 'eslint/config';
 import tseslint from 'typescript-eslint';
-import nestjsPlugin from '@nestjs/eslint-plugin-nestjs';
 import importPlugin from 'eslint-plugin-import-x';
 import globals from 'globals';
 import prettier from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+import eslintNestJs from '@darraghor/eslint-plugin-nestjs-typed';
 
 export default defineConfig([
     // Base recommended configs
@@ -12,6 +14,9 @@ export default defineConfig([
     ...tseslint.configs.recommended,
     ...tseslint.configs.recommendedTypeChecked,
 
+    // NestJS Typed plugin recommended rules
+    ...eslintNestJs.configs.flatRecommended,
+
     // Global ignores
     {
         ignores: ['dist/**', 'build/**', 'node_modules/**', '*.config.js', '*.config.ts', '*.config.mjs'],
@@ -35,8 +40,8 @@ export default defineConfig([
         },
         plugins: {
             '@typescript-eslint': tseslint.plugin,
-            '@nestjs': nestjsPlugin,
             'import-x': importPlugin,
+            prettier: prettierPlugin,
         },
         rules: {
             // TypeScript specific rules
@@ -50,14 +55,10 @@ export default defineConfig([
                     varsIgnorePattern: '^_',
                 },
             ],
-            '@typescript-eslint/prefer-const': 'error',
+            'prefer-const': 'error',
             '@typescript-eslint/no-non-null-assertion': 'warn',
             '@typescript-eslint/interface-name-prefix': 'off',
 
-            // NestJS specific rules
-            '@nestjs/use-validation-pipe': 'warn',
-            '@nestjs/use-pipes-decorator': 'warn',
-
             // General best practices
             'no-console': ['warn', { allow: ['warn', 'error'] }],
             'no-debugger': 'error',
@@ -90,6 +91,9 @@ export default defineConfig([
             ],
             'import-x/no-duplicates': 'error',
             'import-x/no-unresolved': 'off', // TypeScript handles this
+
+            // Prettier rules
+            'prettier/prettier': 'error',
         },
     },
 

package/presets/nestjs/jest.config.js

@@ -2,10 +2,19 @@ const baseJest = require('../base/jest.config.js');
 
 module.exports = {
   ...baseJest,
+  roots: ['<rootDir>/src'],
   moduleNameMapper: {
     '^src/(.*)$': '<rootDir>/src/$1',
   },
   testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.spec.json',
+      },
+    ],
+  },
   collectCoverageFrom: [
     'src/**/*.ts',
     '!src/**/*.d.ts',

package/presets/nestjs/tsconfig.json

@@ -24,13 +24,5 @@
         "forceConsistentCasingInFileNames": true,
         "noFallthroughCasesInSwitch": true
     },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules",
-        "dist",
-        "test",
-        "**/*spec.ts"
-    ]
+    "files": []
 }

package/presets/nestjs/tsconfig.spec.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "types": [
+            "jest",
+            "node"
+        ],
+        "noEmit": true
+    },
+    "include": [
+        "**/*.spec.ts",
+        "**/*.test.ts"
+    ],
+    "exclude": []
+}

package/presets/react/tsconfig.json

@@ -3,12 +3,17 @@
   "extends": "../base/tsconfig.json",
   "compilerOptions": {
     "jsx": "react-jsx",
-    "lib": ["ES2024", "DOM", "DOM.Iterable"],
+    "lib": [
+      "ES2024",
+      "DOM",
+      "DOM.Iterable"
+    ],
     "module": "ESNext",
     "moduleResolution": "bundler",
-    "types": ["vite/client"],
+    "types": [
+      "vite/client"
+    ],
     "rootDir": "./"
   },
-  "include": ["src/**/*", "**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules", "dist", "build"]
-}
+  "files": []
+}

package/configs/build/index.js

@@ -1,6 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  vite: path.resolve(__dirname, 'vite.base.ts'),
-  webpack: path.resolve(__dirname, 'webpack.base.js'),
-};

package/configs/build/vite.base.ts

@@ -1,35 +0,0 @@
-// @ts-nocheck - Template file for consuming projects, peer dependencies not installed here
-import { defineConfig } from 'vite';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig({
-  resolve: {
-    alias: {
-      '@': path.resolve(__dirname, '../../src'),
-    },
-  },
-  build: {
-    outDir: 'dist',
-    sourcemap: true,
-    minify: 'esbuild',
-    target: 'esnext',
-    rollupOptions: {
-      output: {
-        manualChunks: undefined,
-      },
-    },
-  },
-  server: {
-    port: 3000,
-    open: false,
-    cors: true,
-    strictPort: false,
-  },
-  preview: {
-    port: 3000,
-    strictPort: false,
-  },
-});

package/configs/build/webpack.base.js

@@ -1,27 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  entry: './src/index.ts',
-  output: {
-    path: path.resolve(__dirname, '../../dist'),
-    filename: 'bundle.js',
-    clean: true,
-  },
-  resolve: {
-    extensions: ['.ts', '.tsx', '.js', '.jsx'],
-    alias: {
-      '@': path.resolve(__dirname, '../../src'),
-    },
-  },
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        use: 'ts-loader',
-        exclude: /node_modules/,
-      },
-    ],
-  },
-  devtool: 'source-map',
-  mode: process.env.NODE_ENV || 'development',
-};

package/configs/git/husky/commit-msg

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no -- commitlint --edit ${1}

package/configs/git/husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged