@pnpm/meta-updater

@pnpm/meta-updater

Keeps meta files up-to-date in a monorepo

Installation

<pnpm|yarn|npm> add @pnpm/meta-updater

Usage

Create a JavaScript file at .meta-updater/main.mjs that contains the updater functions. For instance, the next file will have updaters for package.json and tsconfig.json files:

export default (workspaceDir) => {
  return {
    'package.json': (manifest, dir) => {
      return {
        ...manifest,
        author: 'Foo Bar',
      }
    },
    'tsconfig.json': (tsConfig, dir) => {
      return {
        ...tsConfig,
        compilerOptions: {
          outDir: 'lib',
          rootDir: 'src',
        },
      }
    },
  }
}

To perform the update on the affected config files, run pnpm meta-updater.

To check that all meta files are up-to-date, run pnpm meta-updater --test. It is recommended to always check the meta files before running the tests, so add it to your test command:

{
  "test": "meta-updater --test && jest"
}

API

Updater Function: (config | null, dir, manifest) => Promise<config | null>

The updater function recieves the config object or null (if the config file does not exist). The updater function returns the config object that should be saved. If the updater function returns null, the config should be removed.

License

MIT © Zoltan Kochan