KTLO: Switch package manager from yarn to pnpm (#535)

* Initial attempt at switching from yarn to pnpm

* Fix typeorm CLI path

* Fix package.json dependency ordering

* Webpack and tsc symlink settings are opposites

* Resolve symlinks to their target modules

* Script to run "pnpm audit" post install

* Improve audit output

* Clean up audit output

* Revert accidental webpack upgrade

* Rearrange scripts

* Rework lerna config to use npm

* Update READMEs

* --use-spawn-wrap for nyc error on Windows

* Add missing dev dependencies

* Fix debug config for jest unit test

* Updated check-advisories script

* Update root scripts

* Make webpack plugin work on windows

* Clean up install scripts

* Use pnpm workspace: protocol

* Audit package dependencies for vulnerabilities

* Use save-workspace-protocol = false

* KTLO: Keep package.json properties sorted (#537)

* Use Prettier plugin to keep package.json sorted

* KTLO: Improve eslint performance (#538)

* Improve linting performance

* Update husky and use pre-commit/lint-staged

* pre-commit + lint-staged

* Add pre-commit filename check

* lint-staged in development; full lint on Jenkins

* Fix Jenkinsfile

* Run pnpm audit on package.json changes

* eslint-plugin-progress "off"

* Use "jest --passWithNoTests" instead of "exit 0"

* Remove redundant geojson modules

* Reorganize test areas modules

Co-authored-by: mdurling <[email protected]>
Co-authored-by: Neil Goldader <[email protected]>

Author: 3 people

.eslintignore

@@ -0,0 +1 @@
+packages/mds-test-data/test-areas/

.eslintrc.json

@@ -4,7 +4,14 @@
     "es6": true,
     "mocha": true
   },
-  "plugins": ["import", "prettier", "@typescript-eslint", "promise"],
+  "plugins": [
+    "import",
+    "prettier",
+    "@typescript-eslint",
+    "promise",
+    "log",
+    "progress"
+  ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2018,
@@ -49,6 +56,7 @@
     "no-useless-constructor": "off",
     "no-var": "error",
     "prettier/prettier": "warn",
+    "progress/activate": "off",
     "promise/always-return": "error",
     "promise/avoid-new": "off",
     "promise/catch-or-return": "error",

.gitignore

@@ -1,12 +1,12 @@
-.npmrc
 .tern-project
 mds-*.zip
 dist
 dump.rdb
 
-# This project uses Yarn. Ignore npm lock files
+# This project uses pnpm. Ignore npm/yarn lock files
 package-lock.json
 npm-shrinkwrap.json
+yarn.lock
 
 # Created by https://www.gitignore.io/api/osx,node,windows,serverless,sublimetext,visualstudiocode
 # Edit at https://www.gitignore.io/?templates=osx,node,windows,serverless,sublimetext,visualstudiocode
@@ -19,6 +19,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+pnpx --no-install lint-staged
+pre-commit

.huskyrc.json

@@ -0,0 +1,4 @@
+{
+  "*.ts": "pnpm lint:eslint -- --fix",
+  "package.json": ["pnpm lint:prettier -- --write ", "pnpm lint:audit"]
+}

.iyarc

@@ -0,0 +1,7 @@
+link-workspace-packages = true
+prefer-workspace-packages = true
+recursive-install = true
+save-exact = true
+save-workspace-protocol = false
+scripts-prepend-node-path = true
+shared-workspace-shrinkwrap = true

.lintstagedrc.json

@@ -1,9 +1,10 @@
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.3.0
-  hooks:
-    - id: trailing-whitespace
-    - id: detect-aws-credentials
-      args: [--allow-missing-credentials]
-    - id: detect-private-key
-    - id: check-merge-conflict
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+      - id: check-merge-conflict
+      - id: check-case-conflict

.npmrc

@@ -11,5 +11,6 @@
         "singleQuote": true
       }
     }
-  ]
+  ],
+  "plugins": ["./node_modules/prettier-plugin-packagejson"]
 }

.pre-commit-config.yaml

@@ -416,7 +416,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -459,7 +459,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -593,7 +593,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -613,7 +613,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -656,7 +656,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -744,7 +744,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"
@@ -786,7 +786,7 @@
       "request": "launch",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
+        "${workspaceRoot}/node_modules/jest/bin/jest",
         "--runInBand",
         "--coverage",
         "false"

.prettierrc.json

@@ -17,7 +17,7 @@ pipeline {
       steps {
         nvm('version': 'v14.2.0') {
           sh '''
-          yarn clean && yarn build
+          pnpm clean && pnpm build
           '''
         }
       }
@@ -52,9 +52,9 @@ pipeline {
             }
             trap cleanup EXIT
 
-            yarn clean
-            PG_NAME=postgres PG_HOST=localhost PG_USER=postgres REDIS_HOST=localhost yarn test:eslint
-            PG_NAME=postgres PG_HOST=localhost PG_USER=postgres REDIS_HOST=localhost yarn test:unit
+            pnpm clean
+            pnpm lint
+            PG_NAME=postgres PG_HOST=localhost PG_USER=postgres REDIS_HOST=localhost pnpm test
           '''
         }
       }

.vscode/launch.json

@@ -84,68 +84,32 @@ Then add `export PG_NAME=mdstest` to your shell's environment file.  (The name i
 
 You should have NVM already installed from the link above.  The top level directory of the project has a `.nvmrc` file and you should be able to run `nvm install` to get the right version of Node.
 
-#### Package setup
-Install [Lerna](https://lerna.js.org/)
+#### Package manager setup
+Install [pnpm](https://pnpm.js.org/)
 
 ```sh
-yarn global add lerna
+npm install -g pnpm
 ```
 
-Install all packages.  Uses Yarn workspaces.
+Install all packages.  Uses pnpm workspaces.
 
 ```sh
-yarn install
+pnpm install
 ```
 
 #### Launching a local server for a package
 Now you can work with each package
 
 ```sh
 cd packages/mds-audit
-yarn test
-yarn start
+pnpm test
+pnpm start
 ```
 
 #### Running the tests
 You can also run all tests from the project root with
 ```
-yarn test
-```
-
-### Package Management - Lerna
-
-This repository is a monorepo and uses Lerna for working with its packages.
-
-#### Example commands
-
-Run all test suites at once
-
-```sh
-lerna run test
-```
-
-Run all tests suites sequentially
-
-```sh
-lerna run test --concurrency 1
-```
-
-Run tests for a particular package
-
-```sh
-lerna run test --scope mds-audit
-```
-
-Clean all dependencies
-
-```sh
-lerna run clean
-```
-
-Format all files
-
-```sh
-lerna run prettier
+pnpm test
 ```
 
 ## Debugging with Visual Studio Code
@@ -247,7 +211,7 @@ This will run the build, and create the docker container images.
 
 ```sh
 yarn clean
-NODE_ENV=development yarn image
+NODE_ENV=development pnpm image
 ```
 
 note that setting `NODE_ENV=development` will enable images to be built with the `:latest` tag instead of a specific version-branch-commit tag.  If you choose not to use this, the images will be built with tags matching the format `:version-branch-commit`.  You can generate a manifest with these image tags by running `yarn values`.  This manifest can be included in a helm install with the switch `--values dist/values.yaml`.

.yarnrc

@@ -1,27 +1,25 @@
 {
   "name": "@container-images/mds-agency",
   "version": "0.1.26",
-  "description": "Docker Image for MDS Agency API",
   "private": true,
+  "description": "Docker Image for MDS Agency API",
+  "keywords": [
+    "mds"
+  ],
+  "license": "Apache-2.0",
+  "author": "City of Los Angeles",
   "main": "dist/index.js",
   "files": [
     "dist/"
   ],
   "scripts": {
+    "bundle": "pnpm bundle:production",
     "bundle:development": "webpack --mode=development --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
     "bundle:production": "webpack --mode=production --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
-    "bundle": "yarn bundle:production",
-    "image:development": "yarn bundle:development && ../../bin/build-helper buildImage mds-agency:${npm_package_version}",
-    "image:production": "yarn bundle:production && ../../bin/build-helper buildImage mds-agency:${npm_package_version}",
-    "image": "yarn image:production",
-    "test": "yarn test:eslint",
-    "test:eslint": "eslint --ignore-path ../../.gitignore '**/*.ts'"
+    "image": "pnpm image:production",
+    "image:development": "pnpm bundle:development && ../../bin/build-helper buildImage mds-agency:${npm_package_version}",
+    "image:production": "pnpm bundle:production && ../../bin/build-helper buildImage mds-agency:${npm_package_version}"
   },
-  "keywords": [
-    "mds"
-  ],
-  "author": "City of Los Angeles",
-  "license": "Apache-2.0",
   "dependencies": {
     "@mds-core/mds-agency": "0.0.28",
     "@mds-core/mds-webpack-config": "0.1.0"

.yvmrc

@@ -1,27 +1,25 @@
 {
   "name": "@container-images/mds-attachment-service",
   "version": "0.0.1",
-  "description": "Docker Image for MDS Attachment Service",
   "private": true,
+  "description": "Docker Image for MDS Attachment Service",
+  "keywords": [
+    "mds"
+  ],
+  "license": "Apache-2.0",
+  "author": "City of Los Angeles",
   "main": "dist/index.js",
   "files": [
     "dist/"
   ],
   "scripts": {
+    "bundle": "pnpm bundle:production",
     "bundle:development": "webpack --mode=development --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
     "bundle:production": "webpack --mode=production --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
-    "bundle": "yarn bundle:production",
-    "image:development": "yarn bundle:development && ../../bin/build-helper buildImage mds-attachment-service:${npm_package_version}",
-    "image:production": "yarn bundle:production && ../../bin/build-helper buildImage mds-attachment-service:${npm_package_version}",
-    "image": "yarn image:production",
-    "test": "yarn test:eslint",
-    "test:eslint": "eslint --ignore-path ../../.gitignore '**/*.ts'"
+    "image": "pnpm image:production",
+    "image:development": "pnpm bundle:development && ../../bin/build-helper buildImage mds-attachment-service:${npm_package_version}",
+    "image:production": "pnpm bundle:production && ../../bin/build-helper buildImage mds-attachment-service:${npm_package_version}"
   },
-  "keywords": [
-    "mds"
-  ],
-  "author": "City of Los Angeles",
-  "license": "Apache-2.0",
   "dependencies": {
     "@mds-core/mds-attachment-service": "0.1.0",
     "@mds-core/mds-webpack-config": "0.1.0"