@vfourny/node-toolkit 1.0.22 → 1.1.0

package/README.md

@@ -23,6 +23,23 @@ To install **VFourny's Node Toolkit** via npm, make sure you have [Node.js](http
 npm install -D @vfourny/node-toolkit
 ```
 
+### Peer Dependencies
+
+This package requires the following peer dependencies to be installed in your project:
+
+```bash
+npm install -D eslint prettier typescript commitlint semantic-release
+```
+
+**Minimum versions:**
+
+- Node.js: `>=20.13 <25`
+- ESLint: `^9.3.0`
+- Prettier: `^3.2.5`
+- TypeScript: `^5.5.2`
+- Commitlint: `^19.8.0 || ^20.1.0`
+- Semantic Release: `^24.0.0 || ^25.0.0`
+
 ## Environment Variables
 
 For `semantic-release` to work properly, certain environment variables must be defined in your GitHub repository configuration.
@@ -42,17 +59,103 @@ For `semantic-release` to work properly, certain environment variables must be d
 
 ### ESLint
 
-To import the ESLint configuration into your project, add the following code to your [ESLint](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file) configuration file:
+This package provides multiple ESLint configurations tailored for different project types. Choose the one that fits your project:
 
-```javascript
-import nodeToolkitEslintConfig from '@vfourny/node-toolkit/eslint'
+#### For Node.js Projects
 
-export default {
-  ...nodeToolkitEslintConfig,
-  // Your custom configurations
-}
+```typescript
+// eslint.config.ts
+import nodeConfig from '@vfourny/node-toolkit/eslint/node'
+
+export default nodeConfig
+```
+
+#### For Vue Projects
+
+```typescript
+// eslint.config.ts
+import vueConfig from '@vfourny/node-toolkit/eslint/vue'
+
+export default vueConfig
+```
+
+#### For Nuxt Projects
+
+```typescript
+// eslint.config.ts
+import nuxtConfig from '@vfourny/node-toolkit/eslint/nuxt'
+
+export default nuxtConfig
+```
+
+#### Default Import (Node.js)
+
+```typescript
+// eslint.config.ts
+import config from '@vfourny/node-toolkit/eslint'
+
+export default config
 ```
 
+#### Advanced Usage
+
+For advanced users who want to compose their own configuration:
+
+```typescript
+// eslint.config.ts
+import {
+  baseConfig,
+  nodeGlobalsConfig,
+  typescriptConfigs,
+  prettierConfig,
+} from '@vfourny/node-toolkit/eslint/base'
+import typescriptEslint from 'typescript-eslint'
+
+export default typescriptEslint.config(
+  ...typescriptConfigs,
+  nodeGlobalsConfig,
+  baseConfig,
+  // Your custom configs here
+  prettierConfig, // Should be last
+)
+```
+
+#### Configuration Rules Overview
+
+All ESLint configurations include the following enforced rules:
+
+**Code Quality:**
+
+- `eqeqeq`: Require `===` and `!==` instead of `==` and `!=`
+- `prefer-const`: Prefer `const` over `let` when variables are not reassigned
+- `no-console`: Disallow `console.log` statements (prevents debug code in production)
+- `no-debugger`: Disallow `debugger` statements
+- `no-var`: Require `let` or `const` instead of `var`
+
+**TypeScript:**
+
+- `@typescript-eslint/consistent-type-definitions`: Enforce `interface` over `type`
+- `@typescript-eslint/no-explicit-any`: Disallow `any` type (suggests `unknown` instead)
+- `@typescript-eslint/consistent-type-imports`: Enforce `import type` for type-only imports
+- `@typescript-eslint/no-unused-vars`: Disallow unused variables (except those prefixed with `_`)
+- `@typescript-eslint/naming-convention`: Enforce naming conventions (PascalCase for classes, camelCase for variables, etc.)
+
+**Import Rules:**
+
+- `no-restricted-imports`: **Disallow relative imports** - must use absolute imports with `@/` prefix
+- `import/no-default-export`: Disallow default exports (except in `*.config.{js,ts}` files)
+- `simple-import-sort/imports`: Auto-sort imports alphabetically
+- `simple-import-sort/exports`: Auto-sort exports alphabetically
+
+**Project-Specific:**
+
+- **Node.js**: Includes Node.js global variables (`process`, `__dirname`, etc.)
+- **Vue**: Includes Vue ESLint plugin rules, enforces PascalCase for component names in templates
+- **Nuxt**: Includes Vue rules + auto-import globals for Nuxt composables (`useRouter`, `useFetch`, etc.), allows single-word component names for pages
+
+**Import Resolution:**
+All configurations automatically resolve TypeScript path aliases (like `@/*`) using `eslint-import-resolver-typescript`.
+
 ### Prettier
 
 To import the Prettier configuration into your project, add the following code to your [Prettier](https://prettier.io/docs/en/configuration.html) configuration file:
@@ -74,11 +177,17 @@ To import the TypeScript configuration into your project, add the following code
 {
   "extends": "@vfourny/node-toolkit/tsconfig",
   "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
     // Your custom configurations
   }
 }
 ```
 
+**Important:** The `paths` configuration is required for the ESLint import resolver to work correctly with absolute imports using the `@/` prefix.
+
 ### Semantic Release
 
 To import the Semantic Release configuration into your project, add the following code to your [Semantic Release](https://semantic-release.gitbook.io/semantic-release) configuration file:

package/dist/configs/eslint/base.d.ts

@@ -0,0 +1,10 @@
+import type { Linter } from 'eslint';
+export declare const baseConfig: Linter.Config;
+export declare const commonIgnores: Linter.Config;
+export declare const configFilesOverride: Linter.Config;
+export declare const typescriptConfigs: ({
+    readonly rules: Readonly<Linter.RulesRecord>;
+} | import("node_modules/typescript-eslint/dist/compatibility-types").CompatibleConfig)[];
+export declare const prettierConfig: {
+    rules: Record<string, 0 | "off">;
+};

package/dist/configs/eslint/base.js

@@ -0,0 +1,105 @@
+import eslintJS from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import importPlugin from 'eslint-plugin-import';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import typescriptEslint from 'typescript-eslint';
+export const baseConfig = {
+    name: 'node-toolkit/base',
+    plugins: {
+        import: importPlugin,
+        'simple-import-sort': simpleImportSort,
+    },
+    settings: {
+        'import/resolver': {
+            typescript: {
+                alwaysTryTypes: true,
+            },
+        },
+    },
+    rules: {
+        eqeqeq: ['error', 'always'],
+        'prefer-const': ['error', { destructuring: 'all' }],
+        'no-useless-rename': 'error',
+        'no-useless-constructor': 'error',
+        'no-console': 'error',
+        'no-debugger': 'error',
+        'no-throw-literal': 'error',
+        'no-unused-expressions': 'error',
+        'no-var': 'error',
+        'no-redeclare': 'error',
+        'no-const-assign': 'error',
+        'no-restricted-imports': [
+            'error',
+            {
+                patterns: [
+                    {
+                        group: ['../*', './*'],
+                        message: 'Relative imports are not allowed. Use absolute imports instead with @/.',
+                    },
+                ],
+            },
+        ],
+        'sort-imports': 'off',
+        '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+        '@typescript-eslint/no-explicit-any': ['error', { fixToUnknown: true }],
+        '@typescript-eslint/consistent-type-imports': [
+            'error',
+            { prefer: 'type-imports' },
+        ],
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                argsIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+                caughtErrorsIgnorePattern: '^_',
+            },
+        ],
+        '@typescript-eslint/naming-convention': [
+            'error',
+            {
+                selector: 'import',
+                format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+            },
+            { selector: 'class', format: ['PascalCase'] },
+            {
+                selector: 'variable',
+                modifiers: ['const'],
+                format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+            },
+            {
+                selector: 'typeParameter',
+                format: ['PascalCase'],
+            },
+            { selector: 'enum', format: ['PascalCase'] },
+        ],
+        '@typescript-eslint/no-use-before-define': 'error',
+        '@typescript-eslint/no-inferrable-types': [
+            'error',
+            {
+                ignoreParameters: true,
+                ignoreProperties: true,
+            },
+        ],
+        '@typescript-eslint/no-unsafe-declaration-merging': 'error',
+        'import/no-default-export': 'error',
+        'import/no-named-as-default': 'error',
+        'import/no-named-as-default-member': 'error',
+        'import/no-namespace': 'error',
+        'simple-import-sort/imports': 'error',
+        'simple-import-sort/exports': 'error',
+    },
+};
+export const commonIgnores = {
+    ignores: ['node_modules', 'dist', '.nuxt', 'coverage', '.output', 'build'],
+};
+export const configFilesOverride = {
+    files: ['*.config.{js,ts}'],
+    rules: { 'import/no-default-export': 'off' },
+};
+export const typescriptConfigs = [
+    eslintJS.configs.recommended,
+    ...typescriptEslint.configs.recommended,
+    ...typescriptEslint.configs.strict,
+    ...typescriptEslint.configs.stylistic,
+];
+export const prettierConfig = eslintConfigPrettier;

package/dist/configs/eslint/index.d.ts

@@ -0,0 +1,5 @@
+export * from './base';
+export { default as nodeConfig } from './node';
+export { default as nuxtConfig } from './nuxt';
+export { default as vueConfig } from './vue';
+export { default } from './node';

package/dist/configs/eslint/index.js

@@ -0,0 +1,5 @@
+export * from './base';
+export { default as nodeConfig } from './node';
+export { default as nuxtConfig } from './nuxt';
+export { default as vueConfig } from './vue';
+export { default } from './node';

package/dist/configs/eslint/node.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+export declare const nodeGlobalsConfig: Linter.Config;
+declare const _default: import("typescript-eslint").FlatConfig.ConfigArray;
+export default _default;

package/dist/configs/eslint/node.js

@@ -0,0 +1,12 @@
+import globals from 'globals';
+import typescriptEslint from 'typescript-eslint';
+import { baseConfig, commonIgnores, configFilesOverride, prettierConfig, typescriptConfigs, } from './base';
+export const nodeGlobalsConfig = {
+    name: 'node-toolkit/node-globals',
+    languageOptions: {
+        globals: {
+            ...globals.node,
+        },
+    },
+};
+export default typescriptEslint.config(...typescriptConfigs, nodeGlobalsConfig, baseConfig, prettierConfig, configFilesOverride, commonIgnores);

package/dist/configs/eslint/nuxt.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("typescript-eslint").FlatConfig.ConfigArray;
+export default _default;

package/dist/configs/eslint/nuxt.js

@@ -0,0 +1,73 @@
+import typescriptEslint from 'typescript-eslint';
+import { baseConfig, commonIgnores, configFilesOverride, prettierConfig, typescriptConfigs, } from './base';
+import { nodeGlobalsConfig } from './node';
+import { vueFilesConfig } from './vue';
+const nuxtGlobals = {
+    name: 'node-toolkit/nuxt-globals',
+    languageOptions: {
+        globals: {
+            ref: 'readonly',
+            computed: 'readonly',
+            reactive: 'readonly',
+            readonly: 'readonly',
+            watch: 'readonly',
+            watchEffect: 'readonly',
+            toRef: 'readonly',
+            toRefs: 'readonly',
+            isRef: 'readonly',
+            unref: 'readonly',
+            shallowRef: 'readonly',
+            shallowReactive: 'readonly',
+            onMounted: 'readonly',
+            onBeforeMount: 'readonly',
+            onBeforeUnmount: 'readonly',
+            onUnmounted: 'readonly',
+            onUpdated: 'readonly',
+            onBeforeUpdate: 'readonly',
+            nextTick: 'readonly',
+            provide: 'readonly',
+            inject: 'readonly',
+            useRouter: 'readonly',
+            useRoute: 'readonly',
+            useFetch: 'readonly',
+            useAsyncData: 'readonly',
+            useLazyFetch: 'readonly',
+            useLazyAsyncData: 'readonly',
+            useState: 'readonly',
+            useCookie: 'readonly',
+            useRequestHeaders: 'readonly',
+            useRequestEvent: 'readonly',
+            useRuntimeConfig: 'readonly',
+            useAppConfig: 'readonly',
+            useHead: 'readonly',
+            useSeoMeta: 'readonly',
+            useNuxtApp: 'readonly',
+            useError: 'readonly',
+            navigateTo: 'readonly',
+            abortNavigation: 'readonly',
+            definePageMeta: 'readonly',
+            defineNuxtComponent: 'readonly',
+            defineNuxtPlugin: 'readonly',
+            defineNuxtRouteMiddleware: 'readonly',
+            createError: 'readonly',
+            showError: 'readonly',
+            clearError: 'readonly',
+            reloadNuxtApp: 'readonly',
+            refreshNuxtData: 'readonly',
+            callOnce: 'readonly',
+            prefetchComponents: 'readonly',
+            preloadComponents: 'readonly',
+            preloadRouteComponents: 'readonly',
+            addRouteMiddleware: 'readonly',
+            $fetch: 'readonly',
+        },
+    },
+};
+const nuxtVueOverride = {
+    name: 'node-toolkit/nuxt-vue-override',
+    files: ['**/*.vue'],
+    rules: {
+        'vue/multi-word-component-names': 'off',
+    },
+};
+export default typescriptEslint.config(...typescriptConfigs, nodeGlobalsConfig, nuxtGlobals, baseConfig, vueFilesConfig, nuxtVueOverride, prettierConfig, configFilesOverride, commonIgnores);

package/dist/configs/eslint/vue.d.ts

@@ -0,0 +1,4 @@
+import { type ConfigWithExtends } from 'typescript-eslint';
+export declare const vueFilesConfig: ConfigWithExtends;
+declare const _default: import("typescript-eslint").FlatConfig.ConfigArray;
+export default _default;

package/dist/configs/eslint/vue.js

@@ -0,0 +1,28 @@
+import eslintPluginVue from 'eslint-plugin-vue';
+import globals from 'globals';
+import typescriptEslint from 'typescript-eslint';
+import { baseConfig, commonIgnores, configFilesOverride, prettierConfig, typescriptConfigs, } from './base';
+import { nodeGlobalsConfig } from './node';
+export const vueFilesConfig = {
+    name: 'node-toolkit/vue',
+    extends: [...eslintPluginVue.configs['flat/recommended']],
+    files: ['**/*.vue'],
+    languageOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        globals: globals.browser,
+        parserOptions: {
+            parser: typescriptEslint.parser,
+        },
+    },
+    rules: {
+        'vue/component-name-in-template-casing': [
+            'error',
+            'PascalCase',
+            {
+                registeredComponentsOnly: false,
+            },
+        ],
+    },
+};
+export default typescriptEslint.config(...typescriptConfigs, nodeGlobalsConfig, baseConfig, vueFilesConfig, prettierConfig, configFilesOverride, commonIgnores);

package/dist/eslint.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+declare const _default: import("typescript-eslint").FlatConfig.ConfigArray;
 export default _default;

package/dist/eslint.config.js

@@ -1,124 +1,10 @@
-import eslintJS from '@eslint/js';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import importPlugin from 'eslint-plugin-import';
-import simpleImportSort from 'eslint-plugin-simple-import-sort';
-import eslintPluginVue from 'eslint-plugin-vue';
-import globals from 'globals';
-import tsEslint from 'typescript-eslint';
 import typescriptEslint from 'typescript-eslint';
-const vueFilesConfig = {
-    name: 'eslint-config-node-tools/vue',
-    extends: [...eslintPluginVue.configs['flat/recommended']],
-    files: ['**/*.{ts,vue}'],
-    languageOptions: {
-        ecmaVersion: 'latest',
-        sourceType: 'module',
-        globals: globals.browser,
-        parserOptions: {
-            parser: typescriptEslint.parser,
-        },
-    },
-    rules: {
-        'vue/component-name-in-template-casing': [
-            'error',
-            'PascalCase',
-            {
-                registeredComponentsOnly: false,
-            },
-        ],
-    },
-};
-const defaultConfig = {
-    name: 'eslint-config-node-tools/default',
-    languageOptions: {
-        globals: {
-            ...globals.node,
-        },
-    },
-    rules: {},
-};
-const customConfig = {
-    name: 'eslint-config-node-tools/custom-config',
-    plugins: {
-        import: importPlugin,
-        'simple-import-sort': simpleImportSort,
-    },
+import nodeConfig from './configs/eslint/node';
+const configsOverride = {
+    files: ['configs/**/*.ts', 'eslint.config.ts'],
     rules: {
-        eqeqeq: ['error', 'always'],
-        'prefer-const': ['error', { destructuring: 'all' }],
-        'no-useless-rename': 'error',
-        'no-useless-constructor': 'error',
-        'no-console': 'error',
-        'no-debugger': 'error',
-        'no-throw-literal': 'error',
-        'no-unused-expressions': 'error',
-        'no-var': 'error',
-        'no-redeclare': 'error',
-        'no-const-assign': 'error',
-        'no-restricted-imports': [
-            'error',
-            {
-                patterns: [
-                    {
-                        group: ['../*', './*'],
-                        message: 'Relative imports are not allowed. Use absolute imports instead with @/.',
-                    },
-                ],
-            },
-        ],
-        'sort-imports': 'off',
-        '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
-        '@typescript-eslint/no-explicit-any': ['error', { fixToUnknown: true }],
-        '@typescript-eslint/consistent-type-imports': [
-            'error',
-            { prefer: 'type-imports' },
-        ],
-        '@typescript-eslint/no-unused-vars': [
-            'error',
-            {
-                argsIgnorePattern: '^_',
-                varsIgnorePattern: '^_',
-                caughtErrorsIgnorePattern: '^_',
-            },
-        ],
-        '@typescript-eslint/naming-convention': [
-            'error',
-            {
-                selector: 'import',
-                format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
-            },
-            { selector: 'class', format: ['PascalCase'] },
-            {
-                selector: 'variable',
-                modifiers: ['const'],
-                format: ['camelCase', 'UPPER_CASE'],
-            },
-            {
-                selector: 'typeParameter',
-                format: ['PascalCase'],
-            },
-            { selector: 'enum', format: ['PascalCase'] },
-        ],
-        '@typescript-eslint/no-use-before-define': 'error',
-        '@typescript-eslint/no-inferrable-types': [
-            'error',
-            {
-                ignoreParameters: true,
-                ignoreProperties: true,
-            },
-        ],
-        '@typescript-eslint/no-unsafe-declaration-merging': 'error',
-        'import/no-default-export': 'error',
-        'import/no-named-as-default': 'error',
-        'import/no-named-as-default-member': 'error',
-        'import/no-namespace': 'error',
-        'simple-import-sort/imports': 'error',
-        'simple-import-sort/exports': 'error',
+        'no-restricted-imports': 'off',
+        'import/no-default-export': 'off',
     },
 };
-export default tsEslint.config(eslintJS.configs.recommended, tsEslint.configs.recommended, tsEslint.configs.strict, tsEslint.configs.stylistic, vueFilesConfig, defaultConfig, customConfig, eslintConfigPrettier, {
-    files: ['*.config.{js,ts}'],
-    rules: { 'import/no-default-export': 'off' },
-}, {
-    ignores: ['node_modules', 'dist', '.nuxt', 'coverage', '.output'],
-});
+export default typescriptEslint.config(...nodeConfig, configsOverride);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vfourny/node-toolkit",
-  "version": "1.0.22",
+  "version": "1.1.0",
   "description": "Toolkit for Node.js projects",
   "type": "module",
   "main": "dist/libs/index.js",
@@ -13,6 +13,10 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "type-check": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
     "prepare": "husky"
   },
   "files": [
@@ -21,8 +25,24 @@
   ],
   "exports": {
     "./eslint": {
-      "types": "./dist/eslint.config.d.ts",
-      "default": "./dist/eslint.config.js"
+      "types": "./dist/configs/eslint/index.d.ts",
+      "default": "./dist/configs/eslint/index.js"
+    },
+    "./eslint/base": {
+      "types": "./dist/configs/eslint/base.d.ts",
+      "default": "./dist/configs/eslint/base.js"
+    },
+    "./eslint/node": {
+      "types": "./dist/configs/eslint/node.d.ts",
+      "default": "./dist/configs/eslint/node.js"
+    },
+    "./eslint/vue": {
+      "types": "./dist/configs/eslint/vue.d.ts",
+      "default": "./dist/configs/eslint/vue.js"
+    },
+    "./eslint/nuxt": {
+      "types": "./dist/configs/eslint/nuxt.d.ts",
+      "default": "./dist/configs/eslint/nuxt.js"
     },
     "./prettier": {
       "types": "./dist/prettier.config.d.ts",
@@ -50,34 +70,37 @@
   "author": "Valentin Fourny",
   "license": "ISC",
   "dependencies": {
-    "@commitlint/config-angular": "^19.3.0",
+    "@commitlint/config-angular": "^20.2.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.0.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-vue": "^9.32.0",
-    "globals": "^15.3.0",
-    "typescript-eslint": "^8.0.0"
+    "eslint-plugin-vue": "^10.6.2",
+    "globals": "^16.5.0",
+    "typescript-eslint": "^8.50.0"
   },
   "devDependencies": {
-    "@commitlint/types": "^19.8.0",
-    "@eslint/js": "^9.4.0",
-    "@types/eslint__js": "^8.42.3",
+    "@commitlint/types": "^20.2.0",
+    "@eslint/js": "^9.39.2",
     "@types/eslint-config-prettier": "^6.11.3",
-    "@types/node": "^22.0.0",
-    "commitlint": "^19.8.0",
-    "eslint": "^9.3.0",
-    "husky": "^9.0.11",
-    "prettier": "^3.2.5",
-    "semantic-release": "^24.0.0",
-    "typescript": "^5.5.2"
+    "@types/node": "^25.0.3",
+    "@vitest/ui": "^4.0.16",
+    "commitlint": "^20.2.0",
+    "eslint": "^9.39.2",
+    "husky": "^9.1.7",
+    "prettier": "^3.7.4",
+    "semantic-release": "^25.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16",
+    "vue-eslint-parser": "^10.2.0"
   },
   "peerDependencies": {
-    "commitlint": "^19.8.0",
+    "commitlint": "^19.8.0 || ^20.1.0",
     "eslint": "^9.3.0",
     "prettier": "^3.2.5",
-    "semantic-release": "^24.0.0",
+    "semantic-release": "^24.0.0 || ^25.0.0",
     "typescript": "^5.5.2"
   },
   "repository": {
@@ -89,7 +112,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "engines": {
-    "node": ">=20.13 <23",
+    "node": ">=20.13 <25",
     "npm": ">= 10"
   }
 }