feat: support devEngines field (#50)

* feat: support `devEngines` field

* test: add test

Author: zanminkian

README.md

@@ -38,12 +38,13 @@ import { getUserAgent } from 'package-manager-detector/detect'
 
 ## Customize Detection Strategy
 
-By default, the `detect` API searches through the current directory for lock files, and if none exists, the `package.json` `packageManager` field. If both strategies couldn't detect the package manager, it'll crawl upwards to the parent directory and repeat the detection process until it reaches the root directory.
+By default, the `detect` API searches through the current directory for lock files, and if none exists, it looks for the `packageManager` field in `package.json`. If that also doesn't exist, it will check the `devEngines.packageManager` field in `package.json`. If all strategies couldn't detect the package manager, it'll crawl upwards to the parent directory and repeat the detection process until it reaches the root directory.
 
 The strategies can be configured through `detect`'s `strategies` option with the following accepted strategies:
 
 - `'lockfile'`: Look up for lock files.
 - `'packageManager-field'`: Look up for the `packageManager` field in package.json.
+- `'devEngines-field'`: Look up for the `devEngines.packageManager` field in package.json.
 - `'install-metadata'`: Look up for installation metadata added by package managers.
 
 The order of the strategies can also be changed to prioritize one strategy over another. For example, if you prefer to detect the package manager used for installation:
@@ -52,7 +53,7 @@ The order of the strategies can also be changed to prioritize one strategy over
 import { detect } from 'package-manager-detector/detect'
 
 const pm = await detect({
-  strategies: ['install-metadata', 'lockfile', 'packageManager-field']
+  strategies: ['install-metadata', 'lockfile', 'packageManager-field', 'devEngines-field']
 })
 ```
 

src/detect.ts

@@ -55,7 +55,7 @@ async function parsePackageJson(
  * @returns {Promise<DetectResult | null>} The detected package manager or `null` if not found.
  */
 export async function detect(options: DetectOptions = {}): Promise<DetectResult | null> {
-  const { cwd, strategies = ['lockfile', 'packageManager-field'], onUnknown } = options
+  const { cwd, strategies = ['lockfile', 'packageManager-field', 'devEngines-field'], onUnknown } = options
 
   for (const directory of lookup(cwd)) {
     for (const strategy of strategies) {
@@ -74,7 +74,8 @@ export async function detect(options: DetectOptions = {}): Promise<DetectResult
           }
           break
         }
-        case 'packageManager-field': {
+        case 'packageManager-field':
+        case 'devEngines-field': {
           // Look up for package.json
           const result = await parsePackageJson(path.join(directory, 'package.json'), onUnknown)
           if (result)
@@ -102,6 +103,21 @@ export async function detect(options: DetectOptions = {}): Promise<DetectResult
   return null
 }
 
+function getNameAndVer(pkg: { packageManager?: string, devEngines?: { packageManager?: { name?: string, version?: string } } }) {
+  const handelVer = (version: string | undefined) => version?.match(/\d+(\.\d+){0,2}/)?.[0] ?? version
+  if (typeof pkg.packageManager === 'string') {
+    const [name, ver] = pkg.packageManager.replace(/^\^/, '').split('@')
+    return { name, ver: handelVer(ver) }
+  }
+  if (typeof pkg.devEngines?.packageManager?.name === 'string') {
+    return {
+      name: pkg.devEngines.packageManager.name,
+      ver: handelVer(pkg.devEngines.packageManager.version),
+    }
+  }
+  return undefined
+}
+
 async function handlePackageManager(
   filepath: string,
   onUnknown: DetectOptions['onUnknown'],
@@ -110,16 +126,18 @@ async function handlePackageManager(
   try {
     const pkg = JSON.parse(await fs.readFile(filepath, 'utf8'))
     let agent: Agent | undefined
-    if (typeof pkg.packageManager === 'string') {
-      const [name, ver] = pkg.packageManager.replace(/^\^/, '').split('@')
+    const nameAndVer = getNameAndVer(pkg)
+    if (nameAndVer) {
+      const name = nameAndVer.name as AgentName
+      const ver = nameAndVer.ver
       let version = ver
-      if (name === 'yarn' && Number.parseInt(ver) > 1) {
+      if (name === 'yarn' && ver && Number.parseInt(ver) > 1) {
         agent = 'yarn@berry'
         // the version in packageManager isn't the actual yarn package version
         version = 'berry'
         return { name, agent, version }
       }
-      else if (name === 'pnpm' && Number.parseInt(ver) < 7) {
+      else if (name === 'pnpm' && ver && Number.parseInt(ver) < 7) {
         agent = 'pnpm@6'
         return { name, agent, version }
       }

src/types.ts

@@ -31,7 +31,7 @@ export interface ResolvedCommand {
   args: string[]
 }
 
-export type DetectStrategy = 'lockfile' | 'packageManager-field' | 'install-metadata'
+export type DetectStrategy = 'lockfile' | 'packageManager-field' | 'devEngines-field' | 'install-metadata'
 
 export interface DetectOptions {
   /**
@@ -46,9 +46,10 @@ export interface DetectOptions {
    *
    * - `'lockfile'`: Look up for lock files.
    * - `'packageManager-field'`: Look up for the `packageManager` field in package.json.
+   * - `'devEngines-field'`: Look up for the `devEngines.packageManager` field in package.json.
    * - `'install-metadata'`: Look up for installation metadata added by package managers.
    *
-   * @default ['lockfile', 'packageManager-field']
+   * @default ['lockfile', 'packageManager-field', 'devEngines-field']
    */
   strategies?: DetectStrategy[]
   /**

test/__snapshots__/detect.spec.ts.snap

@@ -1,5 +1,71 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`dev-engines > bun 1`] = `
+{
+  "agent": "bun",
+  "name": "bun",
+  "version": "0",
+}
+`;
+
+exports[`dev-engines > deno 1`] = `
+{
+  "agent": "deno",
+  "name": "deno",
+  "version": "2",
+}
+`;
+
+exports[`dev-engines > npm 1`] = `
+{
+  "agent": "npm",
+  "name": "npm",
+  "version": "7",
+}
+`;
+
+exports[`dev-engines > pnpm 1`] = `
+{
+  "agent": "pnpm",
+  "name": "pnpm",
+  "version": "8",
+}
+`;
+
+exports[`dev-engines > pnpm@6 1`] = `
+{
+  "agent": "pnpm@6",
+  "name": "pnpm",
+  "version": "6",
+}
+`;
+
+exports[`dev-engines > pnpm-version-range 1`] = `
+{
+  "agent": "pnpm",
+  "name": "pnpm",
+  "version": "8.0.0",
+}
+`;
+
+exports[`dev-engines > unknown 1`] = `null`;
+
+exports[`dev-engines > yarn 1`] = `
+{
+  "agent": "yarn",
+  "name": "yarn",
+  "version": "1",
+}
+`;
+
+exports[`dev-engines > yarn@berry 1`] = `
+{
+  "agent": "yarn@berry",
+  "name": "yarn",
+  "version": "berry",
+}
+`;
+
 exports[`install-metadata > bun 1`] = `
 {
   "agent": "bun",

test/detect.spec.ts

@@ -29,15 +29,15 @@ afterAll(() => {
   vi.resetAllMocks()
 })
 
-const fixtures = ['lockfile', 'packager', 'install-metadata']
+const fixtures = ['lockfile', 'packager', 'dev-engines', 'install-metadata']
 
 fixtures.forEach(fixture => describe(fixture, () => {
   const fixtureDirs = getFixtureDirs(fixture)
 
   fixtureDirs.forEach((dir) => {
     let options: DetectOptions | undefined
     if (fixture === 'install-metadata') {
-      options = { strategies: ['install-metadata', 'lockfile', 'packageManager-field'] }
+      options = { strategies: ['install-metadata', 'lockfile', 'packageManager-field', 'devEngines-field'] }
     }
     it(dir, detectTest(fixture, dir, options))
   })

test/fixtures/dev-engines/bun/package.json

@@ -0,0 +1,8 @@
+{
+  "devEngines": {
+    "packageManager": {
+      "name": "bun",
+      "version": "0"
+    }
+  }
+}

test/fixtures/dev-engines/deno/package.json

@@ -0,0 +1,8 @@
+{
+  "devEngines": {
+    "packageManager": {
+      "name": "deno",
+      "version": "2"
+    }
+  }
+}

test/fixtures/dev-engines/npm/package.json

@@ -0,0 +1,8 @@
+{
+  "devEngines": {
+    "packageManager": {
+      "name": "npm",
+      "version": "7"
+    }
+  }
+}

test/fixtures/dev-engines/pnpm-version-range/package.json

@@ -0,0 +1,8 @@
+{
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "^8.0.0"
+    }
+  }
+}

test/fixtures/dev-engines/pnpm/package.json

@@ -0,0 +1,8 @@
+{
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "8"
+    }
+  }
+}