@hs-web-team/eslint-config-node 1.0.0 → 2.1.0

package/.github/workflows/main.yml

@@ -2,7 +2,7 @@ name: Merge to Main
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
 
 jobs:
@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 18, 20 ]
+        node: [20, 22]
 
     name: Node ${{ matrix.node }} sample
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run unit tests
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       - run: npm install

package/.github/workflows/pr.yml

@@ -2,7 +2,7 @@ name: Pull Request
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
 
 jobs:
@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 18, 20 ]
+        node: [20, 22]
 
     name: Node ${{ matrix.node }} sample
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run unit tests
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       - run: npm install

package/.github/workflows/release.yml

@@ -7,12 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN:  ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.nvmrc

@@ -0,0 +1 @@
+v22

package/.prettierrc.json

@@ -0,0 +1,19 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 120,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "singleAttributePerLine": true,
+  "overrides": [
+    {
+      "files": ["*.yml", "*.yaml"],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

package/README.md

@@ -8,6 +8,7 @@ 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
@@ -40,3 +41,23 @@ npm i -D @hs-web-team/eslint-config-node
 ## 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:
+
+```shell
+npx @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

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/index.js

@@ -4,20 +4,18 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  ignorePatterns: [
-    '/node_modules/',
-    '/.serverless/',
-    '/.eslintrc.js',
-    '/.webpack/',
-  ],
+  ignorePatterns: ['/node_modules/', '/.serverless/', '/.eslintrc.js', '/.webpack/'],
   extends: ['airbnb-base'],
   parserOptions: {
     ecmaVersion: 'latest',
   },
   rules: {
-    'no-console': ['error', {
-      allow: ['info', 'warn', 'error'],
-    }],
+    'no-console': [
+      'error',
+      {
+        allow: ['info', 'warn', 'error'],
+      },
+    ],
     camelcase: 0,
     'comma-dangle': 1,
     'arrow-parens': 0,
@@ -38,5 +36,10 @@ module.exports = {
     ],
     'operator-linebreak': 0,
     'implicit-arrow-linebreaks': 0,
+    'implicit-arrow-linebreak': 0,
+    'object-curly-newline': 0,
+    'newline-per-chained-call': 0,
+    indent: 0,
+    'function-paren-newline': 0,
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-web-team/eslint-config-node",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "HubSpot Marketing WebTeam ESLint rules for Node.js",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,10 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
+  },
+  "bin": {
+    "add-prettier": "./bin/add-prettier-scripts.js"
   },
   "repository": {
     "type": "git",
@@ -26,6 +29,7 @@
   "dependencies": {
     "eslint": "^8.55.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.29.0"
+    "eslint-plugin-import": "^2.29.0",
+    "prettier": "^3.5.3"
   }
 }