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

@nevir/code-style

v0.15.1

Published

nevir's code style

Downloads

71

Readme

npm Build Status

nevir's code style

This code style currently only supports JavaScript based projects (with an emphasis on TypeScript projects). It provides a pretty comprehensive set of rules, with an aim to…

  • …avoid dangerous and/or confusing patterns.
  • …encourage patterns that improve readability.
  • …enforce as much of the style as possible, to let developers focus on code behavior, not style.

Getting Started

npm install @nevir/code-style --save-dev
# Adds peer dependencies to your project, and sets up shared configs.
node ./node_modules/@nevir/code-style/.scripts/bootstrap.js

That's it! It will set you up with configuration for the various style tools.

Similarly, whenever you upgrade to a new version of the package, run bootstrap.js again to update any necessary peer dependencies.

Using It

The bootstrap script will set you up with a few new npm scripts for your convenience:

npm run test-style: Checks to see whether any files in your project violate the style. You can optionally pass specific files/globs to test as arguments.

npm run fix-style: Fixes any auto-fixable style issues in your project. You can optionally pass specific files/globs to fix as arguments.

Additionally, it configures VS Code to automatically fix and highlight style issues as you edit files.

Tooling

The bootstrap script sets up several tools in your project:

TypeScript

This package configures typescript into a very strict mode. Primarily, this is to avoid ambiguous types (ensuring that the compiler can optimally check all usages).

Prettier

Pretty standard configuration for Prettier. Nothing much special here.

Eslint

This package configures eslint with…

  • …a pretty strict set of style rules; to keep you out of trouble, and to minimize arguments over style in PRs.

  • …support for TypeScript sources.

  • --fix rules that play nice with Prettier.