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

@rimac-technology/eslint-config

v31.2.0

Published

A shareable ESLint configuration

Downloads

6

Readme

Eslint Config

Commitizen friendly Conventional Changelog semantic-release: angular

Usage

  1. Install the library as a dev dependency alongside required dependencies using
yarn add -D @rimac-technology/eslint-config eslint
  1. Set up the minimal required configuration as displayed below

Minimal Required Configuration

  1. Create a new file in the root of the project called .eslintrc.json
  2. Place the following inside
{
    "extends": ["@rimac-technology/eslint-config/core"],
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "project": "./tsconfig.json"
    }
}
  1. Make sure the project field (under parserOptions) is pointing to the correct path to your tsconfig.json

Optional Rulesets

You can add the following ruleset to your .eslintrc.json file under extends section (example below)

  • "@rimac-technology/eslint-config/react"
  • "@rimac-technology/eslint-config/jest"
  • "@rimac-technology/eslint-config/type-graphql"
  • "@rimac-technology/eslint-config/mobx"
  • "@rimac-technology/eslint-config/testing-library"

Using Optional Rulesets

General

The following is added to .eslintrc.json

{
    "extends": [
        "@rimac-technology/eslint-config/core",
        "@rimac-technology/eslint-config/<optional-ruleset-name>"
    ]
}

Targeting only some files

If you prefer more granular control of which files some-ruleset considers when linting you can target those by using overrides and globs

{
    "overrides": [
        {
            "files": ["**/__tests__/**/*.[jt]s?(x)"],
            "extends": ["@rimac-technology/eslint-config/some-ruleset"]
        }
    ]
}

Turn on ESLint in your Project

Intellij

  1. Go to File>Settings>Languages & Frameworks>Javascript>Code Quality Tools>ESLint
  2. Select Automatic ESLint Configuration
  3. Check run eslint --fix on save
  4. Apply settings

Overriding or Adding Custom Rules

Rules can be overridden by adding them to the rules section in .eslintrc.json like the following example where we disable the space-infix-ops rule

{
    "extends": ["@rimac-technology/eslint-config/core"],
    "rules": {
        "space-infix-ops": "off"
    }
}

Troubleshooting

Little fellow sometimes has problems. Here is how to help if it doesn't work:

  1. Delete node_modules
  2. Go to File>Invalidate Caches>Invalidate and Restart
  3. Reinstall dependencies

Check if it works from the terminal. If it does, you IDE might be the problem here.

Testing Locally

In package.json, specify the path to the folder where you cloned eslint-config on your computer and place it instead of the version.

Then you can use it like any other lib.

  • Default install
// Current
{
    "@rimac-technology/eslint-config": "^19.0.0"
}
  • Local install for testing
{
    "@rimac-technology/eslint-config": "../eslint-config"
}