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

brainwave

v0.0.6

Published

Programmatically update frontmatter without leaving JS

Downloads

7

Readme

brainwave

brainwave

Walk the files and control the ones with frontmatter in them

Let's say you have a bunch of files with frontmatter in them. Like MDX or similar. Let's say you have fields in that frontmatter that you wanna be able to query against, or manipulate, but you don't wanna do it by hand.

Use brainwave!

Installation

yarn global add brainwave

Disclaimer

brainwave is a powerful tool which can change tons of files in your codebase. Using brainwave in a folder without version control is likely a mistake. Protect yourself. Remember to use the --dryRun flag to see what would have run instead. Use brainwave at your own risk. Please log any issues on Github.

Usage

  1. cd your-project
  2. brainwave --init - generate a basic brainwave.config.js file
  3. Open brainwave.config.js in your favorite editor and make changes relative to your codebase:
module.exports = {
  // telepathy specifies function predicates to run against the codebase
  telepathy: {
    // this will print out all files which have a "review" key in their frontmatter
    review: z => z && z.review
  },
  // control specifies both predicates and mutations, each a function
  control: {
    edited: [
      // *REMEMBER* to use --dryRun and it will instead tell you what _would_ be modified
      // this runs always!
      () => true,
      // it will add / update dateEdited field in the mdx files
      x => (
        x && x.stats && x.stats.ctime
        ? { dateEdited: new Date(x.stats.ctime) }
        : {}
      )
    ]
  }
}
  1. Once you've made changes, run brainwave --telepathy to see only telepathy calls.
  2. Run brainwave --dryRun to see what your changes in control will do.
  3. If you're happy with the changes you're about to make (and you're using version control like a sane person), try running brainwave with no --dryRun flag, and it will update all .mdx and .md file in the local folder, excluding node_modules.

Built by