chore: migrate to npm from yarn (#469)

Author: alexander-akait

.cspell.json

@@ -36,5 +36,11 @@
     "zizizi",
     "codecov"
   ],
-  "ignorePaths": ["package.json", "yarn.lock", "coverage", "*.log"]
+  "ignorePaths": [
+    "package.json",
+    "yarn.lock",
+    "coverage",
+    "*.log",
+    ".gitignore"
+  ]
 }

.github/workflows/test.yml

@@ -18,9 +18,9 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: lts/*
-          cache: yarn
-      - run: yarn --frozen-lockfile
-      - run: yarn lint
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
   test:
     strategy:
       fail-fast: false
@@ -45,17 +45,17 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           architecture: ${{ steps.calculate_architecture.outputs.result }}
-          cache: yarn
+          cache: npm
       - name: Install dependencies
         run: |
-          yarn upgrade typescript@^4 --ignore-engines
-          yarn --frozen-lockfile
-        if: matrix.node-version == '10.x' || matrix.node-version == '12.x' || matrix.node-version == '14.x' || matrix.node-version == '16.x' || matrix.node-version == '18.x'
+          npm install -D typescript@^4 --ignore-scripts
+          npm install --ignore-scripts
+        if: matrix.node-version == '10.x' || matrix.node-version == '12.x' || matrix.node-version == '14.x'
       - name: Install dependencies
-        run: yarn --frozen-lockfile
-        if: matrix.node-version != '10.x'
+        run: npm ci
+        if: matrix.node-version != '10.x' && matrix.node-version != '12.x' && matrix.node-version != '14.x'
       - name: Run tests with coverage
-        run: yarn test:coverage -- --ci
+        run: npm run test:coverage -- --ci
       - uses: codecov/codecov-action@v5
         with:
           flags: integration

.gitignore

@@ -3,10 +3,11 @@
 /.nyc_output
 *.log
 .eslintcache
+.cspellcache
 
 # IDE
 .idea
 .vscode
 
 .DS_Store
-package-lock.json
+yarn.lock

.husky/.gitignore

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged
+npx --no-install lint-staged

.husky/pre-commit

@@ -152,7 +152,7 @@ enhanced-resolve will try to resolve requests containing `#` as path and as frag
 ## Tests
 
 ```sh
-yarn test
+npm run test
 ```
 
 ## Passing options from webpack

README.md

@@ -59,9 +59,9 @@ const runCallbacks = (callbacks, err, result) => {
 	if (error) throw error;
 };
 
-// eslint-disable-next-line jsdoc/no-restricted-syntax
+// eslint-disable-next-line jsdoc/reject-function-type
 /** @typedef {Function} EXPECTED_FUNCTION */
-// eslint-disable-next-line jsdoc/no-restricted-syntax
+// eslint-disable-next-line jsdoc/reject-any-type
 /** @typedef {any} EXPECTED_ANY */
 
 class OperationMergerBackend {

lib/CachedInputFileSystem.js

@@ -17,6 +17,14 @@ const {
 
 /** @typedef {import("./ResolverFactory").ResolveOptions} ResolveOptions */
 
+/**
+ * @typedef {object} KnownContext
+ * @property {string[]=} environments environments
+ */
+
+// eslint-disable-next-line jsdoc/reject-any-type
+/** @typedef {KnownContext & Record<any, any>} Context */
+
 /** @typedef {Error & { details?: string }} ErrorWithDetail */
 
 /** @typedef {(err: ErrorWithDetail | null, res?: string | false, req?: ResolveRequest) => void} ResolveCallback */
@@ -289,9 +297,6 @@ const {
 /** @typedef {JsonPrimitive | JsonObject | JsonArray} JsonValue */
 /** @typedef {{ [Key in string]?: JsonValue | undefined }} JsonObject */
 
-// eslint-disable-next-line jsdoc/require-property
-/** @typedef {object} Context */
-
 /**
  * @typedef {object} BaseResolveRequest
  * @property {string | false} path path
@@ -456,7 +461,7 @@ class Resolver {
 	}
 
 	/**
-	 * @param {object} context context information object
+	 * @param {Context} context context information object
 	 * @param {string} path context path
 	 * @param {string} request request string
 	 * @returns {string | false} result
@@ -483,7 +488,7 @@ class Resolver {
 	}
 
 	/**
-	 * @param {object} context context information object
+	 * @param {Context} context context information object
 	 * @param {string} path context path
 	 * @param {string} request request string
 	 * @param {ResolveContext} resolveContext resolve context

lib/Resolver.js

@@ -9,9 +9,9 @@
 /** @typedef {import("./Resolver").StringCallback} StringCallback */
 /** @typedef {import("./Resolver").SyncFileSystem} SyncFileSystem */
 
-// eslint-disable-next-line jsdoc/no-restricted-syntax
+// eslint-disable-next-line jsdoc/reject-function-type
 /** @typedef {Function} SyncOrAsyncFunction */
-// eslint-disable-next-line jsdoc/no-restricted-syntax
+// eslint-disable-next-line jsdoc/reject-any-type
 /** @typedef {any} ResultOfSyncOrAsyncFunction */
 
 /**

lib/SyncAsyncFileSystemDecorator.js

@@ -10,6 +10,7 @@ const memoize = require("./util/memoize");
 /** @typedef {import("./CachedInputFileSystem").BaseFileSystem} BaseFileSystem */
 /** @typedef {import("./PnpPlugin").PnpApiImpl} PnpApi */
 /** @typedef {import("./Resolver")} Resolver */
+/** @typedef {import("./Resolver").Context} Context */
 /** @typedef {import("./Resolver").FileSystem} FileSystem */
 /** @typedef {import("./Resolver").ResolveCallback} ResolveCallback */
 /** @typedef {import("./Resolver").ResolveContext} ResolveContext */
@@ -20,16 +21,16 @@ const memoize = require("./util/memoize");
 
 /**
  * @typedef {{
- * (context: object, path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
- * (context: object, path: string, request: string, callback: ResolveCallback): void;
+ * (context: Context, path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
+ * (context: Context, path: string, request: string, callback: ResolveCallback): void;
  * (path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
  * (path: string, request: string, callback: ResolveCallback): void;
  * }} ResolveFunctionAsync
  */
 
 /**
  * @typedef {{
- * (context: object, path: string, request: string): string | false;
+ * (context: Context, path: string, request: string): string | false;
  * (path: string, request: string): string | false;
  * }} ResolveFunction
  */