feat: support .pnp.js when loading configurations. (#1307)

* feat: support `.pnp.js` when loading configurations.
* dev: be able to specify the list of .pnp files to search for
* dev: Add PnPSettings definitions
* dev: enable support for PnP

.eslintignore

@@ -2,3 +2,5 @@
 **/[Tt]emp
 **/[Ss]amples
 integration-tests/repositories
+test-packages/yarn2
+coverage

.github/workflows/coverage.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/[email protected]
 
       - run: npm ci
-
+      - run: npm run build
       - run: npm run coverage
 
       - name: Upload coverage Coveralls

.github/workflows/cspell-action.yml

@@ -10,4 +10,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
+      - run: npm run prepare-cspell-action
       - uses: streetsidesoftware/[email protected]

.github/workflows/cspell-cli.yml

@@ -10,4 +10,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
+      - run: npm run prepare-cspell-action
       - run: npx cspell@latest "**/*"

.github/workflows/integration-test.yml

@@ -48,6 +48,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - run: npm ci
+      - run: npm run build
       - name: Run Integration Tests ${{ matrix.repo }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -12,4 +12,5 @@ jobs:
       - uses: actions/[email protected]
       - uses: actions/[email protected]
       - run: npm ci
+      - run: npm run build
       - run: npm run lint-ci

.github/workflows/test.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - run: npm ci
-
+      - run: npm run build
       - run: npm test
 
       - name: verify trace command
@@ -66,7 +66,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - run: npm ci
-
+      - run: npm run build
       - run: npm test
 
       - name: verify trace command

.prettierignore

@@ -11,3 +11,4 @@ lerna.json
 tsconfig*.json
 packages/*/dist/
 **/package-lock.json
+coverage

cspell-dict.txt

@@ -25,6 +25,7 @@ liberapay
 licia
 liriliri
 macos
+medicalterms
 megistos
 micromatch
 monorepo
@@ -47,6 +48,7 @@ streetsidesoftware
 submodule
 tidelift
 tsdk
+untrusted
 webdeveric
 wireapp
 xregexp

cspell.code-workspace

@@ -1,38 +1,41 @@
 {
-	"folders": [
-		{
-			"name": "cspell-monorepo",
-			"path": "."
-		},
-		{
-			"path": "./integration-tests"
-		},
-		{
-			"path": "./packages/cspell-glob"
-		},
-		{
-			"path": "./packages/cspell-lib"
-		},
-		{
-			"path": "./packages/cspell-tools"
-		},
-		{
-			"path": "./packages/cspell-trie-lib"
-		},
-		{
-			"path": "./packages/cspell-trie"
-		},
-		{
-			"path": "./packages/cspell-trie2-lib"
-		},
-		{
-			"path": "./packages/cspell"
-		}
-	],
-	"settings": {
-		"typescript.tsdk": "cspell-monorepo/node_modules/typescript/lib",
-		"cSpell.customWorkspaceDictionaries": [
-			"workspace"
-		]
-	}
+    "folders": [
+        {
+            "name": "cspell-monorepo",
+            "path": "."
+        },
+        {
+            "path": "./integration-tests"
+        },
+        {
+            "path": "./packages/cspell-glob"
+        },
+        {
+            "path": "./packages/cspell-lib"
+        },
+        {
+            "path": "./packages/cspell-tools"
+        },
+        {
+            "path": "./packages/cspell-trie-lib"
+        },
+        {
+            "path": "./packages/cspell-trie"
+        },
+        {
+            "path": "./packages/cspell-trie2-lib"
+        },
+        {
+            "path": "./packages/cspell-types"
+        },
+        {
+            "path": "./packages/cspell"
+        }
+    ],
+    "settings": {
+        "typescript.tsdk": "cspell-monorepo/node_modules/typescript/lib",
+        "cSpell.customWorkspaceDictionaries": [
+            "workspace"
+        ]
+    }
 }

cspell.json

@@ -32,6 +32,8 @@
         "**/tsconfig.json",
         "test-packages/test-cspell-tools/src/*.txt",
         "cspell.json",
+        ".yarn",
+        ".pnp.{js,cjs}",
         "integration-tests/config/config.json",
         "integration-tests/config/repositories/**",
         "integration-tests/repositories/**",
@@ -44,5 +46,8 @@
     ],
     "ignoreWords": [
         "commitcomment"
+    ],
+    "words": [
+        "medicalterms"
     ]
 }

cspell.schema.json

@@ -452,6 +452,22 @@
           },
           "type": "array"
         },
+        "pnpFiles": {
+          "default": [
+            ".pnp.js",
+            ".pnp.cjs"
+          ],
+          "description": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "usePnP": {
+          "default": false,
+          "description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",
+          "type": "boolean"
+        },
         "words": {
           "description": "list of words to be always considered correct",
           "items": {
@@ -744,6 +760,17 @@
       },
       "type": "array"
     },
+    "pnpFiles": {
+      "default": [
+        ".pnp.js",
+        ".pnp.cjs"
+      ],
+      "description": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
     "showStatus": {
       "description": "Show status",
       "type": "boolean"
@@ -752,6 +779,11 @@
       "description": "Delay in ms after a document has changed before checking it for spelling errors.",
       "type": "number"
     },
+    "usePnP": {
+      "default": false,
+      "description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",
+      "type": "boolean"
+    },
     "userWords": {
       "description": "Words to add to global dictionary -- should only be in the user config file.",
       "items": {