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

@ministryofjustice/eslint-config-hmpps

v0.0.1-beta.1

Published

ESLint rules for HMPPS typescript projects

Downloads

865

Readme

@ministryofjustice/eslint-config-hmpps

This package aims so simplify code style enforcement in HMPPS typescript projects using eslint.

It should include all:

  • the necessary npm packages to simplify dependency management within repositories
  • rules as defined by classic Airbnb best-practice with HMPPS overrides and typescript parsing

Status

This library is now in beta. Teams are free to use this library, but further breaking changes may occur.

Usage

Usage is best demonstrated by the HMPPS typescript template as it already includes npm scripts and continuous integration tooling. New projects based on this template will automatically adopt this package.

Migrating existing projects

Automatically installing the library

The package will self install by running via npx: npx @ministryofjustice/eslint-config-hmpps

The final step of the installation script is to run the linting tool, with --fix. This may expose some issues that need to manually fixed and some minor config overrides may need to be applied.

Manually installing the library

The template project was migrated as part of pull request 470, so you can either manually adopt changes from it or cherry-pick the squashed commit.

Essentially, the move from eslint v8 to v9 requires changes to eslint configuration:

  • npm uninstall @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-airbnb-base eslint-config-prettier eslint-import-resolver-typescript eslint-plugin-cypress eslint-plugin-import eslint-plugin-no-only-tests eslint-plugin-prettier
  • npm install --save-dev @ministryofjustice/eslint-config-hmpps
  • .eslintignore and .eslintrc.json are not supported so can be deleted
  • add eslint.config.mjs
    • import the default shared HMPPS rules from @ministryofjustice/eslint-config-hmpps
    • add a default export with these rules
    • if you had custom overrides in .eslintrc.json compared with the template project, include them after the shared defaults
  • run npm run lint and address changes as necessary
    • adjust rules in eslint.config.mjs to suit your project’s needs

Customising config

The point of having shared styling rules is that it reduces bike-shedding and adds some consistency across projects. If some overriding is required to make your project successfully build configuration can be overriden via eslint.config.mjs, e.g: here and here.

Developing this package

It is deliberately not using typescript or rollup so that building is not required. CommonJS enables the parent and sibling packages to use the rules directly for lint checks.

TODO

  • use modern eslint typescript plugins desgined for eslint v9