Provide programmatic API about wsrun HOT 4 CLOSED

You don't need to add a npm script to every individual module.

Instead, you can make a module containing tool scripts, and make sure that they are specified in "bin" field of package.json. That will make them automatically available without having script entries in individual package.jsons

You can also use existing commands like that. For example, yarn wsrun tsc will run the typescript compiler command on every package, yarn wsrun mocha will run the mocha command in every package. As long as the script is found in node_modules/.bin, yarn will use it.

If you are not happy with yarn's behavior you can go a step further and use a different runner. To save on yarn memory usage we use a bash based runner in our monorepo:

#!/bin/bash

export PATH=$PWD/node_modules/.bin:$PATH
VERBOSE='1'
if [ "$1" == '-s' ]; then VERBOSE=''; shift; fi
if [ "$1" == 'run' ]; then shift; fi

RUNCMD=$(node -e "console.log(JSON.parse(fs.readFileSync('package.json', 'utf8')).scripts['$1'])")

if [ "xundefined" = "x$RUNCMD" ]
then
  RUNCMD=$1
fi

BASHCMD="$RUNCMD ${@:2}"
if [ $VERBOSE ]; then echo '$' $BASHCMD; fi;
exec bash -c "$BASHCMD"

and at the monorepo root we have a script alias called

"scripts":{
  "wsrun-custom":"wsrun --bin=runner.sh"
}

In addition to

• package.json scripts (yarn wsrun-custom build),
• locally installed binaries (yarn wsrun-custom mocha),

this runner also supports

• anything you have in your PATH (yarn wsrun-custom git diff master package.json)
• even built in bash commands (e.g. yarn wsrun-custom echo 'Hello world'),

for ultimate flexibility 😀

from wsrun.

Can you give a more specific example of what you would like to accomplish?

Our typical pattern is to have a "tool" package in the monorepo that has a few "bin" fields pointing to commonly used scripts. Then after a yarn install we're able to run, for example:

wsrun -c bin-script-to-update-config --key key --value value

note: you might need a yarn install --force

This will work even if the individual packages don't have a script - yarn falls back to trying to run the command.

from wsrun.

I'll try to give an example of what I mean.

with the current capabilities, I can run a command on all modules.
but let's say I want to do something a bit more complex:
Let's say I keep a list.json file of all my shared dependencies (names and versions), and I wish to update a major version of one of my dependencies.
Instead of doing it manually (editing each package.json), I want to run a script that does exactly that.

The problem is that this script doesn't know what modules I have in my workspace.
If I will be able to do something like this:

const fs = require("fs");
const wsrun = require("wsrun");
const allModules = require("./list.json");

wsrun.packages().forEach(pkg => {
  const {name, path} = pkg;
  console.log(`update ${name}`);

  const packageJson = JSON.parse(fs.readFileSync(path));
  packageJson.dependencies = { ...packageJson.dependencies, ...allModules };

  fs.writeFileSync(path, JSON.stringify(packageJson), "utf-8");
})

It will be useful for those complex scenarios.

just to clarify, this is possible today by passing arguments to a script, but then I need to add an npm script inside each and every one of my modules, which kind of misses the point IMO.

from wsrun.

I finally got it.

it works perfectly. Thanks.

closing :)

from wsrun.