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

@arthurgeron/eslint-config

v2.0.2

Published

ESLint config that provides the best practices alongside with my own code patterns.

Downloads

6

Readme

@arthurgeron/eslint-config

ESLint config that provides the best practices alongside with my own code patterns.

https://www.npmjs.com/package/@arthurgeron/eslint-config

Objective

This project goal is to establish a code pattern across multiple projects, make it easier to set up new projects as well as garantee projects maintain a reasonable level of code quality.

Intended use

This is intended to be used integrated with your CI tools (e.g. Jenkins), using this config just as a pre-commit hook is not enough to garantee the code pushed will follow the estabilished code patterns and rules.

Requirements

  • ESLint itself, plugins and configs listed in peer dependencies

Installing

  1. Run yarn add @arthurgeron/eslint-config

Configuring on a Web project:

{
  parserOptions: {
    project: "./tsconfig.json"
  },
  extends: ["@arthurgeron/eslint-config"]
}

Configuring on a React Native project:

{
  parserOptions: {
    project: "./tsconfig.json"
  },
  extends: ["@arthurgeron/eslint-config/native"]
}

Note: we also recommend removing previous rules.

set your .prettierc.js:

const prettierrc = require('@arthurgeron/eslint-config/prettier');

module.exports = prettierrc;

Configuring with your Visual Studio Code

We all know it's annoying to have to manually look at eslint errors on the terminal one by one to fix code issues, with these suggestions you will have ESLint integrated into your VSCode showing errors dynamically and inline.

Install these extensions:

dbaeumer.vscode-eslint - Base ESLint extension rvest.vs-code-prettier-eslint - Better ESLint/Prettier integration and auto-fixing usernamehw.errorlens - Shows errors inline

Add your node runtime to your ESLint config

Go into your VSCode settings and set eslint.runtime to "node", example:

{
  "eslint.runtime": "node",
}

This will make sure your ESLint extension uses your current node version and runs correctly.

That's it, you are all set! Next time you open a file you should see all ESLint errors inline.

Customization

You can override some configs to better suit your project's needs, such as import-helpers/order-imports, though modifiying other rules is not recommended as it would defeat the purpose of having a centralized pack of ESLint rules.

ESLint? But my project is gigantic!

If your project has been around for some time and has gathered a good amount of lines I suggest you take this approach:

  • Implement it as a pre-commit hook but only lint staged files.
    "What does that mean?" you might ask, well it means that only the changed files will be validated, only the files that you change will need to be adapted to fit the ESLint rules, considerabnly diminishing the initial impact of implementing it into your development process.

Example of stage only lint (husky):

// package.json
"scripts": {
  "lint": "eslint --ignore-path .gitignore ",
},
"husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "lint-staged": {
    "*.{ts,js,jsx,tsx}": [
      "yarn lint"
    ]
  },