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

@jakzo/testpkg

v0.0.10

Published

JavaScript Technology Manager -- project tooling in a box.

Downloads

10

Readme

@jstm/core

JavaScript Technology Manager -- project tooling in a box. Preconfigured tools like Webpack, TypeScript, Jest, Github Actions and more set up and upgraded with a single command.

Warning: this project is still in beta. Until it reaches v1.0.0 there will likely be breaking changes which require manual fixes.

Usage

Create an empty directory for your new project then run:

yarn add --exact --dev @jstm/preset-node

That's it! After a few prompts all the tooling should now be set up. Note that you may need to restart your IDE for the integrations to pick up the changes to tooling (eg. for the VSCode ESLint plugin to read the newly created config).

Quick commands

yarn add --exact --dev @jstm/preset-node # install in project, --exact is recommended to ensure version matches what you expect
yarn upgrade @jstm/preset-node --latest  # update to latest project tooling
yarn project                             # manually sync tooling into project

Existing projects

If you want to add this to an existing project you can run the same command to install all the tooling. Existing tooling files will be overwritten so make sure you're using version control like Git so you can restore anything deleted if necessary. Carefully review all the changes which were made to make sure you don't lose anything. Some common things you will have to do are:

  • Manually find and delete any conflicting files. For example if the tool creates a .eslintrc.js file but your project had a .eslintrc.json file it will not be overwritten and you will have to manually delete the old file.
  • Modify your source code to pass tests and linting rules.
  • Move overwritten custom package.json scripts (eg. build, test, etc.) to custom scripts (eg. build:custom, test:custom, etc.).
  • Create a separate file for custom Github actions.

Templates

There are multiple templates available. To use a particular template, simply install it as a dev dependency into your project then run yarn project and it will set itself up.

These packages are:

  • @jstm/preset-node - Preconfigured tooling for Node.js projects.

Configuration

Configuration values for jstm are stored in PROJECT_ROOT/config/.jstmrc.json. This file contains things like the name of your project's main git branch (eg. master or main) or the minimum supported node version of your project. If this file does not exist you will be prompted for values for missing configuration items. After going through the prompts this file will be automatically created for you. Any config items missing from your .jstmrc.json will use jstm's default values.

While you can configure a lot of different things, it is recommended you choose the defaults as much as possible. One of the main benefits of jstm is that it automatically upgrades your tooling config, but if you manually specify config values you will need to update them yourself. For example, if you set nodeMinVersion to 13 when the default is 12, eventually node 12 will reach its end-of-life and jstm will have the default bumped to version 14, but your project will still be using version 13 until you update it yourself.

FAQ

Why use this instead of Yeoman or even just copying a boilerplate folder?

For free maintainence. This tool is more than just a set of file templates; all the tooling and configuration is encapsulated inside a dependency which means that by running yarn upgrade @jstm/preset-node --latest your tooling will be updated to the current state-of-the-art JS project setup. These upgrades can even be automated with a bot like Renovate. With file templates they help you get started quickly but leave all the maintenance to you. If you have many separate repositories, the maintenance time savings add up quickly.

Why would I not want to use this?

If you require a unique tooling setup which is not compatible with any available project templates. Right now there is only a narrow set of templates with my preferred tooling setup (generally uses tools which are popular for OSS projects). However you can also:

  • Add overrides for most config files with the config directory
  • Build your own template using the API from @jstm/core

How do I eject if I don't want to use this anymore?

This is a manual process for now. To do this you should:

  • Install all the packages depended on by @jstm/preset-node
  • Run yarn remove @jstm/preset-node
  • Remove config files from .gitignore
  • Remove all the "generated file, do not modify" warnings

Contributing

See CONTRIBUTING.md for instructions how to develop locally and make changes.