@toptal/davinci-cli-shared 2.6.1 → 3.0.1-alpha-ff-79-27a22fcb.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change Log
 
+## 3.0.0
+
+### Major Changes
+
+- [#2643](https://github.com/toptal/davinci/pull/2643) [`ab9666f`](https://github.com/toptal/davinci/commit/ab9666f999e7a610f6068e0145200257d8511b46) Thanks [@rocodesign](https://github.com/rocodesign)!
+  Migrate package manager from Yarn to pnpm
+  **WHAT (breaking change):**
+  - switch package manager from Yarn to pnpm across the entire Davinci monorepo
+  - add `pnpm-workspace.yaml`, `.npmrc`, and `packageManager` field for corepack support
+  - convert Yarn `resolutions` to `pnpm.overrides` in root `package.json`
+  - update lerna `npmClient` from `yarn` to `pnpm`
+  - replace `yarn` with `pnpm` in root scripts (postinstall, test, test:unit:update)
+  **HOW to update:**
+  - install pnpm (`corepack enable` or `npm install -g pnpm@10.6.1`)
+  - replace `yarn install` with `pnpm install` in local workflows
+  - replace `yarn <script>` with `pnpm <script>` when running commands
+
+### Patch Changes
+
+- Updated dependencies [[`ab9666f`](https://github.com/toptal/davinci/commit/ab9666f999e7a610f6068e0145200257d8511b46)]:
+  - @toptal/davinci-workspace-root@2.0.0
+
 ## 2.6.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-cli-shared",
-  "version": "2.6.1",
+  "version": "3.0.1-alpha-ff-79-27a22fcb.1+27a22fcb",
   "description": "Shared CLI code and CLI engine for davinci",
   "author": "Toptal",
   "license": "SEE LICENSE IN LICENSE.MD",
@@ -15,11 +15,11 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' yarn jest"
+    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' pnpm jest"
   },
   "dependencies": {
     "@segment/analytics-node": "^2.1.3",
-    "@toptal/davinci-workspace-root": "^1.0.1",
+    "@toptal/davinci-workspace-root": "^2.0.1-alpha-ff-79-27a22fcb.1+27a22fcb",
     "chalk": "^4.1.2",
     "commander": "^11.0.0",
     "execa": "^5.1.1",
@@ -39,5 +39,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "27a22fcb012002a99ab87a4a996721e3ba8a92c4"
 }

package/src/index.js

@@ -2,6 +2,7 @@ import { createArgument, createOption } from 'commander'
 
 import cliPrint from './utils/print.cjs'
 import { run, runSync } from './utils/run.js'
+import { resolveBin } from './utils/resolve-bin.js'
 import { confirm, password, input, checkbox } from './utils/prompt.js'
 import { convertToCLIParameters } from './utils/convert-to-cli-parameters.js'
 import davinciConfig from './utils/davinci-project-config.cjs'
@@ -39,6 +40,7 @@ export const loadCommands = (
 
 export {
   davinciProjectConfig,
+  resolveBin,
   run,
   runSync,
   convertToCLIParameters,
@@ -84,6 +86,7 @@ export default {
   bootstrap,
   loadCommands,
   print,
+  resolveBin,
   run,
   runSync,
   prompt,

package/src/utils/files.js

@@ -17,7 +17,9 @@ export const getPackageFileContent = async (davinciPackageName, filename) => {
 }
 
 export const getPackageFilePath = (davinciPackageName, filename) => {
-  const packageIndexPath = require.resolve(davinciPackageName)
+  const packageIndexPath = require.resolve(davinciPackageName, {
+    paths: [process.cwd()],
+  })
   const davinciQARoot = path.join(packageIndexPath, '../..')
 
   return path.join(davinciQARoot, filename)
@@ -31,7 +33,7 @@ export const getProjectRootFilePath = filename => {
 
 export const projectHasPackage = pkg => {
   try {
-    require.resolve(pkg)
+    require.resolve(pkg, { paths: [process.cwd()] })
 
     return true
   } catch {

package/src/utils/package.js

@@ -1,20 +1,25 @@
+import fs from 'fs'
+import path from 'path'
+import { createRequire } from 'module'
 import semver from 'semver'
 import readPkgUp from 'read-pkg-up'
 
-import yarnAdapter from './yarn-adapter.js'
-
 export const getPackagePackageJson = cwd => {
   return readPkgUp.sync({ cwd }).packageJson
 }
 
 const getInstalledPackageVersion = packageName => {
-  const packageInfoList = yarnAdapter.list(packageName)
+  const requireFromCwd = createRequire(path.join(process.cwd(), 'package.json'))
+
+  try {
+    const packageEntryPath = requireFromCwd.resolve(packageName)
+    const packageJsonPath = readPkgUp.sync({ cwd: packageEntryPath }).path
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
 
-  if (!packageInfoList.size) {
+    return packageJson.version
+  } catch {
     return null
   }
-
-  return packageInfoList.get(packageName)
 }
 
 export const checkPrerequirement = ({ dependencies, packageName }) => {

package/src/utils/package.test.js

@@ -1,23 +1,20 @@
-import { jest } from '@jest/globals'
+import fs from 'fs'
+import os from 'os'
+import path from 'path'
 
 import { checkPrerequirement } from './package.js'
-import yarnAdapter from './yarn-adapter.js'
-
-const yarnAdapterListMock = jest.spyOn(yarnAdapter, 'list')
 
 const packageName = '@toptal/davinci-engine'
 const packageValidVersions = [
   '4.0.0',
-  '4',
-  '4.4',
+  '4.4.0',
+  '5.6.7',
   '4.1.13-alpha-FX-1234-my-branch.1',
-  '^3',
-  '~5.6.7',
 ]
 const packageInvalidVersions = [
   '2.0.0',
-  '6',
-  '1.4',
+  '6.0.0',
+  '1.4.0',
   '1.1.13-alpha-FX-1234-my-branch.1',
 ]
 const validVersionRange = '3 - 5'
@@ -25,11 +22,54 @@ const packageJsonDependencies = {
   [packageName]: validVersionRange,
 }
 
+const createProjectPackageJson = tempDir => {
+  fs.writeFileSync(
+    path.join(tempDir, 'package.json'),
+    JSON.stringify({
+      name: 'test-project',
+      private: true,
+      version: '1.0.0',
+    })
+  )
+}
+
+const installPackage = (tempDir, version) => {
+  const packageDir = path.join(
+    tempDir,
+    'node_modules',
+    ...packageName.split('/')
+  )
+
+  fs.mkdirSync(packageDir, { recursive: true })
+  fs.writeFileSync(
+    path.join(packageDir, 'package.json'),
+    JSON.stringify({
+      name: packageName,
+      main: 'index.js',
+      version,
+    })
+  )
+  fs.writeFileSync(path.join(packageDir, 'index.js'), 'module.exports = {}')
+}
+
 describe('package utils', () => {
+  let initialCwd
+  let tempDir
+
+  beforeEach(() => {
+    initialCwd = process.cwd()
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'davinci-package-test-'))
+    createProjectPackageJson(tempDir)
+    process.chdir(tempDir)
+  })
+
+  afterEach(() => {
+    process.chdir(initialCwd)
+    fs.rmSync(tempDir, { force: true, recursive: true })
+  })
+
   describe('checkPrerequirement', () => {
     it('should return an error when package is not installed', () => {
-      yarnAdapterListMock.mockReturnValueOnce(new Map())
-
       const result = checkPrerequirement({
         dependencies: packageJsonDependencies,
         packageName,
@@ -41,9 +81,7 @@ describe('package utils', () => {
     it.each(packageValidVersions)(
       `should return no errors for version %s in range ${validVersionRange}`,
       packageValidVersion => {
-        yarnAdapterListMock.mockReturnValueOnce(
-          new Map([[packageName, packageValidVersion]])
-        )
+        installPackage(tempDir, packageValidVersion)
 
         const result = checkPrerequirement({
           dependencies: packageJsonDependencies,
@@ -57,9 +95,7 @@ describe('package utils', () => {
     it.each(packageInvalidVersions)(
       `should return an error for version %s in range ${validVersionRange}`,
       packageInvalidVersion => {
-        yarnAdapterListMock.mockReturnValueOnce(
-          new Map([[packageName, packageInvalidVersion]])
-        )
+        installPackage(tempDir, packageInvalidVersion)
 
         const result = checkPrerequirement({
           dependencies: packageJsonDependencies,

package/src/utils/resolve-bin.js

@@ -0,0 +1,61 @@
+import { createRequire } from 'module'
+import path from 'path'
+import { readFileSync } from 'fs'
+
+/**
+ * Resolves a binary from a package's own dependencies.
+ *
+ * Under pnpm, transitive dependency binaries are not hoisted to the
+ * consumer's node_modules/.bin. This function uses the caller's
+ * import.meta.url so that require.resolve looks up from the Davinci
+ * package that actually declares the dependency, not from the consumer.
+ *
+ * @param {string} packageName  npm package that owns the binary (e.g. 'eslint', '@sentry/cli')
+ * @param {string} callerUrl    pass import.meta.url from the calling module
+ * @param {string} [binName]    name of the binary when it differs from the package's unscoped name
+ * @returns {string} absolute path to the binary
+ */
+export const resolveBin = (packageName, callerUrl, binName) => {
+  const req = createRequire(callerUrl)
+
+  let pkgJsonPath
+
+  try {
+    pkgJsonPath = req.resolve(`${packageName}/package.json`)
+  } catch {
+    // Some packages (e.g. lerna) have an exports map that doesn't expose
+    // package.json. Fall back to resolving the main entry and walking up.
+    const mainEntry = req.resolve(packageName)
+    const nodeModulesSegment = `node_modules/${packageName}`
+    const idx = mainEntry.lastIndexOf(nodeModulesSegment)
+
+    pkgJsonPath = path.join(
+      mainEntry.slice(0, idx + nodeModulesSegment.length),
+      'package.json'
+    )
+  }
+
+  const pkgDir = path.dirname(pkgJsonPath)
+  const pkgJson = JSON.parse(readFileSync(pkgJsonPath, 'utf8'))
+
+  const target = binName || packageName.split('/').pop()
+  const binField = pkgJson.bin
+
+  let binRelPath
+
+  if (typeof binField === 'string') {
+    binRelPath = binField
+  } else if (binField && binField[target]) {
+    binRelPath = binField[target]
+  } else if (binField) {
+    binRelPath = Object.values(binField)[0]
+  }
+
+  if (!binRelPath) {
+    throw new Error(
+      `Cannot resolve bin "${target}" from package "${packageName}"`
+    )
+  }
+
+  return path.resolve(pkgDir, binRelPath)
+}

package/src/utils/resolve-bin.test.js

@@ -0,0 +1,60 @@
+import path from 'path'
+import { fileURLToPath, pathToFileURL } from 'url'
+
+import { resolveBin } from './resolve-bin.js'
+
+// Build a caller URL that resolves from @toptal/davinci-monorepo's context
+// Use direct path instead of require.resolve since pnpm doesn't hoist workspace siblings
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const monorepoDir = path.resolve(__dirname, '../../../monorepo')
+const monorepoCallerUrl = pathToFileURL(
+  path.join(monorepoDir, 'src/index.js')
+).href
+
+describe('resolveBin', () => {
+  describe('when package exposes package.json in exports', () => {
+    it('resolves the binary path for a package with object bin field', () => {
+      // semver is a dependency of cli-shared and has bin: { semver: "bin/semver.js" }
+      const result = resolveBin('semver', import.meta.url)
+
+      expect(result).toContain('semver')
+      expect(result).toMatch(/bin\/semver\.js$/)
+    })
+  })
+
+  describe('when package does not expose package.json in exports', () => {
+    it('falls back to resolving via main entry', () => {
+      // lerna has an exports map that blocks package.json access
+      const result = resolveBin('lerna', monorepoCallerUrl)
+
+      expect(result).toContain('lerna')
+      expect(result).toMatch(/cli\.js$/)
+    })
+  })
+
+  describe('when custom binName is provided', () => {
+    it('resolves the correct binary', () => {
+      const result = resolveBin('npm-check-updates', monorepoCallerUrl, 'ncu')
+
+      expect(result).toContain('npm-check-updates')
+      expect(result).toMatch(/cli\.js$/)
+    })
+  })
+
+  describe('when package is not installed', () => {
+    it('throws an error', () => {
+      expect(() =>
+        resolveBin('nonexistent-package-xyz', import.meta.url)
+      ).toThrow()
+    })
+  })
+
+  describe('when package has no bin field', () => {
+    it('throws with a descriptive error', () => {
+      // ramda has no bin field
+      expect(() => resolveBin('ramda', monorepoCallerUrl)).toThrow(
+        /Cannot resolve bin/
+      )
+    })
+  })
+})

package/src/utils/yarn-adapter.js

@@ -1,47 +0,0 @@
-import { runSync } from './run.js'
-
-/**
- *
- * @param {string} treeName
- * @example '@toptal/davinci-engine@7.5.2'
- * @returns {Array} Pair package name and version, ex. ['@toptal/davinci-engine', '16.0.2']
- */
-const splitNameAndVersion = treeName => {
-  const atPos = treeName.lastIndexOf('@')
-
-  return [treeName.slice(0, atPos), treeName.slice(atPos + 1)]
-}
-
-export const createList = syncRun => packageName => {
-  const { stdout } = syncRun(
-    'yarn',
-    [
-      'list',
-      '--json',
-      '--no-progress',
-      '--non-interactive',
-      '--depth=0',
-      '--pattern',
-      packageName,
-    ],
-    {
-      stdio: undefined,
-    }
-  )
-
-  const listInfo = JSON.parse(stdout)
-  const packagesFound = listInfo?.data?.trees || []
-
-  if (packagesFound.length <= 0) {
-    return new Map()
-  }
-
-  return new Map(packagesFound.map(pkg => splitNameAndVersion(pkg.name)))
-}
-
-export const list = createList(runSync)
-
-export default {
-  list,
-  createList,
-}

package/src/utils/yarn-adapter.test.js

@@ -1,58 +0,0 @@
-import { jest } from '@jest/globals'
-
-import { createList } from './yarn-adapter.js'
-import run from './run.js'
-
-const packageName = 'find-up'
-const packageVersion = '5.0.0'
-const existingPackageResponseMock = `{"type":"tree","data":{"type":"list","trees":[{"name":"${packageName}@${packageVersion}","children":[],"hint":null,"color":null,"depth":0}]}}`
-const nonExistingPackageResponseMock = `{"type":"tree","data":{"type":"list","trees":[]}}`
-const invalidResponseMock = 'invalid-response'
-
-const runSyncMock = jest.spyOn(run, 'runSync')
-const yarnListInjected = createList(runSyncMock)
-
-describe('yarnAdapter', () => {
-  describe('list', () => {
-    it('should return a version for the existing package', () => {
-      runSyncMock.mockReturnValueOnce({
-        stdout: existingPackageResponseMock,
-      })
-
-      const result = yarnListInjected(packageName)
-
-      expect(result.size).toBe(1)
-      expect(result.get(packageName)).toBe(packageVersion)
-    })
-
-    it('should return empty map for non-existing package', () => {
-      runSyncMock.mockImplementationOnce(() => ({
-        stdout: nonExistingPackageResponseMock,
-      }))
-
-      const result = yarnListInjected(packageName)
-
-      expect(result.size).toBe(0)
-    })
-
-    it('should throw an error for invalid response', () => {
-      runSyncMock.mockReturnValueOnce({
-        stdout: invalidResponseMock,
-      })
-
-      expect(() => {
-        yarnListInjected(packageName)
-      }).toThrow()
-    })
-
-    it('should throw an error for empty response', () => {
-      runSyncMock.mockReturnValueOnce({
-        stdout: '',
-      })
-
-      expect(() => {
-        yarnListInjected(packageName)
-      }).toThrow()
-    })
-  })
-})