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 🙏

© 2021 – Pkg Stats / Ryan Hefner

@jcoreio/js

v1.1.5

Published

build tools and package scripts for npm packages

Downloads

49

Readme

@jcoreio/js

CircleCI semantic-release Commitizen friendly npm version

This is my personal skeleton for creating an npm package with JS(/flow) source code.

Assumptions

  • All source files are in src
  • Test files are in test. You can override this by specifying options for mocha in ['@jcoreio/js'].mochaArgs in your package.json.
  • You want to publish the package via semantic-release
  • You're using CircleCI

Usage

yarn add --dev @jcoreio/js
yarn toolchain bootstrap

If you want to more aggressively replace existing configuration, use yarn toolchain bootstrap --hard.

The bootstrap script will modify your package.json, .gitignore, .circleci/config.yml and generate .babelrc.js, .eslintrc.js, and .prettierrc.js that are just proxies for the config in @jcoreio/js.

Instead of running scripts from your package.json, you can run them with the yarn toolchain command (or yarn tc), for example yarn toolchain lint. Run yarn toolchain by itself to see all of the available commands.

Customization

You can customize the config files created by the bootstrap process:

  • babel.config.js
  • commitlint.config.js
  • husky.config.js
  • lint-staged.config.js
  • nyc.config.js
  • prettier.config.js

You can also set the following options in the @jcoreio/js property in your package.json:

  • mochaArgs: an array of additional arguments to mocha (default: ["test/**.js"], or .ts/.tsx depending on the toolchain)
  • noBabelRuntime: if true, disables @babel/plugin-transform-flow-runtime

For example:

{
  "name": "foo",
  "@jcoreio/js": {
    "mochaArgs": ["test/index.js"]
  }
}

babel.config.js

You can pass a second argument to the base babel config like this:

/* eslint-env node */
module.exports = function (api) {
  return require(`@jcoreio/js/babel.config.js`)(api, {
    envPresetOptions: {
      target: {node: 12},
      forceAllTransforms: false,
    },
    babelRuntime: false,
  })
}

It accepts the following options:

  • envPresetOptions: overrides options for @babel/preset-env
  • babelRuntime: if false, won't use @babel/plugin-transform-runtime

Package Publishing

Files to publish are output/copied into the dist folder and then published from there. This includes a derived package.json with various development-only fields removed and automatically-generated main, module, and exports fields added.

The toolchain will do the following for JS (similar for TS):

  • Transpile src/**.js to dist/**.js (CommonJS modules)
  • Transpile src/**.js to dist/**.mjs (ES modules)
  • Copy src/**.js to dist/**.js.flow
  • Copy src/**.js.flow to dist
  • Copy src/**.d.ts to dist
  • Copy *.md to dist
  • Copy package.json to dist with modifications:
    • main from root package.json or auto-generated value
    • module from root package.json or auto-generated value
    • exports from root package.json or auto-generated value
    • @babel/runtime will be added or removed from dependencies depending on whether any output code requires it
    • Removed keys:
      • config
      • devDependencies
      • files
      • husky
      • lint-staged
      • nyc
      • scripts.prepublishOnly
      • renovate