npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pnpm/meta-updater

v2.0.3

Published

Keeps meta files up-to-date in a monorepo

Downloads

41,864

Readme

@pnpm/meta-updater

Keeps meta files up-to-date in a monorepo

npm version

Installation

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

Usage

Create a JavaScript file at .meta-updater/main.mjs that contains the updater functions.

Example 1

The following .meta-updater/main.mjs defines 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',
        },
      }
    },
  }
}

Example 2

The following .meta-updater/main.mjs defines format #ignore and updaters for .gitignore and .eslintrc using explicit format specifier.

import * as fs from 'fs/promises'
import { createFormat, createUpdateOptions } from '@pnpm/meta-updater'

/* default .eslintrc */
export const eslintrc = {}

/* default tsconfig.json */
export const tsconfig = { compilerOptions: { target: 'esnext' } }

/**
 * User-defined format '#ignore'
 */
const ignoreFormat = createFormat({
  async read({ resolvedPath }) {
    return (await fs.readFile(resolvedPath, 'utf8')).split('\n')
  },
  update(actual, updater, options) {
    return updater(actual, options)
  },
  equal(expected, actual) {
    return R.equals(expected, actual)
  },
  async write(expected, { resolvedPath }) {
    const unique = (array) => Array.from(new Set() < T[number] > array).sort()
    await fs.writeFile(resolvedPath, unique(expected).join('\n'), 'utf8')
  },
})

export default async (_workspaceDir) => {
  return createUpdateOptions({
    files: {
      // builtin
      'tsconfig.json': (actual, _options) => actual ?? tsconfig,
      // buildin .json format with explicit format specifier
      '.eslintrc [.json]': (actual) => actual ?? eslintrc,
      // user-defined `#ignore` format
      '.prettierignore [#ignore]': (actual) => actual ?? ['node_modules'],
    },
    formats: {
      '#ignore': ignoreFormat,
    },
  })
}

See more examples at src/examples/

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