@toptal/davinci-update 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @toptal/davinci-update
+
+## 1.0.1
+
+### Patch Changes
+
+- [#2393](https://github.com/toptal/davinci/pull/2393) [`8400c60f`](https://github.com/toptal/davinci/commit/8400c60f55ef8c82e99e22404009d2b1ad57aa40) Thanks [@mkrl](https://github.com/mkrl)!
+
+### davinci-update
+
+- adds a utility that updates Picasso and Davinci alpha packages using a PR link

package/bin/davinci-update.mjs

@@ -1,10 +1,8 @@
 #!/usr/bin/env node
 
-import cliEngine from '@toptal/davinci-cli-shared'
+import { loadCommands, bootstrap } from '@toptal/davinci-cli-shared'
 
-import updater from '../src/index.mjs'
+import { fromCommand } from '../src/commands/from.mjs'
 
-const { commands } = updater
-
-cliEngine.loadCommands(commands, 'davinci-update')
-cliEngine.bootstrap()
+loadCommands([fromCommand], 'davinci-update')
+bootstrap()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-update",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Update Picasso, Davinci and Topkit packages from a pull request",
   "repository": "toptal/davinci.git",
   "author": "Toptal",
@@ -17,7 +17,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' yarn jest"
+    "test": "exit 0"
   },
   "dependencies": {
     "@toptal/davinci-cli-shared": "^2.4.0",

package/src/actions.mjs

@@ -1,31 +1,28 @@
-import { $, print } from '@toptal/davinci-cli-shared'
+import { $, print, spinner, globby, prompt } from '@toptal/davinci-cli-shared'
 import { promises as fs } from 'fs'
 
-export const ghInstalled = async () => {
-  const isInstalled = (await $`gh version`.exitCode) === 0
-  if (!isInstalled) {
+export const ensureGhIsInstalled = async () => {
+  try {
+    await $`gh version`
+    return true
+  } catch (err) {
     print.red(
       'GitHub CLI is not installed. Please install and authenticate before running this command.'
     )
     print.red('https://cli.github.com/')
     process.exit(1)
   }
-  return isInstalled
 }
 
 export const fetchComments = async prLink => {
   const spinner = print.startSpinner('Fetching PR comments...')
   const request = await $`gh pr view ${prLink} --json comments`
-  if (request.exitCode !== 0) {
-    print.red('Error fetching comments')
-    process.exit(1)
-  }
   spinner.stop()
   print.green('Fetched PR comments')
   return JSON.parse(request.stdout)
 }
 
-export const parseLatestAlpha = comments => {
+export const extractLatestAlphaFromComments = comments => {
   const alphaComments = comments.filter(comment =>
     comment.body.includes('Your alpha package is ready')
   )
@@ -35,9 +32,9 @@ export const parseLatestAlpha = comments => {
     )
     process.exit(1)
   }
-  const latestAlpha = alphaComments.sort(
-    (a, b) => new Date(b.createdAt) - new Date(a.createdAt)
-  )[0]
+  const [latestAlpha] = alphaComments.sort(
+    (a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime()
+  )
   const packages = latestAlpha.body.split('<br/>').slice(1).slice(0, -1)
   const packagesSanitized = packages.map(line =>
     line.replace(/.*`yarn add (.*)`.*/, '$1')
@@ -61,29 +58,15 @@ const processPackageJson = async (file, packages) => {
     const packageJson = JSON.parse(await fs.readFile(file, 'utf-8'))
     let packageUpdated = false
     Object.keys(packages).forEach(pkg => {
-      if (
-        packageJson.dependencies &&
-        packageJson.dependencies[pkg] &&
-        packages[pkg] !== packageJson.dependencies[pkg]
-      ) {
-        packageJson.dependencies[pkg] = packages[pkg]
-        packageUpdated = true
-      }
-      if (
-        packageJson.devDependencies &&
-        packageJson.devDependencies[pkg] &&
-        packages[pkg] !== packageJson.devDependencies[pkg]
-      ) {
-        packageJson.devDependencies[pkg] = packages[pkg]
-        packageUpdated = true
-      }
-      if (
-        packageJson.peerDependencies &&
-        packageJson.peerDependencies[pkg] &&
-        packages[pkg] !== packageJson.peerDependencies[pkg]
-      ) {
-        packageJson.peerDependencies[pkg] = packages[pkg]
-        packageUpdated = true
+      for (const deps of [
+        packageJson.dependencies,
+        packageJson.devDependencies,
+        packageJson.peerDependencies,
+      ]) {
+        if (deps?.[pkg] && deps[pkg] !== packages[pkg]) {
+          deps[pkg] = packages[pkg]
+          packageUpdated = true
+        }
       }
     })
     if (packageUpdated) {
@@ -97,18 +80,51 @@ const processPackageJson = async (file, packages) => {
   }
 }
 
+export const updateResolutions = async packages => {
+  try {
+    const selectedPackages = await prompt.checkbox(
+      'packages',
+      'Select packages to update',
+      Object.keys(packages).map(pkg => ({
+        name: pkg,
+        value: pkg,
+      })),
+      15
+    )
+    const packageJson = JSON.parse(await fs.readFile('./package.json', 'utf-8'))
+    packageJson.resolutions = packageJson.resolutions || {}
+    selectedPackages.forEach(pkg => {
+      packageJson.resolutions[pkg] = packages[pkg]
+    })
+    await fs.writeFile(
+      './package.json',
+      `${JSON.stringify(packageJson, null, 2)}\n`
+    )
+  } catch (e) {
+    print.red(`Could not update resolutions in package.json`)
+    console.error(e)
+    process.exit(1)
+  }
+  print.green('Updated resolutions in package.json')
+  return true
+}
+
 export const updatePackageJsonFiles = async packages => {
-  const spinner = print.startSpinner(
-    'Updating package.json files in the current repository...'
-  )
-  const packageJsonFiles =
-    await $`find . -type f -name "package.json" | grep -v '/node_modules/' | grep -v '/dist-package/' | grep -v '/dist/' | grep -v '/__tests__/'`
-  const files = packageJsonFiles.stdout.split('\n').filter(Boolean)
-  const resolvedPackages = await Promise.all(
-    files.map(file => processPackageJson(file, packages))
+  const updatedPackages = await spinner(
+    'Updating package.json files in the current repository...',
+    async () => {
+      const packageJsonFiles = await globby(
+        ['**/package.json', 'package.json'],
+        {
+          gitignore: true,
+        }
+      )
+      const resolvedPackages = await Promise.all(
+        packageJsonFiles.map(file => processPackageJson(file, packages))
+      )
+      return resolvedPackages.filter(Boolean)
+    }
   )
-  spinner.stop()
-  const updatedPackages = resolvedPackages.filter(Boolean)
   if (updatedPackages.length === 0) {
     print.yellow('No package.json files were updated.')
     return false
@@ -118,47 +134,63 @@ export const updatePackageJsonFiles = async packages => {
 }
 
 export const runSyncpack = async () => {
-  const spinner = print.startSpinner('Running syncpack fix-mismatches ...')
-  const request = await $`yarn run syncpack fix-mismatches`
-  spinner.stop()
-  if (request.exitCode !== 0) {
-    print.red('Error running syncpack')
-  }
+  await spinner(
+    'Running syncpack fix-mismatches ...',
+    async () => await $`yarn run syncpack fix-mismatches`
+  )
   print.green('Running syncpack fix-mismatches finished successfully')
 }
 
 export const yarnInstall = async () => {
-  const spinner = print.startSpinner('Running yarn install...')
-  const request = await $`yarn install`
-  spinner.stop()
-  if (request.exitCode !== 0) {
-    print.red('Error running yarn install')
-    process.exit(1)
-  }
+  await spinner('Running yarn install...', async () => await $`yarn install`)
   print.green('A new yarn.lock is generated!')
 }
 
-export const createPullRequest = async prLink => {
-  print.grey(`Creating a Pull Request with the updated packages`)
-
+export const createOrUpdatePullRequest = async prLink => {
   const branchName = `fx-${prLink.split('/').at(-3)}-pr-${prLink
     .split('/')
     .at(-1)}-update-alpha`
-  const spinner1 = print.startSpinner(
-    `Committing changes to a new branch ${branchName}`
-  )
-  await $`git checkout -b ${branchName}`
-  await $`git add .`
-  await $`git commit -m "Update to alpha packages"`
-  spinner1.stop()
-  const spinner2 = print.startSpinner(`Pushing...`)
-  await $`git push --set-upstream origin ${branchName}`
-  spinner2.stop()
-  const spinner3 = print.startSpinner(
-    `Creating a draft Pull Request to master...`
-  )
-  const result =
-    await $`gh pr create -d --title "Update to alpha packages" --body "This PR updates packages to the latest alpha versions found in ${prLink}" --base master`
-  spinner3.stop()
-  print.success(`Created a draft Pull Request: ${result.stdout}`)
+  try {
+    await spinner(`Checking if a ${branchName} already exists...`, async () => {
+      await $`git fetch`
+      // Using --exit-code on a remote origin, this will fail if the branch exists
+      await $`git ls-remote --exit-code --heads origin ${branchName}`
+    })
+    // Branch already exists
+    await spinner(
+      `Branch ${branchName} already exists, pushing new changes to the branch...`,
+      async () => {
+        await $`git checkout ${branchName}`
+        await $`git add .`
+        await $`git commit -m "Update to alpha packages"`
+        await $`git push origin ${branchName}`
+      }
+    )
+    print.success(`Pushed new changes to remote ${branchName}`)
+  } catch {
+    // Branch does not exist
+    print.grey(`Creating a Pull Request with the updated packages`)
+    try {
+      await spinner(
+        `Committing changes to a new branch ${branchName}`,
+        async () => {
+          await $`git checkout -b ${branchName}`
+          await $`git add .`
+          await $`git commit -m "Update to alpha packages"`
+        }
+      )
+      await spinner(`Pushing...`, async () => {
+        await $`git push --set-upstream origin ${branchName}`
+      })
+      const result = await spinner(
+        `Creating a draft Pull Request to master...`,
+        () =>
+          $`gh pr create -d --title "Update to alpha packages" --body "This PR updates packages to the latest alpha versions found in ${prLink}" --base master`
+      )
+      print.success(`Created a draft Pull Request: ${result.stdout}`)
+    } catch {
+      print.red('Failed to commit changes and create a PR')
+      process.exit(1)
+    }
+  }
 }

package/src/commands/from.mjs

@@ -1,36 +1,45 @@
 import { print, createArgument, $ } from '@toptal/davinci-cli-shared'
 import {
-  ghInstalled,
+  ensureGhIsInstalled,
   fetchComments,
-  parseLatestAlpha,
+  extractLatestAlphaFromComments,
   updatePackageJsonFiles,
   runSyncpack,
   yarnInstall,
-  createPullRequest,
+  createOrUpdatePullRequest,
+  updateResolutions,
 } from '../actions.mjs'
 
-const updateFrom = async (prLink, { createPr, syncpack }) => {
+const updateFrom = async (prLink, { createPr, syncpack, resolutions }) => {
   $.verbose = false
   print.header(
-    'Updating packages in the current repository to the latest alpha in ',
+    `Updating ${
+      resolutions ? 'resolutions' : 'packages'
+    } in the current repository to the latest alpha in `,
     prLink,
-    createPr ? 'and creating a new PR' : ''
+    createPr ? 'and creating (or updating) a new PR' : ''
   )
 
-  if (await ghInstalled()) {
+  if (await ensureGhIsInstalled()) {
     const { comments } = await fetchComments(prLink)
-    const packages = parseLatestAlpha(comments)
-    const didUpdate = await updatePackageJsonFiles(packages)
+    const packages = extractLatestAlphaFromComments(comments)
+    const didUpdate = resolutions
+      ? await updateResolutions(packages)
+      : await updatePackageJsonFiles(packages)
     if (didUpdate) {
-      if (syncpack) {
+      if (syncpack && !resolutions) {
         await runSyncpack()
       } else {
         print.yellow('Skipping syncpack')
       }
       await yarnInstall()
       if (createPr) {
-        await createPullRequest(prLink)
+        await createOrUpdatePullRequest(prLink)
       }
+    } else {
+      print.yellow(
+        'Nothing to update. Perhaps you already have the versions you need or using a wrong directory? Exiting...'
+      )
     }
   }
   process.exit(0)
@@ -46,10 +55,17 @@ export const fromCommand = program => {
         'Link to a Picasso, Davinci or Topkit pull request with alpha packages generated'
       )
     )
-    .option('-C, --create-pr', 'Automatically create a PR when finished')
+    .option(
+      '-C, --create-pr',
+      'Automatically create or update a PR when finished'
+    )
     .option(
       '-S, --no-syncpack',
       'Do not run syncpack fix after updating package.json files'
     )
+    .option(
+      '-R, --resolutions',
+      'Update resolutions in root package.json. This will only update one file and prompt you to select the packages. Skips running syncpack automatically.'
+    )
     .action(updateFrom)
 }

package/src/index.mjs

@@ -1,9 +0,0 @@
-import { fromCommand } from './commands/from.mjs'
-
-export const commands = [
-  fromCommand,
-]
-
-export default {
-  commands
-}