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

eslint-plugin-harmony

v7.2.0

Published

eslint config that works in harmony with different IDEs

Downloads

6,463

Readme

eslint-plugin-harmony

NPM version NPM downloads

semantic-release

Visual Studio Code phpStorm Atom

A eslint config styles package that work across IDEs.

Design Principles

There are several configurations available in this package. Although they are different as they are designed for different programmers, here are the principles that they all follow:

  • They are designed to be used by team
  • Each team member can use one of the supported IDE
  • The formatter available on each IDE should work with each configuration
  • Code should look well and consistent on each IDE with folding
    • so that when you stop by your team member's cube, the code looks the same.
  • Thrive for easy to write (with the fewest keystrokes) while keeping the code clean

Supported IDE

Installation

You'll first need to install ESLint:

npm install --save-dev eslint

Next, install eslint-plugin-harmony:

npm install --save-dev eslint-plugin-harmony

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-harmony globally.

Usage

To use the ESLint style, extends from one of the following:

{
  "extends": "plugin:harmony/recommended",
  "extends": "plugin:harmony/latest",
  "extends": "plugin:harmony/es5",
  "extends": "plugin:harmony/es5-strict",
  "extends": "plugin:harmony/ts-prettier", // experimental
  "extends": "plugin:harmony/ts-recommended", // or use overrides
  "extends": "plugin:harmony/ts-recommended-type-check", // or use overrides
  "extends": "plugin:harmony/ts-recommended-cra",
  "extends": "plugin:harmony/ts-recommended-type-check-cra",
}

TypeScript

The TypeScript style is extended from @typescript-eslint/eslint-plugin.

They are adjusted to the style in harmony. Also, the configuration are simplified.

Since you will likely to have some JavaScript files in your TypeScript project (e.g. jest.config.js, webpack.config.js, etc.), it is recommended to use the overrides.extends feature in eslint to support mixed environment:

{
  "extends": [
    "plugin:harmony/recommended"
  ],
  "overrides": [
    {
      "files": [
        "*.ts",
        "*.tsx"
      ],
      "extends": [
        "plugin:harmony/ts-recommended"
      ]
    }
  ]
}

Note that for ts-recommended-type-check you still need to specify parserOptions.project.

{
  "extends": [
    "plugin:harmony/recommended"
  ],
  "overrides": [
    {
      "files": [
        "*.ts",
        "*.tsx"
      ],
      "extends": [
        "plugin:harmony/ts-recommended-type-check"
      ],
      "parserOptions": {
        "project": "tsconfig.json"
      }
    }
  ]
}

For more information, please check out @typescript-eslint/eslint-plugin.

JetBrains IDE

After you import the settings, you need to use them in the setting:

setting

You also need to change your language version appropriately:

language version

Contribute

pnpm i
pnpm bootstrap