@rovik/eslint 1.1.0 → 1.1.1

package/README.md

@@ -0,0 +1,198 @@
+# @rovik/eslint
+
+Shared ESLint and Prettier configuration for Vue and NestJS projects.
+
+## Installation
+
+```bash
+npm install @rovik/eslint --save-dev
+```
+
+### Peer Dependencies
+
+```bash
+npm install eslint typescript --save-dev
+```
+
+For Vue projects:
+```bash
+npm install vue --save-dev
+```
+
+## Usage
+
+### Vue Projects
+
+Create `eslint.config.js` in your project root:
+
+```js
+import { defineEslintVue } from '@rovik/eslint/vue'
+
+export default defineEslintVue()
+```
+
+With custom options:
+
+```js
+import { defineEslintVue } from '@rovik/eslint/vue'
+
+export default defineEslintVue({
+  ignores: ['**/generated/**', '**/dist/**'],
+  overrides: [
+    {
+      files: ['**/*.test.ts'],
+      rules: {
+        'max-lines': 'off'
+      }
+    }
+  ]
+})
+```
+
+### NestJS / Node.js Projects
+
+Create `eslint.config.js` in your project root:
+
+```js
+import { defineEslintNode } from '@rovik/eslint/node'
+
+export default defineEslintNode()
+```
+
+With custom options:
+
+```js
+import { defineEslintNode } from '@rovik/eslint/node'
+
+export default defineEslintNode({
+  nestjs: true, // Enable NestJS-specific rules (default: true)
+  ignores: ['**/generated/**'],
+  overrides: [
+    {
+      files: ['**/*.e2e-spec.ts'],
+      rules: {
+        'max-lines-per-function': 'off'
+      }
+    }
+  ]
+})
+```
+
+The `nestjs: true` option automatically adds overrides for:
+- `*.dto.ts` files - relaxed indent rules
+- `*.entity.ts` files - relaxed indent rules
+- `*.types.ts`, `*.interface.ts` files - allows namespaces
+- `*.spec.ts`, `*.test.ts`, `*.e2e-spec.ts` files - relaxed complexity rules
+
+### Prettier Configuration
+
+Create `prettier.config.js` in your project root:
+
+```js
+import { prettierConfig } from '@rovik/eslint'
+
+export default prettierConfig
+```
+
+With customization:
+
+```js
+import { definePrettier } from '@rovik/eslint'
+
+export default definePrettier({
+  printWidth: 120,
+  semi: true
+})
+```
+
+Default Prettier config:
+
+```json
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "auto"
+}
+```
+
+## Package Scripts
+
+Add these scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"src/**/*.{ts,vue}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,vue}\""
+  }
+}
+```
+
+## Importing Individual Rules
+
+You can import individual rule sets for custom configurations:
+
+```js
+import {
+  bestPracticesRules,
+  complexityRules,
+  formattingRules,
+  stylisticRules,
+  typescriptRules,
+  vueRules,
+  importRules,
+  unusedImportsRules
+} from '@rovik/eslint'
+```
+
+For Node.js specific rules:
+
+```js
+import {
+  nodeComplexityRules,
+  nodeImportRules,
+  nodeSimpleImportSortRules
+} from '@rovik/eslint'
+```
+
+## TypeScript Configuration
+
+Ensure your `tsconfig.json` is properly configured:
+
+```json
+{
+  "compilerOptions": {
+    "strict": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler"
+  }
+}
+```
+
+## IDE Setup
+
+### VS Code
+
+Install the ESLint extension and add to `.vscode/settings.json`:
+
+```json
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,7 +1,31 @@
-export { DefineEslintOptions, bestPracticesRules, complexityRules, defineEslintVue, formattingRules, ignoresConfig, importRules, putoutRules, restrictedImportsRules, simpleImportSortRules, stylisticRules, typescriptRules, unusedImportsRules, vueAllRules, vueConfig, vueExtendsRules, vueLanguageOptions, vuePlugins, vueRules } from './vue.js';
+export { defineEslintNode, nestjsOverrides, nodeAllRules, nodeConfig, nodeExtendsRules, nodeLanguageOptions, nodePlugins } from './node.js';
+export { defineEslintVue, vueAllRules, vueConfig, vueExtendsRules, vueLanguageOptions, vuePlugins } from './vue.js';
+export { D as DefineEslintNodeOptions, a as DefineEslintOptions, b as bestPracticesRules, c as complexityRules, f as formattingRules, i as ignoresConfig, d as importRules, n as nodeComplexityRules, i as nodeIgnoresConfig, e as nodeImportRules, g as nodeRestrictedImportsRules, h as nodeSimpleImportSortRules, p as putoutRules, r as restrictedImportsRules, s as simpleImportSortRules, j as stylisticRules, t as typescriptRules, u as unusedImportsRules, v as vueRules } from './vue-BVTk7aqk.js';
 import 'typescript-eslint';
-import 'eslint';
-import 'json-schema';
 import '@stylistic/eslint-plugin-ts';
+import 'eslint';
 import '@stylistic/eslint-plugin';
 import 'vue-eslint-parser';
+import 'json-schema';
+
+interface PrettierConfig {
+    semi?: boolean;
+    singleQuote?: boolean;
+    trailingComma?: 'none' | 'es5' | 'all';
+    printWidth?: number;
+    tabWidth?: number;
+    useTabs?: boolean;
+    bracketSpacing?: boolean;
+    arrowParens?: 'avoid' | 'always';
+    endOfLine?: 'auto' | 'lf' | 'crlf' | 'cr';
+}
+/**
+ * Default Prettier configuration
+ */
+declare const prettierConfig: PrettierConfig;
+/**
+ * Creates a Prettier configuration with optional overrides
+ */
+declare function definePrettier(overrides?: Partial<PrettierConfig>): PrettierConfig;
+
+export { type PrettierConfig, definePrettier, prettierConfig };

package/dist/index.js

@@ -1,5 +1,5 @@
-// src/vue.ts
-import typescriptEslint2 from "typescript-eslint";
+// src/node.ts
+import typescriptEslint3 from "typescript-eslint";
 
 // src/configs/ignores.ts
 var ignoresConfig = {
@@ -13,18 +13,15 @@ var ignoresConfig = {
   ]
 };
 
-// src/configs/vue.ts
+// src/configs/node.ts
 import eslint from "@eslint/js";
 import stylistic from "@stylistic/eslint-plugin";
 import stylisticTs from "@stylistic/eslint-plugin-ts";
-import eslintPluginVue from "eslint-plugin-vue";
 import importPlugin from "eslint-plugin-import";
-import putout from "eslint-plugin-putout";
 import simpleImportSort from "eslint-plugin-simple-import-sort";
 import unusedImports from "eslint-plugin-unused-imports";
 import globals from "globals";
 import typescriptEslint from "typescript-eslint";
-import * as vueParser from "vue-eslint-parser";
 
 // src/rules/best-practices.ts
 var bestPracticesRules = {
@@ -196,6 +193,73 @@ var restrictedImportsRules = {
   ]
 };
 
+// src/rules/node-complexity.ts
+var nodeComplexityRules = {
+  "max-len": [
+    "error",
+    {
+      code: 100,
+      ignorePattern: [
+        'd="([\\s\\S]*?)"',
+        "^import\\s.+\\sfrom\\s.+;$",
+        "^export\\s.+\\sfrom\\s.+;$"
+      ].map((p) => `(${p})`).join("|")
+    }
+  ],
+  "max-lines": ["error", 300],
+  "max-nested-callbacks": ["error", 3],
+  "max-statements": ["error", 30],
+  "max-lines-per-function": ["error", 65],
+  "max-depth": ["error", 3],
+  "max-params": ["error", 5],
+  "complexity": ["error", 20]
+};
+
+// src/rules/node-imports.ts
+var nodeImportRules = {
+  "import/first": "error",
+  "import/newline-after-import": ["error", { count: 1 }],
+  "import/no-self-import": "error",
+  "import/no-useless-path-segments": "error"
+};
+var nodeSimpleImportSortRules = {
+  "simple-import-sort/imports": [
+    "error",
+    {
+      groups: [
+        [
+          "^dotenv",
+          "^tsconfig-paths",
+          "^@nestjs",
+          "^@?\\w",
+          "^@/app",
+          "^@/modules",
+          "^@/common",
+          "^@/shared",
+          "^@/config",
+          "^@/database",
+          "^\\.\\./",
+          "^\\.\\/+"
+        ]
+      ]
+    }
+  ],
+  "simple-import-sort/exports": "error"
+};
+var nodeRestrictedImportsRules = {
+  "no-restricted-imports": [
+    "error",
+    {
+      patterns: [
+        {
+          group: ["*.ts"],
+          message: "Do not use .ts extension in imports"
+        }
+      ]
+    }
+  ]
+};
+
 // src/rules/stylistic.ts
 var stylisticRules = {
   "@stylistic/indent-legacy": "off",
@@ -467,29 +531,113 @@ var vueRules = {
   "vue/no-undef-components": ["error", { ignorePatterns: ["^u-", "^router-", "^i18n-"] }]
 };
 
+// src/configs/node.ts
+var nodeExtendsRules = [
+  eslint.configs.recommended,
+  ...typescriptEslint.configs.recommended
+];
+var nodeLanguageOptions = {
+  ecmaVersion: "latest",
+  sourceType: "module",
+  globals: {
+    ...globals.node,
+    ...globals.jest
+  },
+  parser: typescriptEslint.parser,
+  parserOptions: {
+    project: ["./tsconfig.json"]
+  }
+};
+var nodePlugins = {
+  "@stylistic": stylistic,
+  "@stylistic/ts": stylisticTs,
+  "simple-import-sort": simpleImportSort,
+  "unused-imports": unusedImports,
+  "import": importPlugin
+};
+var nodeAllRules = {
+  ...stylisticRules,
+  ...nodeSimpleImportSortRules,
+  ...unusedImportsRules,
+  ...nodeImportRules,
+  ...typescriptRules,
+  ...formattingRules,
+  ...nodeComplexityRules,
+  ...nodeRestrictedImportsRules,
+  ...bestPracticesRules
+};
+var nodeConfig = {
+  extends: nodeExtendsRules,
+  files: ["**/*.ts"],
+  languageOptions: nodeLanguageOptions,
+  plugins: nodePlugins,
+  rules: nodeAllRules
+};
+var nestjsOverrides = [
+  {
+    files: ["**/*.dto.ts", "**/dto/**/*.ts"],
+    rules: {
+      "@stylistic/indent": "off",
+      "max-classes-per-file": "off"
+    }
+  },
+  {
+    files: ["**/*.entity.ts", "**/entities/**/*.ts"],
+    rules: {
+      "@stylistic/indent": "off",
+      "max-classes-per-file": "off"
+    }
+  },
+  {
+    files: ["**/*.types.ts", "**/*.interface.ts"],
+    rules: {
+      "@typescript-eslint/no-namespace": "off"
+    }
+  },
+  {
+    files: ["**/*.spec.ts", "**/*.test.ts", "**/*.e2e-spec.ts"],
+    rules: {
+      "max-lines-per-function": "off",
+      "max-lines": "off",
+      "max-nested-callbacks": ["error", 5]
+    }
+  }
+];
+
 // src/configs/vue.ts
+import eslint2 from "@eslint/js";
+import stylistic2 from "@stylistic/eslint-plugin";
+import stylisticTs2 from "@stylistic/eslint-plugin-ts";
+import eslintPluginVue from "eslint-plugin-vue";
+import importPlugin2 from "eslint-plugin-import";
+import putout from "eslint-plugin-putout";
+import simpleImportSort2 from "eslint-plugin-simple-import-sort";
+import unusedImports2 from "eslint-plugin-unused-imports";
+import globals2 from "globals";
+import typescriptEslint2 from "typescript-eslint";
+import * as vueParser from "vue-eslint-parser";
 var vueExtendsRules = [
-  eslint.configs.recommended,
-  ...typescriptEslint.configs.recommended,
+  eslint2.configs.recommended,
+  ...typescriptEslint2.configs.recommended,
   ...eslintPluginVue.configs["flat/recommended"]
 ];
 var vueLanguageOptions = {
   ecmaVersion: "latest",
   sourceType: "module",
-  globals: globals.browser,
+  globals: globals2.browser,
   parser: vueParser,
   parserOptions: {
-    parser: typescriptEslint.parser,
+    parser: typescriptEslint2.parser,
     extraFileExtensions: [".vue"],
     ecmaFeatures: { jsx: true }
   }
 };
 var vuePlugins = {
-  "@stylistic": stylistic,
-  "@stylistic/ts": stylisticTs,
-  "simple-import-sort": simpleImportSort,
-  "unused-imports": unusedImports,
-  "import": importPlugin,
+  "@stylistic": stylistic2,
+  "@stylistic/ts": stylisticTs2,
+  "simple-import-sort": simpleImportSort2,
+  "unused-imports": unusedImports2,
+  "import": importPlugin2,
   "putout": putout
 };
 var vueAllRules = {
@@ -513,26 +661,75 @@ var vueConfig = {
   rules: vueAllRules
 };
 
+// src/node.ts
+function defineEslintNode(options = {}) {
+  const { ignores = [], overrides = [], nestjs = true } = options;
+  const ignoreConfig = {
+    ...ignoresConfig,
+    ignores: [...ignoresConfig.ignores ?? [], ...ignores]
+  };
+  const configs = [ignoreConfig, nodeConfig];
+  if (nestjs) {
+    configs.push(...nestjsOverrides);
+  }
+  configs.push(...overrides);
+  return typescriptEslint3.config(...configs);
+}
+
 // src/vue.ts
+import typescriptEslint4 from "typescript-eslint";
 function defineEslintVue(options = {}) {
   const { ignores = [], overrides = [] } = options;
   const ignoreConfig = {
     ...ignoresConfig,
     ignores: [...ignoresConfig.ignores ?? [], ...ignores]
   };
-  return typescriptEslint2.config(
+  return typescriptEslint4.config(
     ignoreConfig,
     vueConfig,
     ...overrides
   );
 }
+
+// src/prettier.ts
+var prettierConfig = {
+  semi: false,
+  singleQuote: true,
+  trailingComma: "none",
+  printWidth: 100,
+  tabWidth: 2,
+  useTabs: false,
+  bracketSpacing: true,
+  arrowParens: "always",
+  endOfLine: "auto"
+};
+function definePrettier(overrides = {}) {
+  return {
+    ...prettierConfig,
+    ...overrides
+  };
+}
 export {
   bestPracticesRules,
   complexityRules,
+  defineEslintNode,
   defineEslintVue,
+  definePrettier,
   formattingRules,
   ignoresConfig,
   importRules,
+  nestjsOverrides,
+  nodeAllRules,
+  nodeComplexityRules,
+  nodeConfig,
+  nodeExtendsRules,
+  ignoresConfig as nodeIgnoresConfig,
+  nodeImportRules,
+  nodeLanguageOptions,
+  nodePlugins,
+  nodeRestrictedImportsRules,
+  nodeSimpleImportSortRules,
+  prettierConfig,
   putoutRules,
   restrictedImportsRules,
   simpleImportSortRules,