@widergy/eslint-config 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.0.3](https://github.com/widergy/eslint-config/compare/v1.0.2...v1.0.3) (2026-02-10)
+
+
+### Bug Fixes
+
+* [DEV-766] forbid-prop-types and readme docs ([#12](https://github.com/widergy/eslint-config/issues/12)) ([1da5cfd](https://github.com/widergy/eslint-config/commit/1da5cfd574d4df59d6453b2637c200965ced5636))
+
 ## [1.0.2](https://github.com/widergy/eslint-config/compare/v1.0.1...v1.0.2) (2025-12-18)
 
 

package/README.md

@@ -1 +1,103 @@
-# eslint-config
+# @widergy/eslint-config
+
+Widergy's shared ESLint configuration, supporting JavaScript, TypeScript, React, and React Native.
+
+## Prerequisites
+
+> [!IMPORTANT]
+> This configuration package **only supports ESLint v9 Flat Config**. Please ensure you have upgraded to ESLint v9 before implementing this linter.
+
+## Installation
+
+1.  **Install the package**:
+
+    ```bash
+    npm install -D @widergy/eslint-config eslint
+    ```
+
+    > [!NOTE]
+    > Peer dependencies (like `prettier`, `typescript`, plugins, etc.) should be added on a **per-necessity basis**. The linter will fail if a required dependency for your specific configuration is missing. Read the error messages and install the missing packages as needed. This prevents installing unnecessary packages.
+
+2.  **Verify Prettier Configuration**:
+    Ensure your project's `.prettierrc` file matches the rules configured in this package to avoid conflicts between the linter and the formatter.
+    - _Reference the Prettier rules in the "Rules Documentation" section below._
+
+## Post Installation (Legacy Error Handling)
+
+To handle retrocompatibility with previous errors and avoid blocking the migration, follow these steps:
+
+1.  **Add `lint-suppress` script**:
+    Add the following script to your `package.json`:
+
+    ```json
+    "scripts": {
+      "lint-suppress": "eslint src --cache --suppress-all"
+    }
+    ```
+
+    - This command suppresses all current errors, allowing you to migrate without fixing everything immediately.
+    - **Run this once** after successful installation to generate the `eslint-suppressions.json` file.
+    - **Do not run this daily**. Only use it when you change rules and want to ignore new legacy errors.
+
+2.  **Update `lint` script**:
+    Modify your `lint` script to use the cache and prune unused suppressions:
+
+    ```json
+    "scripts": {
+      "lint": "eslint src --cache --prune-suppressions"
+    }
+    ```
+
+    - `--cache`: Speeds up future linting processes. **Add `.eslintcache` to your `.gitignore`**.
+    - `--prune-suppressions`: Automatically removes suppressions for rules that are no longer violated.
+
+3.  **Git Hooks**:
+    - It is recommended to run the linting process in the **`prepush`** hook of your repository.
+    - If you are currently using `precommit`, consider moving it to `prepush` to avoid slowing down commits.
+
+## Usage
+
+Import the specific configuration based on your project type in your `eslint.config.js` file.
+
+### Available Configurations
+
+- `@widergy/eslint-config/javascript`: **JS/TS only repositories** (helpers, internal libraries, etc.).
+- `@widergy/eslint-config/react`: **React Web projects**.
+- `@widergy/eslint-config/react-native`: **React Native Mobile projects**.
+
+### Example (React Project)
+
+```javascript
+import reactConfig from "@widergy/eslint-config/react";
+
+export default [
+  ...reactConfig,
+  {
+    // Custom overrides or specific project settings can be added here
+  },
+];
+```
+
+## Rules Documentation
+
+For detailed information on the rules enabled in this configuration, please refer to the official documentation for each plugin/rule set:
+
+- **Base Rules (ESLint)**: [https://eslint.org/docs/latest/rules](https://eslint.org/docs/latest/rules)
+- **Import Rules**: [https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules](https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules)
+- **Prettier Rules**: [https://prettier.io/docs/options](https://prettier.io/docs/options)
+- **React Rules**: [https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules](https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules)
+- **React Hooks Rules**: [https://react.dev/reference/eslint-plugin-react-hooks](https://react.dev/reference/eslint-plugin-react-hooks)
+- **React Native Rules**: [https://github.com/Intellicode/eslint-plugin-react-native/tree/master/docs/rules](https://github.com/Intellicode/eslint-plugin-react-native/tree/master/docs/rules)
+- **JSX A11y Rules**: [https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/main/docs/rules](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/main/docs/rules)
+
+## Contributing
+
+We welcome contributions to improve our shared configuration! To propose a change (add, remove, or modify a rule):
+
+1.  **Open a GitHub Discussion**: Go to the "Discussions" tab in this repository.
+2.  **Create a Poll**: Start a new discussion with a poll.
+3.  **Required Information**:
+    - **Title**: The name of the rule you want to change.
+    - **Summary**: A brief explanation of the proposed change.
+    - **Documentation**: A link to the official documentation for the rule (use the links in the "Rules Documentation" section).
+    - **Pros/Cons**: If applicable, list the arguments for and against the change for each option in the poll.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@widergy/eslint-config",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Widergy ESLint configuration",
   "type": "module",
   "author": "widergy",

package/src/rules/baseRules.js

@@ -1,3 +1,5 @@
+// DOCS: https://eslint.org/docs/latest/rules
+
 export const baseRules = {
   camelcase: "off",
   "class-methods-use-this": "off",

package/src/rules/importRules.js

@@ -1,3 +1,5 @@
+// DOCS: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
+
 export const importRules = {
   "import/extensions": "off",
   "import/no-absolute-path": "error",

package/src/rules/jsxA11yRules.js

@@ -1,3 +1,5 @@
+// DOCS: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/main/docs/rules
+
 export const jsxA11yRules = {
   "jsx-a11y/anchor-is-valid": [
     "error",

package/src/rules/prettierRules.js

@@ -1,3 +1,5 @@
+// DOCS: https://prettier.io/docs/options
+
 export const prettierRules = {
   "prettier/prettier": [
     "error",

package/src/rules/reactHooksRules.js

@@ -1,4 +1,6 @@
+// DOCS: https://react.dev/reference/eslint-plugin-react-hooks
+
 export const reactHooksRules = {
-  "react-hooks/exhaustive-deps": "off", // TODO: validar
+  "react-hooks/exhaustive-deps": "off",
   "react-hooks/rules-of-hooks": "error",
 };

package/src/rules/reactNativeRules.js

@@ -1,5 +1,6 @@
+// DOCS: https://github.com/Intellicode/eslint-plugin-react-native/tree/master/docs/rules
+
 export const reactNativeRules = {
-  // "react-native/no-color-literals": "off",         // TODO: validar
   "react-native/no-raw-text": "off",
   "react-native/split-platform-components": "off",
 };

package/src/rules/reactRules.js

@@ -1,7 +1,10 @@
+// DOCS: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules
+
 export const reactRules = {
   "react/button-has-type": "off",
   "react/destructuring-assignment": "off",
   "react/forbid-foreign-prop-types": "off",
+  "react/forbid-prop-types": "off",
   "react/function-component-definition": [
     "error",
     {
@@ -17,11 +20,7 @@ export const reactRules = {
   "react/jsx-one-expression-per-line": "off",
   "react/jsx-props-no-spreading": "off",
   "react/jsx-wrap-multilines": "off",
-  // "react/jsx-fragments": ["error", "syntax"],        // TODO: validar
-  // "react/no-access-state-in-setstate": "off",        // TODO: no salta
   "react/no-typos": "off",
-  // "react/no-unstable-nested-components": "off",      // TODO: validar
-  // "react/prefer-stateless-function": "off",          // TODO: no salta
   "react/prop-types": [
     "error",
     {