feat: workspace runtime argument

Author: Marcus Pousette

src/check-project/index.js

@@ -114,7 +114,7 @@ async function processMonorepo (projectDir, manifest, branchName, repoUrl, ciFil
 
   const projectDirs = []
 
-  for (const subProjectDir of await getSubprojectDirectories(projectDir, workspaces)) {
+  for (const subProjectDir of await getSubprojectDirectories(workspaces, projectDir)) {
     const stat = await fs.stat(subProjectDir)
 
     if (!stat.isDirectory()) {

src/cmds/run.js

@@ -1,5 +1,6 @@
 import { loadUserConfig } from '../config/user.js'
 import runCmd from '../run.js'
+import { listWorkspaces } from '../utils.js'
 
 /**
  * @typedef {import("yargs").Argv} Argv
@@ -39,6 +40,14 @@ export default {
           type: 'number',
           describe: 'How many scripts to run at the same time',
           default: userConfig.run.concurrency
+        },
+
+        workspaces: {
+          // an array of strings
+          array: true,
+          describe: 'Run the script in a specific workspace',
+          default: await listWorkspaces(process.cwd()),
+          alias: ['workspace', 'roots']
         }
       })
       .positional('script', {

src/docs/readme-updater-plugin.js

@@ -15,7 +15,7 @@ export function load (app) {
   let projects = {}
 
   if (isMonorepoParent) {
-    projects = parseProjects(process.cwd(), pkg.workspaces)
+    projects = parseProjects(pkg.workspaces)
   }
 
   // when rendering has finished, work out which UrlMappings refer to the index

src/exec.js

@@ -14,7 +14,7 @@ export default {
   async run (ctx) {
     const forwardArgs = ctx['--'] ? ctx['--'] : []
 
-    await everyMonorepoProject(process.cwd(), async (project) => {
+    await everyMonorepoProject(async (project) => {
       console.info('') // eslint-disable-line no-console
       console.info(kleur.grey(`${project.manifest.name}:`), `> ${ctx.command}${forwardArgs.length > 0 ? ` ${forwardArgs.join(' ')}` : ''}`) // eslint-disable-line no-console
 

src/release-rc.js

@@ -22,7 +22,7 @@ async function releaseMonorepoRcs (commit, ctx) {
   /** @type {Record<string, string>} */
   const versions = {}
 
-  await everyMonorepoProject(process.cwd(), async (project) => {
+  await everyMonorepoProject(async (project) => {
     if (project.manifest.private === true) {
       console.info(`Skipping private package ${project.manifest.name}`)
       return
@@ -43,7 +43,7 @@ async function releaseMonorepoRcs (commit, ctx) {
   console.info('')
 
   // publish packages
-  await everyMonorepoProject(process.cwd(), async (project) => {
+  await everyMonorepoProject(async (project) => {
     if (project.manifest.private === true) {
       console.info(`Skipping private package ${project.manifest.name}`)
       return

src/release.js

@@ -69,7 +69,7 @@ const tasks = new Listr([
       const {
         siblingVersions,
         packageDirs
-      } = await calculateSiblingVersions(rootDir, workspaces)
+      } = await calculateSiblingVersions(workspaces, rootDir)
 
       // check these dependency types for monorepo siblings
       const dependencyTypes = [
@@ -142,16 +142,16 @@ const tasks = new Listr([
 ], { renderer: 'verbose' })
 
 /**
- * @param {string} rootDir
  * @param {string[]} workspaces
+ * @param {string} rootDir
  */
-async function calculateSiblingVersions (rootDir, workspaces) {
+async function calculateSiblingVersions (workspaces, rootDir) {
   const packageDirs = []
 
   /** @type {Record<string, string>} */
   const siblingVersions = {}
 
-  for (const subProjectDir of await getSubprojectDirectories(rootDir, workspaces)) {
+  for (const subProjectDir of await getSubprojectDirectories(workspaces, rootDir)) {
     const pkg = JSON.parse(fs.readFileSync(path.join(subProjectDir, 'package.json'), {
       encoding: 'utf-8'
     }))

src/run.js

@@ -20,7 +20,7 @@ export default {
 
     const forwardArgs = ctx['--'] == null ? [] : ['--', ...ctx['--']]
 
-    await everyMonorepoProject(process.cwd(), async (project) => {
+    await everyMonorepoProject(async (project) => {
       for (const script of scripts) {
         if (project.manifest.scripts[script] == null) {
           continue
@@ -45,6 +45,7 @@ export default {
         }
       }
     }, {
+      workspaces: ctx.workspaces,
       concurrency: ctx.concurrency
     })
   }

src/test-dependant/index.js

@@ -196,7 +196,7 @@ const testMonoRepo = async (targetDir, deps, scriptName) => {
   }
 
   // test each package that depends on passed deps
-  for (const match of await getSubprojectDirectories(targetDir, config.workspaces)) {
+  for (const match of await getSubprojectDirectories(config.workspaces, targetDir)) {
     await testModule(path.join(targetDir, match), deps, scriptName)
   }
 }

src/types.ts

@@ -109,6 +109,7 @@ interface GlobalOptions {
    * Full config from configuration file
    */
   fileConfig: Options
+
 }
 
 interface BuildOptions {
@@ -391,9 +392,11 @@ interface ExecOptions {
    * Run commands in parallel up to this limit
    */
   concurrency?: number
+
 }
 
 interface RunOptions {
+
   /**
    * If false, the script will continue to be run in other packages
    */
@@ -408,6 +411,12 @@ interface RunOptions {
    * Run scripts in parallel up to this limit
    */
   concurrency?: number
+
+  /**
+   * Workspaces to run the command in
+   */
+  workspaces?: string[]
+
 }
 
 export type {

src/utils.js

@@ -332,6 +332,14 @@ export function findBinary (bin) {
   return bin
 }
 
+/**
+ * @param {string} projectDir
+ */
+export const listWorkspaces = async (projectDir) => {
+  const manifest = fs.readJSONSync(path.join(projectDir, 'package.json'))
+  return manifest.workspaces ?? undefined
+}
+
 /**
  * @typedef {object} Project
  * @property {any} manifest
@@ -341,21 +349,20 @@ export function findBinary (bin) {
  */
 
 /**
- * @param {string} projectDir
  * @param {(project: Project) => Promise<void>} fn
  * @param {object} [opts]
+ * @param {string[]?} [opts.workspaces]
  * @param {number} [opts.concurrency]
  */
-export async function everyMonorepoProject (projectDir, fn, opts) {
-  const manifest = fs.readJSONSync(path.join(projectDir, 'package.json'))
-  const workspaces = manifest.workspaces
-
-  if (!workspaces || !Array.isArray(workspaces)) {
+export async function everyMonorepoProject (fn, opts) {
+  const workspaces = (opts?.workspaces ?? await listWorkspaces(process.cwd())).filter((/** @type {string | null} */ workspace) => workspace != null)
+  if (!workspaces || !Array.isArray(workspaces) || workspaces.length === 0) {
     throw new Error('No monorepo workspaces found')
   }
 
   /** @type {Record<string, Project>} */
-  const projects = await parseProjects(projectDir, workspaces)
+
+  const projects = await parseProjects(workspaces)
 
   checkForCircularDependencies(projects)
 
@@ -398,25 +405,23 @@ export async function everyMonorepoProject (projectDir, fn, opts) {
 }
 
 /**
- *
- * @param {string} projectDir
  * @param {string[]} workspaces
+ * @param {string | undefined} cwd
  */
-export const getSubprojectDirectories = async (projectDir, workspaces) => fg.glob(workspaces, {
-  cwd: projectDir,
+export const getSubprojectDirectories = async (workspaces, cwd = process.cwd()) => fg.glob(workspaces, {
+  cwd,
   onlyFiles: false
 })
 
 /**
  *
- * @param {string} projectDir
  * @param {string[]} workspaces
  */
-export async function parseProjects (projectDir, workspaces) {
+export async function parseProjects (workspaces) {
   /** @type {Record<string, Project>} */
   const projects = {}
 
-  for (const subProjectDir of await getSubprojectDirectories(projectDir, workspaces)) {
+  for (const subProjectDir of await getSubprojectDirectories(workspaces)) {
     const stat = fs.statSync(subProjectDir)
 
     if (!stat.isDirectory()) {