@kembec/eslint-config 1.0.2 → 1.1.0

package/.github/workflows/npm-publish.yaml

@@ -4,20 +4,19 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
 jobs:
   npm-publish:
     runs-on: ubuntu-latest
+    environment: NPM
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '12'
+          node-version: '16' 
+          registry-url: 'https://registry.npmjs.org/' 
       - run: npm install
-      - run: npm test
+      - run: npm run build --if-present 
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.TOKEN_NPM }}

package/Readme.md

@@ -1,40 +1,76 @@
-# My personal JavaScript/TypeScript linter configuration
+# Streamlined ESLint Configuration for JS/TS Projects
 
+This document outlines the steps to integrate my ESLint setup into your JavaScript or TypeScript projects. It's a personal collection of configurations and plugins aimed at fostering a consistent coding style and catching common errors.
 
-## Getting Start
+## Quick Start Guide
 
-- Install 
-    ```
-    npm install -D @kembec/eslint-config
-    ```
+### Step 1: Installation
 
-- Add in the .eslintrc{,.js,.ts} file
-    ```
-    extends: [ "@kembec/eslint-config" ] 
-    ```
-    
-- If you use TypeScript
-    ```
+Add the configuration package to your development dependencies:
+
+```bash
+npm install -D @kembec/eslint-config
+```
+
+### Step 2: Configure ESLint
+
+Modify your ESLint configuration file to use this package. The setup varies slightly depending on whether you're working with plain JavaScript or TypeScript.
+
+- **For JavaScript Projects**: In your `.eslintrc` (which could be a `.json`, `.js`, or `.ts` file), include the following:
+
+```json
+{
+  "extends": ["@kembec/eslint-config"]
+  // Include Jest
+  "extends": ["@kembec/eslint-config/jest"]
+}
+```
+
+- **For TypeScript Projects**: To incorporate TypeScript-specific rules and configure the parser options, use this setup:
+
+```json
+{
+  "extends": ["@kembec/eslint-config/typescript"],
+    // Include Jest
+  "extends": ["@kembec/eslint-config/typescript/jest"]
+  "overrides": [
     {
-	    extends: ["@kembec/eslint-config/typescript"],
-        overrides: [
-            {
-                files: ["*.ts", "*.tsx"],
-                parserOptions: {
-                    project: ["./tsconfig.json"],
-                },
-            },
-        ]
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["./tsconfig.json"]
+      }
     }
-    ```
+  ]
+}
+```
+
+## Included Plugins
+
+The configuration incorporates a carefully selected set of ESLint plugins to assist with various code quality and style concerns:
+
+- `eslint-plugin-import`: Manages and validates import statements.
+- `eslint-plugin-jest`: Provides linting rules for Jest tests.
+- `eslint-plugin-prettier`: Integrates Prettier formatting into ESLint.
+- `eslint-plugin-simple-import-sort`: Automatically sorts import statements.
+- `eslint-plugin-unused-imports`: Helps in removing unused imports.
+- `@typescript-eslint/eslint-plugin`: Adds TypeScript-specific linting rules.
+- `@typescript-eslint/parser`: Allows ESLint to parse TypeScript code.
+
+These plugins are intended to help maintain a clean codebase and promote coding best practices.
+
+## Usage
+
+Integrate linting into your workflow with these npm scripts:
+
+```json
+"scripts": {
+  "lint": "eslint .",
+  "lint:fix": "eslint --fix ."
+}
+```
 
+Use `npm run lint` to identify issues or `npm run lint:fix` to fix many issues automatically.
 
-## Plugins Included
+## License
 
-- eslint-plugin-import
-- eslint-plugin-jest
-- eslint-plugin-prettier
-- eslint-plugin-simple-import-sort
-- eslint-plugin-unused-import
-- @typescript-eslint/eslint-plugin
-- @typescript-eslint/parser
+`Sunat Utils` is licensed under the [AGPL-3.0](https://opensource.org/licenses/AGPL-3.0). Its use, modification, and distribution are allowed under the terms of this license.

package/jest/index.js

@@ -0,0 +1,11 @@
+module.exports = {
+	extends: ["../index.js"],
+	overrides: [
+		{
+			files: ["*.test.js"],
+			plugins: ["jest"],
+			extends: ["plugin:jest/recommended"],
+			rules: {},
+		},
+	],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kembec/eslint-config",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "My personal linter configuration for JavaScript/TypeScript",
   "main": "index.js",
   "scripts": {
@@ -17,6 +17,7 @@
     "eslint",
     "lint",
     "prettier",
+    "jest",
     "kembec"
   ],
   "author": "Kembec.com",

package/rules/plugins.js

@@ -20,12 +20,4 @@ module.exports = {
 			},
 		],
 	},
-	overrides: [
-		{
-			files: ["*.test.ts", "*.test.js"],
-			plugins: ["jest"],
-			extends: ["plugin:jest/recommended"],
-			rules: {},
-		},
-	],
 };

package/typescript/jest/index.js

@@ -0,0 +1,11 @@
+module.exports = {
+	extends: ["../index.js"],
+	overrides: [
+		{
+			files: ["*.test.ts"],
+			plugins: ["jest"],
+			extends: ["plugin:jest/recommended"],
+			rules: {},
+		},
+	],
+};