Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ardalanamini/eslint-config-noir
Noir ESLint shareable config
https://github.com/ardalanamini/eslint-config-noir
check checker code config enforce eslint eslint-config eslint-plugin eslintconfig hint javascript lint linter noir quality strict style typescript validate verify
Last synced: 16 days ago
JSON representation
Noir ESLint shareable config
- Host: GitHub
- URL: https://github.com/ardalanamini/eslint-config-noir
- Owner: ardalanamini
- License: mit
- Created: 2022-06-11T13:40:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T23:07:11.000Z (11 months ago)
- Last Synced: 2024-12-04T10:40:31.511Z (about 1 month ago)
- Topics: check, checker, code, config, enforce, eslint, eslint-config, eslint-plugin, eslintconfig, hint, javascript, lint, linter, noir, quality, strict, style, typescript, validate, verify
- Language: JavaScript
- Homepage:
- Size: 248 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-noir
[![Test](https://github.com/ardalanamini/eslint-config-noir/actions/workflows/test.yml/badge.svg)](https://github.com/ardalanamini/eslint-config-noir/actions/workflows/test.yml)
[![Npm Version](https://img.shields.io/npm/v/eslint-config-noir.svg)](https://www.npmjs.com/package/eslint-config-noir)
[![License](https://img.shields.io/github/license/ardalanamini/eslint-config-noir.svg)](https://github.com/ardalanamini/eslint-config-noir/blob/master/LICENSE)
[![Pull Requests](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](https://github.com/ardalanamini/eslint-config-noir/pulls)
[![Known Vulnerabilities](https://snyk.io/test/github/ardalanamini/eslint-config-noir/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ardalanamini/eslint-config-noir?targetFile=package.json)
[![Npm Total Downloads](https://img.shields.io/npm/dt/eslint-config-noir.svg)](https://www.npmjs.com/package/eslint-config-noir)
[![Npm Monthly Downloads](https://img.shields.io/npm/dm/eslint-config-noir.svg)](https://www.npmjs.com/package/eslint-config-noir)
[![Github Stars](https://img.shields.io/github/stars/ardalanamini/eslint-config-noir.svg?style=social&label=Stars)](https://github.com/ardalanamini/eslint-config-noir)
[![Github Forks](https://img.shields.io/github/forks/ardalanamini/eslint-config-noir.svg?style=social&label=Fork)](https://github.com/ardalanamini/eslint-config-noir)Noir ESLint shareable config.
## Installation
You'll first need to install [ESLint](http://eslint.org):
```shell
npm i -D eslint
```Next, install `eslint-config-noir`:
```shell
npm i -D eslint-config-noir
```## Usage
Add `noir` to the `extends` section of your `.eslintrc` configuration file. You can omit the `eslint-config-` prefix:
```json
{
"extends": [
"eslint:recommended",
"noir"
]
}
```With [Import](https://github.com/import-js/eslint-plugin-import) support:
> You'll first need to install [Import ESLint Plugin](https://github.com/import-js/eslint-plugin-import).
```json
{
"extends": [
"eslint:recommended",
"noir",
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"noir/import"
]
}
```With [TypeScript](https://www.typescriptlang.org) support:
> You'll first need to install [TypeScript ESLint](https://typescript-eslint.io).
```json
{
"extends": [
"eslint:recommended",
"noir",
"plugin:@typescript-eslint/recommended",
"noir/typescript"
]
}
```Or all of the configs at once:
```json
{
"extends": "noir/all"
}
```