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

@ryuuto829/eslint-config-with-prettier

v0.3.0

Published

Dmytro Rykhlyk's default eslint configuration with prettier

Downloads

8

Readme

eslint-config-with-prettier

These are my default ESLint and Prettier settings ⚡️

Based on Upstatement's ESLint and prettier configurations. Check their documentation on Prettier configuration and ESLint configuration.

Installation

  1. We need to install everything needed by the config:
# using npx

npx install-peerdeps --dev @ryuuto829/eslint-config-with-prettier

# OR using npm

npm install --save-dev @ryuuto829/eslint-config-with-prettier eslint babel-eslint prettier eslint-config-prettier eslint-plugin-prettier

# OR using yarn

yarn add --dev @ryuuto829/eslint-config-with-prettier eslint babel-eslint prettier eslint-config-prettier eslint-plugin-prettier
  1. Create an .eslintrc file at the root of your project with the following:
{
  "extends": ["@ryuuto829/eslint-config-with-prettier"]
}
  1. Create a prettier.config.js file at the root of your project that contains:
module.exports = require('@ryuuto829/eslint-config-with-prettier/prettier');
  1. (Optional) Add .editorconfig file to the root of the project:
# This file is for unifying the coding style for different editors and IDEs
# Read more: http://editorConfig.org

# Top-most EditorConfig file
root = true

# Global
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
  1. (Optional) You can add two scripts to your package.json to lint and/or fix:
"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
},

Using with React

  1. Install additional dependencies:
# If project includes deafult config

yarn add --dev eslint-plugin-react eslint-plugin-jsx-a11y

# OR initiate empty project with react config

yarn add --dev @ryuuto829/eslint-config-with-prettier eslint babel-eslint prettier eslint-config-prettier eslint-plugin-react eslint-plugin-jsx-a11y
  1. Create an .eslintrc file at the root of your project with the following:
{
  "extends": ["@ryuuto829/eslint-config-with-prettier/react"]
}

Pre-commit Hook

You can use lint-staged with husky, which manages git hooks and automatically fix your errors on commit.

  1. Install following dependencies:
yarn add --dev lint-staged husky
  1. Update your package.json like this:
"husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,jsx,ts,tsx,css,json,md}": [
      "prettier --write"
    ],
    "*.js": [
      "eslint --fix"
    ]
  }

Specifying Environments

{
  "extends": ["@ryuuto829/eslint-config-with-prettier"],
  "env": {
    "browser": true,
    "node": true,
    "jest": true
  }
}

Integration with Visual Studio Code

  1. Install Prettier extension: View → Extensions then find and install Prettier - Code formatter.
  2. Install the ESLint extension: View → Extensions then find and install ESLint.
  3. Reload the editor.
  4. In your user settings:
// Format on save with Prettier rules
"editor.formatOnSave": true,
// Tell the ESLint plugin to run on save
"editor.codeActionsOnSave": { "source.fixAll.eslint": true }