https://github.com/malept/eslint-config

Common ESLint configuration for JavaScript/TypeScript modules maintained by @malept
https://github.com/malept/eslint-config

eslint eslint-config eslintconfig

Last synced: 11 days ago
JSON representation

Common ESLint configuration for JavaScript/TypeScript modules maintained by @malept

• Host: GitHub
• URL: https://github.com/malept/eslint-config
• Owner: malept
• License: apache-2.0
• Created: 2021-07-23T23:59:53.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T05:13:05.000Z (7 months ago)
• Last Synced: 2024-05-01T22:42:33.508Z (6 months ago)
• Topics: eslint, eslint-config, eslintconfig
• Language: JavaScript
• Homepage:
• Size: 104 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `@malept/eslint-config`

> Common ESLint configuration for JavaScript/TypeScript modules maintained by

> [`@malept`](https://npmjs.com/~malept).

## Usage

To install this ESLint configuration and its (base) peer dependencies:

```shell

# npm

npm install --save-dev @malept/eslint-config eslint eslint-plugin-{ava,import,node,prettier,promise} prettier

# yarn 1

yarn add --dev @malept/eslint-config eslint eslint-plugin-{ava,import,node,prettier,promise} prettier

```

Peer dependencies (see `package.json` for version details):

- `eslint`

- `eslint-plugin-ava`

- `eslint-plugin-import`

- `eslint-plugin-node`

- `eslint-plugin-prettier`

- `eslint-plugin-promise`

- `prettier` (due to `eslint-plugin-prettier`)

### JavaScript

Usage example:

```javascript

{

  extends: [

    // ...

    '@malept'

  ]

}

```

### TypeScript

Additional peer dependencies (see `package.json` for version details):

- `@typescript-eslint/eslint-plugin`

- `eslint-plugin-tsdoc`

Usage example:

```javascript

{

  extends: [

    // ...

    '@malept/eslint-config/typescript'

  ]

}

```

## License

[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)