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

@hounddesk/test-pkg

v1.4.0

Published

The best starting point for your new NPM package

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

degrammerdegrammer

Keywords

nodejs npm

Readme

pkg-template

The best starting point for your new Node project

Installation

This is a GitHub template repository Read more

It provides basic foundations for package authors, but it can be used as a good starting point for your Node.js application

Before using, download and install Node.js. Node.js 10.16.3 or higher is recommended.

Available utilities enabled by default

  • TypeScript
  • Testing with Jest and Tap reporter
  • TypeScript linting using eslint
  • TypeScript watch mode using ts-node-dev
  • Formatting using Prettier
  • Pre-commit hook using Husky (will run linter, formatting and unit tests before each commit)

VSCode support

  • Format on save / type enabled by default using Prettier
  • Prettier extension configuration, Read more

Conventions

  • Source folder: src
  • Output directory: dist
  • Sourcemaps enabled by default
  • Jest current file: Unit test debugging command for VSCode
  • Debug: Node debugging command for VSCode
  • All the eslint plugins are using the recommended defaults

Available commands

Start in development mode (watch mode with automatic restart)

$ npm run dev

Build TypeScript

$ npm run build

Build TypeScript in watch mode (without automatic restart)

$ npm run build:watch

Run unit tests

$ npm test

Run linter

$ npm run lint

Run linter with auto fix

$ npm run lint:fix

Run tests with coverage report

$ npm run coverage

VSCode developer suggested extensions

The following extensions works great alongside with this setup:

  • Prettier
  • Jest - once installed, enable the runner >> Jest > Start runner

Usage for publishing packages

The recommended approach is to create a scoped public package (if you are not using private packages) Read more about scoped packages here

If you're using the package.json from the template you may want to change the name and references to pgk-template and change it to your library.