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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@seroh/npm-typescript-module

v1.5.3

Published

Template for authoring an NPM package

Downloads

56

Readme

Template: NPM Package

This is a template repository which you can use to quickly bootstrap your own NPM package.

Features

  • Static Typing: Uses TypeScript for improved type safety and a better developer experience
  • Testing: Pre-configured Jest setup for writing and running unit tests efficiently
  • Linting: Leverages ESLint to catch potential bugs and enforce coding standards
  • Auto-Formatting: Ensures consistent code style with automated formatting using Prettier
  • Continuous Integration (CI): Pre-configured GitHub Actions for linting, testing, building, and formatting in CI environments
  • Git Hooks: Husky-managed Git hooks to run scripts before commits, pushes, and other Git actions, ensuring code quality
  • Automated Publishing: Uses Semantic Release to automate package versioning and publishing.

Table of Content

Quick Start

1. Clone the template

The fastest way is to use GitHub CLI:

# Create a new repository using a template and clone it
gh repo create new-repo-name --template serohman/npm-typescript-module
gh repo clone new-repo-name

Or refer to the official guide for creating repositories from a template.

2. Set up NPM authentication

You need to generate an NPM access token and save it as a GitHub Action Secret, under the key name NPM_TOKEN

Use GitHub CLI

# A prompt for entering the npm token will appear
gh secret set NPM_TOKEN

Or set the secret via the web UI by navigating to your repository's GitHub page, and then: Settings > Secrets and variables > Actions > New repository secret.

3. Install dependencies

npm install

4. Set package metadata

Open package.json and fill out all the relevant fields:

  • name
  • author
  • description
  • tags
  • license
  • publishConfig.access (Set to private to make your package private)

5. Publish your package

To publish your package, switch to the release branch, then create and push a semantic commit with the changes you've made to package.json. Once the changes are pushed, GitHub Actions will automatically publish your package.

git checkout -b "release"
git stage .
git commit -m "feat: Setup package"
git push --set-upstream origin release

And voilà!🎉 The moment new changes hit the release branch, GitHub Actions will pick them up and publish a new release on NPM.

Available NPM Scripts

General

These commands are used during the development process to build, test, lint, and format the code.

  • start: Runs the build script.
  • build: Compiles the TypeScript code and watches for changes.
  • test: Runs Jest in watch mode.
  • lint: Runs ESLint on the ./src directory.
  • format: Formats the code in the ./src directory using Prettier.

Precommit Hooks

These commands are executed before a commit is made to ensure code quality and consistency. They check for issues in the staged files, attempt to fix them automatically (using the --fix flag), and display an error if the issues cannot be fixed. If any problems remain unresolved, the commit is prevented.

  • precommit: Runs lint-staged to check staged files.
  • precommit:format: Formats staged files using Prettier.
  • precommit:lint: Fixes linting issues in staged files using ESLint.
  • precommit:test: Runs Jest on related tests for staged files.
  • precommit:typecheck: Type checks the code without emitting output.

Continuous Integration

These commands are executed by GitHub Actions on the release branch. Each time a change is pushed to the release branch, these actions are triggered. If any action fails, the release process is halted until the issues are resolved.

  • ci:lint: Runs ESLint with a CI-specific configuration.
  • ci:test: Runs Jest with a CI-specific configuration.
  • ci:build: Builds the TypeScript project.
  • ci:format: Checks code formatting using Prettier.