@hs-web-team/eslint-config-node 2.0.0 → 2.1.1

package/.prettierrc.json

@@ -7,5 +7,13 @@
   "bracketSpacing": true,
   "arrowParens": "avoid",
   "endOfLine": "lf",
-  "singleAttributePerLine": true
+  "singleAttributePerLine": true,
+  "overrides": [
+    {
+      "files": ["*.yml", "*.yaml"],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
 }

package/README.md

@@ -8,35 +8,62 @@ This is a list of ESLint rules that are recommended for use with **Hubspot Marke
 
 - [Setup](#setup)
 - [Where to use it](#where-to-use-it)
+- [Using the Prettier Scripts](#using-the-prettier-scripts)
 <!-- index-end -->
 
 ## Setup
 
 1. Install as dev dependency
 
-```shell
-npm i -D @hs-web-team/eslint-config-node
-```
+    ```sh
+    npm i -D @hs-web-team/eslint-config-node@latest
+    ```
 
 2. Add to `.eslintrc` in project root directory
 
-```json
-{
-  "extends": "@hs-web-team/eslint-config-node"
-}
-```
+    ```json
+    {
+      "extends": "@hs-web-team/eslint-config-node"
+    }
+    ```
 
 3. Extend the eslint on a project basis by adding rules to `.eslintrc` e.g.
 
-```
-{
-  "extends": "@hs-web-team/eslint-config-node",
-  "settings": {
-    "import/resolver": "webpack"
-  }
-}
-```
+    ```json
+    {
+      "extends": "@hs-web-team/eslint-config-node",
+      "settings": {
+        "import/resolver": "webpack"
+      }
+    }
+    ```
 
 ## Where to use it
 
 This package is intended to be used as a starting point for ESLint rules for Backend Node.js projects, and not for use in browser environments.
+
+## Using the Prettier Scripts
+
+This package includes a utility script to automatically add Prettier configuration to your project.
+
+1. Run the script:
+
+    ```sh
+    node ./node_modules/@hs-web-team/eslint-config-node/bin/add-prettier-scripts.js
+    ```
+
+2. The script will:
+
+   - Add `prettier:check` and `prettier:write` scripts to your package.json
+   - Install Prettier as a dev dependency if not already installed
+   - Create a `.prettierrc.js` file with shared config
+   - Create a `.prettierignore` file with sensible defaults
+
+3. After installation, you can use the following commands:
+
+   - `npm run prettier:check` - Check files for formatting issues
+   - `npm run prettier:write` - Automatically fix formatting issues
+
+## Migration from v1 to v2
+
+See [MIGRATION-V2.md](./docs/MIGRATION-V2.md)

package/bin/add-prettier-scripts.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const packageJson = require('../package.json');
+
+const { name } = packageJson;
+
+/**
+ * Adds Prettier scripts to the package.json file
+ */
+const addPrettierScripts = () => {
+  console.info('Adding Prettier scripts to package.json...');
+
+  const packageJsonPath = path.join(process.cwd(), 'package.json');
+  if (!fs.existsSync(packageJsonPath)) {
+    console.error('Error: package.json not found in the current directory');
+    process.exit(1);
+  }
+
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+    packageJson.scripts = {
+      ...packageJson.scripts,
+      'prettier:check': 'prettier --check .',
+      'prettier:write': 'prettier --write .',
+    };
+
+    fs.writeFileSync(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`);
+
+     const prettierConfigPath = path.join(process.cwd(), '.prettierrc.js');
+    if (!fs.existsSync(prettierConfigPath)) {
+      console.info('Creating .prettierrc.js file...');
+      const prettierConfig =
+`const sharedConfig = require('${name}/.prettierrc.json');
+
+module.exports = sharedConfig;`;
+      fs.writeFileSync(prettierConfigPath, prettierConfig);
+    }
+    const prettierIgnorePath = path.join(process.cwd(), '.prettierignore');
+    if (!fs.existsSync(prettierIgnorePath)) {
+      console.info('Creating .prettierignore file...');
+      const ignoreContent =
+`npm-shrinkwrap.json
+package-lock.json
+.eslintrc
+*.html`;
+      fs.writeFileSync(prettierIgnorePath, ignoreContent);
+    }
+
+    console.info('✅ Successfully added Prettier scripts to package.json');
+    console.info('You can now run:');
+    console.info('  npm run prettier:check - to check files for formatting issues');
+    console.info('  npm run prettier:write - to automatically fix formatting issues');
+  } catch (error) {
+    console.error('Error updating package.json:', error.message);
+    process.exit(1);
+  }
+};
+
+addPrettierScripts();

package/docs/MIGRATION-V2.md

@@ -0,0 +1,24 @@
+# Migration from v1 to v2
+
+## Steps to migrate
+
+> **Note**
+>
+> This migration requires a manual review of the changes and also that you run your project in Node.js v22 or higher.
+
+- [ ] Upgrade to Node.js v22 or higher
+- [ ] Upgrade all dependencies to the latest version
+- [ ] Update the package `npm install @hs-web-team/eslint-config-node@latest`
+- [ ] Run the script `node ./node_modules/@hs-web-team/eslint-config-node/bin/add-prettier-scripts.js`
+- [ ] Commit the changes
+- [ ] Run the `prettier:check` command to preview what it's being changed
+- [ ] Adjust the `.prettierignore` according to your project requirements, as you may not want to format certain files
+- [ ] Run the `prettier:write` command to format the files
+- [ ] Hope for the best :-D
+- [ ] Test locally that everything is working correctly
+- [ ] Commit the changes
+- [ ] Create a PR
+- [ ] Get it approved
+- [ ] Merge it into `main`
+- [ ] Test everything in QA
+- [ ] Celebrate! 🎉

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-web-team/eslint-config-node",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "HubSpot Marketing WebTeam ESLint rules for Node.js",
   "main": "index.js",
   "scripts": {
@@ -10,6 +10,9 @@
   "engines": {
     "node": ">=22"
   },
+  "bin": {
+    "add-prettier": "./bin/add-prettier-scripts.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/HubSpotWebTeam/wt-eslint-node.git"
@@ -24,9 +27,9 @@
   },
   "homepage": "https://github.com/HubSpotWebTeam/wt-eslint-node#readme",
   "dependencies": {
-    "eslint": "^8.55.0",
+    "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-import": "^2.31.0",
     "prettier": "^3.5.3"
   }
 }