build: don't build project in postinstall script

The CLI currently runs `npm run build` in a post-install script. Many
of commands in the CLI implicitly depend on this behavior, which is
unnecessarily complicated. This post-install script conflicts with the
user-facing post-install script, which means we need to do a little pre-
publish post-install script juggling to ensure that the end user runs
the correct script after installing the CLI.

This change removes the post-install script in favor of explicitly
building the CLI before e.g. CI steps that require a built CLI.

Partial un-reversion of #7069, which
was reverted in #7085.

Author: ndhoule

.github/workflows/e2e-tests.yml

@@ -45,7 +45,11 @@ jobs:
       - name: Install dependencies
         run: npm ci --no-audit
 
-      - run: npm run e2e
+      - name: Build project
+        run: npm run build
+
+      - name: Run E2E tests
+        run: npm run e2e
 
       - name: Notify Slack
         uses: 8398a7/action-slack@v3
@@ -97,7 +101,11 @@ jobs:
       - name: Install dependencies
         run: npm ci --no-audit
 
-      - run: npm run e2e
+      - name: Build project
+        run: npm run build
+
+      - name: Run E2E tests
+        run: npm run e2e
 
       - name: Notify Slack
         uses: 8398a7/action-slack@v3

.github/workflows/integration-tests.yml

@@ -74,6 +74,9 @@ jobs:
         run: npm ci --no-audit
         if: '${{!steps.release-check.outputs.IS_RELEASE}}'
 
+      - name: Build project
+        run: npm run build
+
       - name: Generate self-signed certificates
         run: npm run certs
         if: '${{!steps.release-check.outputs.IS_RELEASE}}'
@@ -186,6 +189,9 @@ jobs:
         run: npm ci --no-audit
         if: '${{!steps.release-check.outputs.IS_RELEASE}}'
 
+      - name: Build project
+        run: npm run build
+
       - name: Generate self-signed certificates
         run: npm run certs
         if: '${{!steps.release-check.outputs.IS_RELEASE}}'

.github/workflows/pre-release-sha.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Install core dependencies
         run: npm ci --no-audit
 
-      - name: Build
+      - name: Build project
         run: npm run build
 
       - name: Configure Git user

.github/workflows/pre-release.yml

@@ -23,6 +23,9 @@ jobs:
       - name: Install core dependencies
         run: npm ci --no-audit
 
+      - name: Build project
+        run: npm run build
+
       - name: Extract tag and version
         id: extract
         run: |-
@@ -38,11 +41,10 @@ jobs:
           echo tag=${{ steps.extract.outputs.tag }}
           echo version=${{ steps.extract.outputs.version }}
 
-      - name: Setup git user
-        run: git config --global user.name github-actions
-
-      - name: Setup git email
-        run: git config --global user.email github-actions@github.com
+      - name: Configure Git user
+        run: |
+          git config --global user.name "Netlify"
+          git config --global user.email "82042599+token-generator-app[bot]@users.noreply.github.com"
 
       - name: Run npm version
         run: npm version ${{ steps.extract.outputs.version }}-${{ steps.extract.outputs.tag }} --allow-same-version

.github/workflows/release-please.yml

@@ -43,6 +43,7 @@ jobs:
       - name: Install core dependencies
         run: npm ci --no-audit
 
-      - run: npm publish --provenance
+      - name: Publish package
+        run: npm publish --provenance
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/unit-tests.yml

@@ -45,6 +45,10 @@ jobs:
         run: npm ci --no-audit
         if: '${{!steps.release-check.outputs.IS_RELEASE}}'
 
+      - name: Build project
+        run: npm run build
+        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
+
       - name: Run unit tests
         uses: nick-fields/retry@v3
         with:

CONTRIBUTING.md

@@ -33,6 +33,7 @@ Run:
 
 ```bash
 npm install
+npm run build
 ```
 
 Tests are run with:
@@ -67,15 +68,14 @@ npm run watch
 
 Make sure everything is correctly set up by running those tests first.
 
-ESLint and Prettier have performed automatically on `git push`. However, we recommend you set up your IDE or text editor
-to run ESLint and Prettier automatically on file save. Otherwise, you should run them manually using:
+We recommend you set up your IDE or text editor to run ESLint and Prettier automatically on file save. Otherwise, you
+can run them manually using:
 
 ```bash
 npm run format
+npm run lint:fix
 ```
 
-Alternatively, you can set up your IDE to integrate with Prettier and ESLint for JavaScript and Markdown files.
-
 To run the CLI locally:
 
 ```bash

package.json

@@ -55,9 +55,8 @@
     "e2e": "node ./tools/e2e/run.js",
     "docs": "npm run --prefix=site build",
     "watch": "c8 --reporter=lcov vitest --watch",
-    "postinstall-pack": "node ./scripts/postinstall.js",
-    "postinstall": "npm run build && node ./scripts/postinstall.js",
-    "prepublishOnly": "node ./scripts/prepare-for-publish.js",
+    "postinstall": "node ./scripts/postinstall.js",
+    "prepublishOnly": "npm shrinkwrap",
     "certs": "openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -subj \"/CN=localhost\" -extensions EXT -config certconf",
     "typecheck": "tsc",
     "typecheck:watch": "tsc --watch"

scripts/postinstall.js

@@ -1,11 +1,18 @@
-import process from 'process'
+/*
+ * This script runs after an end user installs the CLI. It installs command-line completion, prints
+ * a welcome message, etc.
+ */
+
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import process from 'node:process'
 // eslint-disable-next-line no-restricted-imports
 import chalk from 'chalk'
 
-import { createMainCommand } from '../dist/commands/index.js'
-import { generateAutocompletion } from '../dist/lib/completion/index.js'
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-const id = (message) => message
+const identity = (message) => message
 
 /**
  *
@@ -14,7 +21,7 @@ const id = (message) => message
  * @returns
  */
 const format = (message, styles) => {
-  let func = id
+  let func = identity
   try {
     func = chalk
     styles.forEach((style) => {
@@ -25,6 +32,9 @@ const format = (message, styles) => {
 }
 
 const postInstall = async () => {
+  const { createMainCommand } = await import('../dist/commands/index.js')
+  const { generateAutocompletion } = await import('../dist/lib/completion/index.js')
+
   // yarn plug and play seems to have an issue with reading an esm file by building up the cache.
   // as yarn pnp analyzes everything inside the postinstall
   // yarn pnp executes it out of a .yarn folder .yarn/unplugged/netlify-cli-file-fb026a3a6d/node_modules/netlify-cli/scripts/postinstall.js
@@ -56,4 +66,21 @@ const postInstall = async () => {
   console.log('')
 }
 
-await postInstall()
+const main = async () => {
+  // Check if this post-install script is being run by an end user installation
+  // (`npm install [-g] netlify-cli`) or during local development (`npm install`/`npm ci`)
+  let isEndUserInstall = false
+  try {
+    await fs.stat(path.resolve(__dirname, '../.git'))
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      isEndUserInstall = true
+    }
+  }
+
+  if (isEndUserInstall) {
+    await postInstall()
+  }
+}
+
+await main()