chore: add Prettier + husky + lint-staged

.eslintrc.js

@@ -1,40 +1,23 @@
-'use strict'
+'use strict';
 const eslintConfig = {
-  extends: [
-    'eslint:recommended'
-  ],
+  extends: ['eslint:recommended', 'prettier'],
   parserOptions: {
-    "ecmaVersion": "latest"
+    ecmaVersion: 'latest',
   },
   env: {
-    "es6": true,
-    "node": true
+    es6: true,
+    node: true,
   },
-  plugins: [
-    'ava'
-  ],
+  plugins: ['ava'],
   rules: {
     'ava/no-import-test-files': 0,
     'ava/no-ignored-test-files': 0,
-    indent: [
-      'error',
-      2,
-      {
-        CallExpression: {
-          arguments: 'first'
-        },
-        SwitchCase: 1
-      }
-    ],
     'no-console': 0,
     strict: 'error',
-    'comma-dangle': ['error', 'never'],
-    semi: ['error', 'never'],
-    'space-before-function-paren': ['error', 'always']
   },
   overrides: [
     {
-      files: ["**/*.ts"],
+      files: ['**/*.ts'],
       extends: [
         'eslint:recommended',
         'plugin:ava/recommended',
@@ -43,23 +26,15 @@ const eslintConfig = {
         'plugin:promise/recommended',
         'plugin:@typescript-eslint/eslint-recommended',
         'plugin:@typescript-eslint/recommended',
-        'plugin:import/typescript'
+        'plugin:import/typescript',
+        'prettier',
       ],
       parser: '@typescript-eslint/parser',
       parserOptions: {
-        sourceType: 'module'
+        sourceType: 'module',
       },
-      rules: {
-        'comma-dangle': ['error', 'always-multiline'],
-        semi: ['error', 'always'],
-        'space-before-function-paren': ['error', {
-          "anonymous": "never",
-          "named": "never",
-          "asyncArrow": "always"
-        }]
-      }
-    }
-  ]
-}
+    },
+  ],
+};
 
-module.exports = eslintConfig
+module.exports = eslintConfig;

.github/ISSUE_TEMPLATE/config.yml

@@ -3,4 +3,4 @@ blank_issues_enabled: false
 contact_links:
   - name: Question
     url: https://discord.gg/APGC3k5yaH
-    about: "Please ask questions about using Electron Packager in the official Electron Discord server, at the #electron-packager channel."
+    about: 'Please ask questions about using Electron Packager in the official Electron Discord server, at the #electron-packager channel.'

.github/dependabot.yml

@@ -1,6 +1,6 @@
 version: 2
 updates:
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: "monthly"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'

.github/workflows/canary.yml

@@ -2,7 +2,7 @@ name: electron-nightly Canary
 
 on:
   schedule:
-    - cron: "15 8 * * *"
+    - cron: '15 8 * * *'
 
 jobs:
   build:

.github/workflows/docs.yml

@@ -18,18 +18,18 @@ jobs:
         id: generate-token
         with:
           creds: ${{ secrets.GH_APP_CREDS }}
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # tag: v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # tag: v4.2.2
         with:
           token: ${{ steps.generate-token.outputs.token }}
       - name: Fetch all git branches
         run: git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a  # tag: v4.2.0
+      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # tag: v4.2.0
         with:
           node-version: lts/*
       - run: yarn install --frozen-lockfile
       - run: yarn run docs:build
       - name: Prepare docs
-        uses: malept/github-action-gh-pages@f7952a65c4b763dc84b824a530dc38bd375ac91e  # tag: v1.4.0
+        uses: malept/github-action-gh-pages@f7952a65c4b763dc84b824a530dc38bd375ac91e # tag: v1.4.0
         with:
           defaultBranch: main
           docsPath: typedoc

.github/workflows/semantic.yml

@@ -1,4 +1,4 @@
-name: "Check Semantic Commit"
+name: 'Check Semantic Commit'
 
 on:
   pull_request:
@@ -13,8 +13,8 @@ permissions:
 jobs:
   main:
     permissions:
-      pull-requests: read  # for amannn/action-semantic-pull-request to analyze PRs
-      statuses: write  # for amannn/action-semantic-pull-request to mark status of analyzed PR
+      pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
+      statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
     name: Validate PR Title
     runs-on: ubuntu-latest
     steps:

.github/workflows/test.yml

@@ -25,21 +25,27 @@ jobs:
           - macos-latest
           - ubuntu-latest
           - windows-latest
-    runs-on: "${{ matrix.os }}"
+    runs-on: '${{ matrix.os }}'
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Node.js
         uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
         with:
-          node-version: "${{ matrix.node-version }}"
+          node-version: '${{ matrix.node-version }}'
           cache: 'yarn'
       - name: Setup CI Environment
         run: test/ci/before_install.sh
       - name: Install
         run: yarn install --frozen-lockfile
       - name: Build
         run: yarn build
+      - name: ESLint Cache
+        uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
+        with:
+          path: |
+            .eslintcache
+          key: ${{ matrix.os }}-node-${{ hashFiles('*/yarn.lock', '*/.eslintrc.js') }}
       - name: Electron Cache
         uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
         with:

.gitignore

@@ -16,3 +16,4 @@ npm-debug.log
 dist/
 src/targets.js
 coverage.lcov
+.eslintcache

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

bin/electron-packager.js

@@ -1,16 +1,18 @@
 #!/usr/bin/env node
 
-'use strict'
+'use strict';
 
 /* eslint-disable no-var */
 // WHY: not consts so that this file can load in Node < 4.0
-var packageJSON = require('../package.json')
-var semver = require('semver')
+var packageJSON = require('../package.json');
+var semver = require('semver');
 if (!semver.satisfies(process.versions.node, packageJSON.engines.node)) {
-  console.error('CANNOT RUN WITH NODE ' + process.versions.node)
-  console.error('Electron Packager requires Node ' + packageJSON.engines.node + '.')
-  process.exit(1)
+  console.error('CANNOT RUN WITH NODE ' + process.versions.node);
+  console.error(
+    'Electron Packager requires Node ' + packageJSON.engines.node + '.',
+  );
+  process.exit(1);
 }
 
-var cli = require('../dist/cli')
-cli.run(process.argv.slice(2))
+var cli = require('../dist/cli');
+cli.run(process.argv.slice(2));

package.json

@@ -41,6 +41,7 @@
     "junk": "^3.1.0",
     "parse-author": "^2.0.0",
     "plist": "^3.0.0",
+    "prettier": "^3.4.2",
     "resedit": "^2.0.0",
     "resolve": "^1.1.6",
     "semver": "^7.1.3",
@@ -55,15 +56,18 @@
     "@types/semver": "^7.5.8",
     "@types/yargs-parser": "^21.0.2",
     "@typescript-eslint/eslint-plugin": "7.2.0",
-    "@typescript-eslint/parser": "^6.9.1",
+    "@typescript-eslint/parser": "^8.2.3",
     "ava": "^3.10.1",
     "buffer-equal": "^1.0.0",
     "copyfiles": "^2.4.1",
     "eslint": "^8.52.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-ava": "^14.0.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-promise": "^6.2.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
     "lodash": "^4.17.21",
     "nyc": "^15.0.0",
     "pkg-up": "^4.0.0",
@@ -84,10 +88,11 @@
     "coverage": "nyc ava test/index.js",
     "coverage:report": "nyc report --reporter=text-lcov > coverage.lcov",
     "docs:build": "npx typedoc",
-    "lint": "eslint .",
+    "lint": "prettier --check \"*.{ts,js,json,yml}\" && eslint . --cache",
     "prepublish": "npm run build",
     "pretest": "npm run build",
-    "test": "npm run lint && npm run coverage"
+    "test": "npm run lint && npm run coverage",
+    "prepare": "husky"
   },
   "directories": {
     "test": "test"
@@ -106,5 +111,12 @@
   },
   "resolutions": {
     "got": "11.8.5"
+  },
+  "lint-staged": {
+    "*.{json,yml}": "prettier --write",
+    "*.{js,ts}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
   }
 }

src/ambient.d.ts

@@ -1,28 +1,31 @@
 declare module 'get-package-info' {
-  type Props = Array<string | string[]>
+  type Props = Array<string | string[]>;
 
   export type GetPackageInfoResultSourceItem = {
     /** path to the package.json file */
-    src: string
+    src: string;
 
     /** property name */
-    prop: string
+    prop: string;
 
     /** the `package.json` object */
-    pkg: Record<string, unknown>
-  }
+    pkg: Record<string, unknown>;
+  };
 
   export type GetPackageInfoResult = {
-    source: Record<string, GetPackageInfoResultSourceItem>
-    values: Record<string, unknown>
-  }
+    source: Record<string, GetPackageInfoResultSourceItem>;
+    values: Record<string, unknown>;
+  };
 
-  function getPackageInfo (props: Props, dir: string): Promise<GetPackageInfoResult>
+  function getPackageInfo(
+    props: Props,
+    dir: string,
+  ): Promise<GetPackageInfoResult>;
 
   export type GetPackageInfoError = Error & {
-    missingProps: Props
-    result: GetPackageInfoResult
-  }
+    missingProps: Props;
+    result: GetPackageInfoResult;
+  };
 
-  export = getPackageInfo
+  export = getPackageInfo;
 }