chore: normalize line endings and symlinks

This makes it possible to do a fresh clone of this repo in Windows, and be able to run the resetdeps command successfully and then have a clean git status. We now check for a clean git status in during CI in Windows which was previously excluded. The changes required were to: - Delete our workspace symlinks from node_modules and add a step to resetdeps that will do a platform dependent symlink before the initial reification - Add line ending normalization to our `.gitattributes` file and commit the result. Git will store text with LF line endings automatically, except for some files like `cmd` scripts that need to be `crlf` and shell scripts that need to be `lf`. - Update workflows to call `node scripts/resetdeps.js` directly since a fresh clone of the repo wont have any symlinks in place, so any `node .` command will fail due to missing workspaces. Ref: npm/statusboard#562
npm · Jun 23, 2023 · 17ac1b9 · 17ac1b9
1 parent aef96c0
commit 17ac1b9
Show file tree

Hide file tree

Showing 54 changed files with 240 additions and 242 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,26 @@
-/node_modules/**    linguist-generated=false
-/package-lock.json  linguist-generated=false
+# normalize all line endings by default
+* text=auto
+
+# ignore all line endings in node_modules since
+# we dont control what ends up in there
+/node_modules/** -text linguist-generated=false
+
+# our cmd scripts always need to be CRLF
+/bin/*.cmd text eol=crlf
+
+# our shell scripts always need to be LF
+/bin/npm text eol=lf
+/bin/npx text eol=lf
+
+# the files we write should be LF so they
+# can be generated cross platform without churn
+/node_modules/.gitignore text eol=lf
+/workspaces/arborist/test/fixtures/.gitignore text eol=lf
+/DEPENDENCIES.md text eol=lf
+/AUTHORS text eol=lf
+
+# fixture tarballs should be treated as binary
+/workspaces/*/test/fixtures/**/*.tgz binary
+
+# this makes our package-lock show up in pull requests
+/package-lock.json linguist-generated=false
diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml
@@ -29,7 +29,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps -- --package-lock
+        run: node scripts/resetdeps.js --package-lock
       - name: Run Production Audit
         run: node . audit --omit=dev
       - name: Run Full Audit

diff --git a/.github/workflows/ci-libnpmaccess.yml b/.github/workflows/ci-libnpmaccess.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmaccess
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmaccess
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmdiff.yml b/.github/workflows/ci-libnpmdiff.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmdiff
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmdiff
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmexec.yml b/.github/workflows/ci-libnpmexec.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmexec
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmexec
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmfund.yml b/.github/workflows/ci-libnpmfund.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmfund
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmfund
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmhook.yml b/.github/workflows/ci-libnpmhook.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmhook
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmhook
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmorg.yml b/.github/workflows/ci-libnpmorg.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmorg
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmorg
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmpack.yml b/.github/workflows/ci-libnpmpack.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmpack
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmpack
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmpublish.yml b/.github/workflows/ci-libnpmpublish.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmpublish
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmpublish
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmsearch.yml b/.github/workflows/ci-libnpmsearch.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmsearch
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmsearch
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmteam.yml b/.github/workflows/ci-libnpmteam.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmteam
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmteam
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-libnpmversion.yml b/.github/workflows/ci-libnpmversion.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w libnpmversion
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w libnpmversion
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-npmcli-arborist.yml b/.github/workflows/ci-npmcli-arborist.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w @npmcli/arborist
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w @npmcli/arborist
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-npmcli-config.yml b/.github/workflows/ci-npmcli-config.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w @npmcli/config
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w @npmcli/config
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
diff --git a/.github/workflows/ci-npmcli-docs.yml b/.github/workflows/ci-npmcli-docs.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w @npmcli/docs
       - name: Post Lint
@@ -79,13 +79,12 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w @npmcli/docs
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
 
   compare-docs:
@@ -110,7 +109,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Build Docs
         run: |
           node . run build -w docs
@@ -121,7 +120,7 @@ jobs:
         run: |
           git clean -fd
           git checkout ${{ github.event.pull_request.base.ref }}
-          node . run resetdeps
+          node scripts/resetdeps.js
           node . run build -w docs
       - name: Diff Man
         run: diff -r --color=always man/ man-update/ || true

diff --git a/.github/workflows/ci-npmcli-mock-globals.yml b/.github/workflows/ci-npmcli-mock-globals.yml
@@ -38,7 +38,7 @@ jobs:
           node-version: 18.x
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Lint
         run: node . run lint --ignore-scripts -w @npmcli/mock-globals
       - name: Post Lint
@@ -84,11 +84,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - name: Reset Deps
-        run: node . run resetdeps
+        run: node scripts/resetdeps.js
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
         run: node . test --ignore-scripts -w @npmcli/mock-globals
       - name: Check Git Status
-        if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js