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

@moralisweb3/eslint-config

v1.0.3

Published

Eslint rules, used by Moralis for projects with TypeScript.

Downloads

491

Readme

@moralisweb3/eslint-config

Eslint rules, used by Moralis for projects with TypeScript.

These rules are based on community standards and inspired by the airbnb and google presets, without taking too much opinionated/formatting rules into account.

Usage

1. Install dependencies

npm install @moralisweb3/eslint-config \
            @typescript-eslint/eslint-plugin@^5.13.0 \
            @eslint-plugin-etc@^2.0.2 \
            @typescript-eslint/parser@^5.0.0 \
            --save-dev

or

yarn add @moralisweb3/eslint-config \
         @typescript-eslint/eslint-plugin@^5.13.0 \
         @eslint-plugin-etc@^2.0.2 \
         @typescript-eslint/parser@^5.0.0 \
         -D

2. Configure Eslint

Add @moralisweb3 to your eslint config file (.eslint or .eslint.js), or create a new one if it doesn't exist.

extends: [
+ '@moralisweb3'
]

Add any additional rules/plugins etc. you want to use.

{
  extends: ['@moralisweb3'],
  plugins: [/* any plugins */],
  rules: {
    // Any other rules
  }
};

3. Configure the ESLint TypeScript parser

This config requires knowledge of your TypeScript config.

In your ESLint config, set parserOptions.project to the path of your tsconfig.json.

For example:

{
  extends: ['@moralisweb3'],
+ parserOptions: {
+   project: './tsconfig.json'
+ }
}

4. Run eslnt

Run eslint via

npx eslint . --ext .js,.ts,.tsx,jsx

FAQ

I get this error when running ESLint: "The file must be included in at least one of the projects provided"

This means you are attempting to lint a file that tsconfig.json doesn't include.

A common fix is to create a tsconfig.eslint.json file, which extends your tsconfig.json file and includes all files you are linting.

{
  "extends": "./tsconfig.json",
  "include": ["src/**/*.ts", "src/**/*.js", "test/**/*.ts"]
}

Update your ESLint config file:

parserOptions: {
-  project: './tsconfig.json',
+  project: './tsconfig.eslint.json',
}

Why do I need the peer dependencies?

@typescript-eslint/eslint-plugin is a peer dependency due to a limitation within ESLint. See issue, RFC, and progress.

@typescript-eslint/parser is a peer dependency because the version number must match @typescript-eslint/eslint-plugin.