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

@bed-and-breakfast/templates-open-source

v4.2.18

Published

Bed & Breakfast Open Source Template

Downloads

172

Readme

NPM Version CI Release Code Climate Code Coverage Known Vulnerabilities Semantic Release: Conventional Commits Commitizen friendly

Bed & Breakfast Open Source Repository Template

GitHub repository template to make developing typescript packages easier. Creates an out-of-the-box environment for best code practices and project management.

Features

  • Complete GitHub CI/CD process
    • Typescript builds for ESM and CommonJS
    • Validate commit format (conventional commits)
    • Check for broken Markdown links (markdown-link-check)
    • Validate linting (typescript-eslint) and formatting (prettier)
    • Test integration
      • Test against all major node versions (18, LTS, latest)
      • Test reports in all CI workflows (including PRs)
      • Coverage reports in all CI workflows (including PRs)
      • Coverage history and code quality analysis (Code Climate)
    • Automatic releases based on git log (semantic-release)
      • Only release when CI is successful
      • Automatically creates semver versions
      • Generates changelog
      • Releases npm package
      • Releases GitHub release
  • Improved development
  • Repository management
  • Documentation and templates
    • README stub with configured badges
    • Issue templates
    • PR template
    • CODEOWNERS, CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, SECURITY, SUPPORT

Getting Started

Create a new repository using this template (instructions).

Initialize the repository

We can use @bed-and-breakfast/template-tools to initialize the repository. Execute the following command and follow the instructions on the screen.

npx template-init

Adding a remote to pull updates

Bed & Breakfast repository templates will be updated over time. Start by setting up a remote with the template-add-remote command.

npx template-add-remote

Pulling updates from the template

You can then use the following command to pull these changes into an existing repository:

npx template-pull

Note Be careful resolving conflicts when pulling from a template. Files like package.json, README.md, CHANGELOG.md etc. will have changes you don't want to accept.

Development

Making commits

| Action | Command | | -------------- | ------------------------------------------------------------- | | Build | npm run build | | Test | npm run test, npm run test:coverage, npm run test:watch | | Lint | npm run lint, npm run lint:fix | | Format | npm run format, npm run format:fix | | Format Package | npm run format:package | | Check Markdown | npm run check:md |

Using commitizen

npm i -g commitizen
npm run commit

Releasing

Releasing is completely automated and is as simple as:

git push

It will create a new release based on all commits since the last release.