feat: add script to update dependencies

Author: oliveriosousa

package.json

@@ -26,7 +26,8 @@
     "clean:build": "rimraf ./**/.parcel-cache",
     "clean:examples": "yarn workspaces run clean",
     "test:examples": "yarn workspaces run test:example",
-    "test": "yarn run test:examples"
+    "test": "yarn run test:examples",
+    "chore:update-dependencies": "node scripts/update-example-deps.js"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

scripts/update-example-deps.js

@@ -0,0 +1,98 @@
+'use strict'
+
+const path = require('path')
+const fs = require('fs')
+const execa = require('execa')
+
+// Where an example depends on `"ipfs": "^0.51.0"` and we've just released `ipfs@0.52.0`,
+// go through all of the examples and update the version to `"ipfs": "^0.52.0"` - do
+// that with every module under /packages
+
+const PACKAGES_DIR = path.resolve(__dirname, '../packages')
+const EXAMPLES_DIR = path.resolve(__dirname, '../examples')
+const DEP_TYPES = ['dependencies', 'devDependencies', 'optionalDependencies', 'peerDependencies']
+
+async function main () {
+  const {
+    stdout: branch
+  } = await execa('git', ['rev-parse', '--abbrev-ref', 'HEAD'])
+
+  if (branch !== 'master') {
+    console.info(`Not running on branch ${branch}`)
+    return
+  }
+
+  if (process.env.CI) {
+    console.info('Not running in CI')
+    return
+  }
+
+  console.info('Running on branch', branch)
+
+  // list all of the package.json files we may have just updated
+  const potentiallyUpdatedProjects = []
+
+  for (const dir of fs.readdirSync(PACKAGES_DIR)) {
+    const projectPkgPath = path.resolve(PACKAGES_DIR, dir, 'package.json')
+
+    if (!fs.existsSync(projectPkgPath)) {
+      continue
+    }
+
+    potentiallyUpdatedProjects.push(projectPkgPath)
+  }
+
+  // add the example test runner
+  potentiallyUpdatedProjects.push(path.resolve(EXAMPLES_DIR, 'test-ipfs-example', 'package.json'))
+
+  for (const projectPkgPath of potentiallyUpdatedProjects) {
+    const projectPkg = JSON.parse(fs.readFileSync(projectPkgPath, { encoding: 'utf8' }))
+    const projectDepVersion = `^${projectPkg.version}`
+
+    // look through all the example projects and update their deps
+    for (const dir of fs.readdirSync(EXAMPLES_DIR)) {
+      const examplePkgPath = path.resolve(EXAMPLES_DIR, dir, 'package.json')
+
+      if (!fs.existsSync(examplePkgPath)) {
+        continue
+      }
+
+      const examplePkg = JSON.parse(fs.readFileSync(examplePkgPath, { encoding: 'utf8' }))
+      let dirty = false
+
+      for (const depType of DEP_TYPES) {
+        if (examplePkg[depType] && examplePkg[depType][projectPkg.name] && examplePkg[depType][projectPkg.name] !== projectDepVersion) {
+          console.info(`Updating ${examplePkg.name} ${projectPkg.name}: ${examplePkg[depType][projectPkg.name]} -> ${projectDepVersion}`)
+          examplePkg[depType][projectPkg.name] = projectDepVersion
+          dirty = true
+        }
+      }
+
+      if (dirty) {
+        fs.writeFileSync(examplePkgPath, JSON.stringify(examplePkg, null, 2) + '\n', { encoding: 'utf8' })
+      }
+    }
+  }
+
+  await execa('git', ['add', 'examples'])
+
+  const {
+    stdout: updated
+  } = await execa('git', ['status', '--porcelain'])
+
+  console.info(updated)
+
+  if (!updated.match(/^M\s+examples/g)) {
+    console.info('No examples were updated')
+    return
+  }
+
+  console.info('Pushing updated dependencies')
+  await execa('git', ['commit', '-m', 'chore: updated example dependencies'])
+  await execa('git', ['push'])
+}
+
+main().catch(err => {
+  console.error(err)
+  process.exit(1)
+})