@tarsilla/eslint-config 1.0.3 → 1.0.5

package/README.md

@@ -1 +1,91 @@
-# eslint-config
+# @tarsilla/eslint-config
+
+This package provides a custom ESLint configuration built for ESLint v9. It enforces a consistent coding style and quality across Next.js, React and TypeScript library.
+
+## Features
+
+- **Custom Rule Sets**: Leverages recommended rules from @eslint/js, typescript-eslint, and various plugins.
+- **Multiple Environments**: Offers tailored configurations for Next.js, React, and TypeScript library code.
+- **Prettier**: Enforces consistent formatting with Prettier rules.
+- **Unused Imports**: Detects and removes dead code using `eslint-plugin-unused-imports`.
+- **Import Ordering**: Ensures a consistent and organized import structure using `eslint-plugin-import`.
+- **Jest**: Ensures a consistent and organized tests using `eslint-plugin-jest`.
+
+## Installation
+
+Install the configuration as a development dependency:
+
+```sh
+npm install --save-dev @tarsilla/eslint-config
+```
+
+or
+
+```sh
+yarn add --dev @tarsilla/eslint-config
+```
+
+## Usage
+
+In your ESLint configuration (see .eslintrc.mjs), add the plugin to your plugins array:
+
+**Next.js Projects**  
+
+```js
+import { eslintNextConfig } from '@tarsilla/eslint-config/next';
+
+export default [
+  // ...other plugins...
+  ...eslintNextConfig(),
+];
+```
+**React Projects**  
+
+```js
+import { eslintReactConfig } from '@tarsilla/eslint-config/react';
+
+export default [
+  // ...other plugins...
+  ...eslintReactConfig(),
+];
+```
+**Typescript Library Projects**  
+
+```js
+import { eslintLibraryConfig } from '@tarsilla/eslint-config/library';
+
+export default [
+  // ...other plugins...
+  ...eslintLibraryConfig(),
+];
+```
+
+## Configuration Options
+
+You can override default settings by creating passing options to the plugin.
+The plugin accepts an object of type `EslintOptions`:
+
+| Option   | Type   | Description                                                  | Default     |
+|----------|--------|--------------------------------------------------------------|-------------|
+| ignores | string array |  Array of paths to ignore during lint check. If not provided, the plugin will run in all files. | `undefined` |
+
+Example `Next.js`:
+
+```js
+import { eslintNextConfig } from '@tarsilla/eslint-config/next';
+
+export default [
+  // ...other plugins...
+  ...eslintNextConfig({
+    ignores: ['**/node_modules/'],
+  }),
+];
+```
+
+## Contributing
+
+Contributions are welcome! Please ensure your pull request adheres to the project's linting and testing guidelines.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

package/lib/index.d.ts

@@ -1,19 +1,13 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 type EslintOptions = {
     ignores: string[];
 };
 
-
-
 declare function eslintLibraryConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
-
-
 declare function eslintNextConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
-
-
 declare function eslintReactConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
 export { eslintLibraryConfig, eslintNextConfig, eslintReactConfig };

package/lib/library/index.d.ts

@@ -1,11 +1,9 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 type EslintOptions = {
     ignores: string[];
 };
 
-
-
 declare function eslintLibraryConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
 export { eslintLibraryConfig };

package/lib/next/index.d.ts

@@ -1,11 +1,9 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 type EslintOptions = {
     ignores: string[];
 };
 
-
-
 declare function eslintNextConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
 export { eslintNextConfig };

package/lib/react/index.d.ts

@@ -1,11 +1,9 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 type EslintOptions = {
     ignores: string[];
 };
 
-
-
 declare function eslintReactConfig({ ignores }: EslintOptions): TSESLint.FlatConfig.ConfigArray;
 
 export { eslintReactConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarsilla/eslint-config",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "publishConfig": {
     "access": "public"
   },
@@ -67,17 +67,17 @@
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "prettier": "^3.5.3",
-    "typescript-eslint": "^8.26.1"
+    "typescript-eslint": "^8.27.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-swc": "^0.4.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "@tarsilla/commit-wizard": "^1.0.1",
+    "@tarsilla/commit-wizard": "^1.0.5",
     "husky": "^9.1.7",
     "rollup": "^4.36.0",
-    "rollup-plugin-dts": "^6.2.0",
+    "rollup-plugin-dts": "^6.2.1",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "typescript": "^5.8.2"
   }