lerna-npm-readme-hack v1.0.6

lerna-npm-readme-hack

npm README's, as published by lerna, don't update. bummer! see https://github.com/npm/registry/issues/42

solution

provide a CLI to get READMEs up to date!

install

npm i --save-dev lerna-npm-readme-hack

usage

• lerna publish as usual, then run this utility to get your docs on npm up to date

// package.json
{
  "scripts": {
    "publish": "lerna publish && lerna-npm-readme-hack", // or
    "publish": "lerna publish && lerna-npm-readme-hack --packages-dir modules", // or
    "publish": "lerna publish && lerna-npm-readme-hack --packages pkg1,pkg2"
  }
}

• the CLI has some useful info: ./node_modules/.bin/lerna-npm-readme-hack --help

🛰  lerna-npm-readme-hack$ ./bin/lerna-npm-readme-hack.js --help

  Usage: lerna-npm-readme-hack [options]

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -d, --packages-dir [path]  packages dir. assumes lerna packages in `packages` by default
    -p, --packages <names>     packages to publish readme for. assumes all folders with a README[.*] in the packages-dir