@kembec/eslint-config 1.1.2 → 1.1.3

package/Readme.md

@@ -1,6 +1,6 @@
 # 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.
+This document outlines how to integrate my ESLint setup into your JavaScript or TypeScript projects. It's a personal collection of configurations and plugins designed to enforce a consistent coding style and catch common errors.
 
 ## Quick Start Guide
 
@@ -16,23 +16,19 @@ npm install -D @kembec/eslint-config
 
 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:
+- **For JavaScript Projects**: In your `.eslintrc` file (which could be `.json`, `.js`, or `.ts`), include the following setup. To use Jest, change the extends value as shown in the comment:
 
 ```json
 {
-  "extends": ["@kembec/eslint-config"]
-  // Include Jest
-  "extends": ["@kembec/eslint-config/jest"]
+  "extends": ["@kembec/eslint-config"] // To use Jest, change to "@kembec/eslint-config/jest"
 }
 ```
 
-- **For TypeScript Projects**: To incorporate TypeScript-specific rules and configure the parser options, use this setup:
+- **For TypeScript Projects**: To include TypeScript-specific rules and configure parser options, use the following setup. To use Jest, modify the extends value as shown in the comment:
 
 ```json
 {
-  "extends": ["@kembec/eslint-config/typescript"],
-    // Include Jest
-  "extends": ["@kembec/eslint-config/typescript/jest"]
+  "extends": ["@kembec/eslint-config/typescript"], // To use Jest, change to "@kembec/eslint-config/typescript/jest"
   "overrides": [
     {
       "files": ["*.ts", "*.tsx"],
@@ -44,8 +40,30 @@ Modify your ESLint configuration file to use this package. The setup varies slig
 }
 ```
 
+- **For React Projects**:
+
+```json
+{
+  "extends": [
+    "@kembec/eslint-config/typescript",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended"
+  ],
+  "ignorePatterns": ["dist", ".eslintrc.cjs", "vite.config.ts"],
+  "overrides": [
+    {
+      "files": ["src/**/*.ts", "src/**/*.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.

package/index.js

@@ -11,8 +11,6 @@ module.exports = {
 	extends: [
 		"eslint:recommended",
 		"plugin:prettier/recommended",
-		...["./rules/best-practices", "./rules/errors", "./rules/style", "./rules/plugins"].map(
-			require.resolve,
-		),
+		...["./rules/best-practices", "./rules/errors", "./rules/style", "./rules/plugins"].map(require.resolve),
 	],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kembec/eslint-config",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "My personal linter configuration for JavaScript/TypeScript",
   "main": "index.js",
   "scripts": {
@@ -18,10 +18,12 @@
     "lint",
     "prettier",
     "jest",
+    "react",
+    "react-ts",
     "kembec"
   ],
   "author": "Kembec.com",
-  "license": "AGPL-3.0 license",
+  "license": "AGPL-3.0",
   "bugs": {
     "url": "https://github.com/Kembec/eslint-config-kembec/issues"
   },

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

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