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

Set of ESLint rules for Lingui projects
https://github.com/lingui/eslint-plugin

eslint eslint-plugin hacktoberfest lingui

Last synced: about 14 hours ago
JSON representation

Set of ESLint rules for Lingui projects

• Host: GitHub
• URL: https://github.com/lingui/eslint-plugin
• Owner: lingui
• License: mit
• Created: 2023-07-07T11:18:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-19T06:26:38.000Z (4 months ago)
• Last Synced: 2024-09-10T16:34:01.311Z (about 2 months ago)
• Topics: eslint, eslint-plugin, hacktoberfest, lingui
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/eslint-plugin-lingui
• Size: 188 KB
• Stars: 20
• Watchers: 5
• Forks: 6
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 
An ESLint Plugin For Linguijs





Set of eslint rules for [Lingui](https://lingui.dev) projects 

[![npm](https://img.shields.io/npm/v/eslint-plugin-lingui?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/eslint-plugin-lingui)

[![npm](https://img.shields.io/npm/dt/eslint-plugin-lingui?cacheSeconds=500)](https://www.npmjs.com/package/eslint-plugin-lingui)

[![main-suite](https://github.com/lingui/eslint-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/lingui/eslint-plugin/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/lingui/eslint-plugin/graph/badge.svg?token=ULkNOaWVaw)](https://codecov.io/gh/lingui/eslint-plugin)

[![GitHub](https://img.shields.io/github/license/lingui/eslint-plugin)](https://github.com/lingui/eslint-plugin/blob/main/LICENSE)



## Installation

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

```bash

npm install --save-dev eslint

# or

yarn add eslint --dev

```

Next, install `eslint-plugin-lingui`:

```bash

npm install --save-dev eslint-plugin-lingui

# or

yarn add eslint-plugin-lingui --dev

```

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

## Flat Config (`eslint.config.js`)

### Recommended Setup

To enable all of the recommended rules for our plugin, add the following config:

```js

import pluginLingui from 'eslint-plugin-lingui'

export default [

  pluginLingui.configs['flat/recommended'],

  // Any other config...

]

```

### Custom setup

Alternatively, you can load the plugin and configure only the rules you want to use:

```js

import pluginLingui from 'eslint-plugin-lingui'

export default [

  {

    plugins: {

      lingui: pluginLingui,

    },

    rules: {

      'lingui/t-call-in-function': 'error',

    },

  },

  // Any other config...

]

```

## Legacy Config (`.eslintrc`)

### Recommended setup

To enable all of the recommended rules for our plugin, add `plugin:lingui/recommended` in extends:

```json

{

  "extends": ["plugin:lingui/recommended"]

}

```

### Custom setup

Alternatively, add `lingui` to the plugins section, and configure the rules you want to use:

```json

{

  "plugins": ["lingui"],

  "rules": {

    "lingui/t-call-in-function": "error"

  }

}

```

## Rules

✅ - Recommended

- ✅ [no-expression-in-message](docs/rules/no-expression-in-message.md)

- ✅ [no-single-tag-to-translate](docs/rules/no-single-tag-to-translate.md)

- ✅ [no-single-variables-to-translate](docs/rules/no-single-variables-to-translate.md)

- ✅ [no-trans-inside-trans](docs/rules/no-trans-inside-trans.md)

- ✅ [t-call-in-function](docs/rules/t-call-in-function.md)

- [no-unlocalized-strings](docs/rules/no-unlocalized-strings.md)

- [text-restrictions](docs/rules/text-restrictions.md)