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

krimzen-ninja-module-template

v0.2.2

Published

Template project for building KrimZen Ninja npm templates

Downloads

2

Vulnerabilities

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

Links

Git

Maintainers

exigentcoderexigentcoder

Keywords

nodejestcirclecicodecovdocumentationKrimZenNinja

Readme

krimzen-ninja-module-template

Greenkeeper badge

Template project for building KrimzenNinja npm modules

NPM

CircleCi

Known Vulnerabilities

codecov

Prerequisites

Install Chandler to sync your CHANGELOG.md entries to GitHub

Getting Started

Delete this from the readme once you have setup your project.

  1. Copy this template.
  2. In the package.json file update the following fields:
    1. name
    2. description
    3. repository.url
    4. keywords
    5. bugs.url
    6. homepage
    7. license if private then UNLICENSED
  3. In the CHANGELOG.md file, update the path to unreleased.
  4. Replace the README.md file.
  5. Make sure the included LICENSE file is appropriate. if private then delete the file.
  6. In the .circleci/config.yml file:
    1. Update the working_directory field.
    2. If this is a private package then after npm publish . add --access restricted
  7. Add the project to CircleCi if it is not picked up automatically
  8. Add the $NPM_TOKEN environment variable

API

See details

Changelog

View Changelog

How to publish to NPM

You can either do releases from the master branch or follow the LTS model and branch off when you do a release.

  1. Ensure you are on the branch you want to publish from.
  2. Decide based on what is going into the release how the version number is going to change, see Semantic Versioning for more info.
  3. The CHANGELOG.md file should have pending changes documented in the Unreleased section, create a new heading for this version and cut the relevant changes and paste them into the new section.
  4. Commit the changes to the CHANGELOG.md file.
  5. Run one of the prebuilt publish commands that matches your semver patch, minor, major

    npm run patch -m "A message that makes sense" If none of the prebuilt ones fit, you can use npm version [major | minor | patch | premajor | preminor | prepatch | prerelease] -m "A message that makes sense"

  6. If you didn't publish from master, make sure to merge back into master if you were fixing a bug or the changes released need to go back to master.

Snyk dependency checking

You can either add your project via the web dashboard or via the cli by installing the lib npm i -g snyk and then running the setup snyk wizzard.

License

MIT © Ryan Kotzen