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

@creativepenguin/standards

v1.0.0-rc.1

Published

Various shared coding standard configs for Creative Penguin repos.

Downloads

18

Readme

Code Standard Configs for Creative Penguin Repos

This package contains all configuration files for the various code standard tools that we use in Creative Penguin repos. Currently, the included configs are: ESLint, Commitizen, and Commitlint.

Installation

npm i -ED @creativepenguin/standards

Usage

ESLint

Add a .eslintrc.js file to the project root with the following contents.

'use strict';

module.exports = {
   // Currently ESLint requires shared config packages to be prefixed with `eslint-config`
   // to be resolved. Since we re using a shared config in a standards mono-repo, we have
   // to use the full relative file path.
   extends: [ './node_modules/@creativepenguin/standards/eslint/index.js' ],
   rules: {
      'new-cap': 'off',
   },
   globals: {
      CONFIG: true,
   },
};

There are 3 config options for ESLint available:

  • ./node_modules/@creativepenguin/standards/eslint/index.js
    • Base configuration for JavaScript and TypeScript
    • These rules are inherrited by all other configs
  • ./node_modules/@creativepenguin/standards/eslint/node.js
    • Additional environment for Node.js
  • ./node_modules/@creativepenguin/standards/eslint/vue.js
    • Additional Vue specific rules and plugins

Commitlint

Add a commitlint.config.js file to the root of the project with the following contents.

module.exports = {
   extends: [ '@creativepenguin/standards/commitlint' ],
};

Commitizen

Like ESLint, you must use the relative path to the config instead of node module resolution.

Add the following to package.json

"config": {
  "commitizen": {
    "path": "./node_modules/@creativepenguin/standards/commitizen.js"
  }
}

Husky

All Creative Penguin repos should also use Husky to ensure coding standards before commit.

Install Husky:

npm i -ED husky

In 'package.json', add:

"husky": {
  "hooks": {
    "pre-commit": "npm run lint",
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}