https://github.com/internations/eslint-plugin-internations

Custom InterNations ESLint rules
https://github.com/internations/eslint-plugin-internations

eslint javascript

Last synced: 9 days ago
JSON representation

Custom InterNations ESLint rules

• Host: GitHub
• URL: https://github.com/internations/eslint-plugin-internations
• Owner: InterNations
• Created: 2016-09-30T14:00:25.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:10:34.000Z (over 1 year ago)
• Last Synced: 2024-03-26T09:27:21.173Z (8 months ago)
• Topics: eslint, javascript
• Language: JavaScript
• Size: 157 KB
• Stars: 4
• Watchers: 18
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :warning: DEPRECATED :warning:

Instead use https://github.com/InterNations/community/tree/prod/eslint-plugin

This repository should be removed along with the classic site.

---

# eslint-plugin-internations

[![npm version](https://badge.fury.io/js/eslint-plugin-internations.svg)](https://badge.fury.io/js/eslint-plugin-internations)

Custom ESLint rules and recommended rule configuration for internal InterNations usage.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-internations` and its peer dependencies:

```

(

  export PKG=eslint-plugin-internations;

  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/@/@/g' | xargs npm install --save-dev "$PKG@latest"

)

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-internations` and its peer dependencies globally.

## Usage

Add `internations` to the `plugins` section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "internations"

    ]

}

```

Then, add `plugin:internations/recommended` to the `extends` section:

```json

{

    "extends": [

        "plugin:internations/recommended"

    ]

}

```

You may optionally configure any specific rules you want to override under the `rules` section:

```json

{

    "rules": {

        "internations/rule-name": "error"

    }

}

```