@hs-web-team/eslint-config-node 3.0.0-next.3 → 3.0.0-next.4

package/README.md

@@ -19,23 +19,36 @@ This is a list of ESLint rules that are recommended for use with **Hubspot Marke
     npm i -D @hs-web-team/eslint-config-node@latest
     ```
 
-2. Add to `.eslintrc` in project root directory
+2. Add to `eslint.config.js` in project root directory
 
-    ```json
-    {
-      "extends": "@hs-web-team/eslint-config-node"
-    }
-    ```
+    ```typescript
+    import { defineConfig } from 'eslint/config';
+    import wtConfig from '@hs-web-team/eslint-config-node';
 
-3. Extend the eslint on a project basis by adding rules to `.eslintrc` e.g.
+    export default defineConfig([
+      ...wtConfig,
+    ]);
+    ```
 
-    ```json
-    {
-      "extends": "@hs-web-team/eslint-config-node",
-      "settings": {
-        "import/resolver": "webpack"
-      }
-    }
+3. Extend the eslint on a project basis by adding rules to `eslint.config.js` e.g.
+
+    ```typescript
+    import { defineConfig } from 'eslint/config';
+    import wtConfig from '@hs-web-team/eslint-config-node';
+
+    export default defineConfig([
+      // Add project-specific ignores here
+      {
+        ignores: ['dist/**'],
+      },
+      // Add project-specific rules here
+      {
+        rules: {
+          'no-console': 'error',
+        },
+      },
+      ...wtConfig, // This will include the shared rules from @hs-web-team/eslint-config-node
+    ]);
     ```
 
 ## Where to use it

package/docs/MIGRATION-V3.md

@@ -10,4 +10,15 @@
 - [ ] Upgrade all dependencies to the latest version
 - [ ] Update the package `npm install @hs-web-team/eslint-config-node@latest`
 - [ ] Run the script `npx @eslint/migrate-config .eslintrc`
+- [ ] Run `npm run lint` to check for any errors
 - [ ] Commit the changes
+- [ ] Create a PR
+- [ ] Get it approved
+- [ ] Merge it into `main`
+- [ ] Test everything in QA
+- [ ] Celebrate! 🎉
+
+> **Important**
+>
+> Bear in mind that this migration will remove the `.eslintrc` file and replace it with `eslint.config.js`.
+> Also the automated migration might fail to migrate some of the rules, so you may need to manually adjust the `eslint.config.js` file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-web-team/eslint-config-node",
-  "version": "3.0.0-next.3",
+  "version": "3.0.0-next.4",
   "description": "HubSpot Marketing WebTeam ESLint rules for Node.js",
   "main": "index.js",
   "type": "module",