Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/porscheofficial/eslint-config-porschedigital

An opinionated ESLint config which supports: JavaScript, TypeScript, Jest and React.
https://github.com/porscheofficial/eslint-config-porschedigital

a11y eslint eslint-config eslint-rules jest prettier react reactjs typescript

Last synced: 3 days ago
JSON representation

An opinionated ESLint config which supports: JavaScript, TypeScript, Jest and React.

Host: GitHub
URL: https://github.com/porscheofficial/eslint-config-porschedigital
Owner: porscheofficial
License: mit
Created: 2022-01-18T14:01:17.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-08-15T08:37:00.000Z (about 1 month ago)
Last Synced: 2024-09-19T23:35:37.686Z (7 days ago)
Topics: a11y, eslint, eslint-config, eslint-rules, jest, prettier, react, reactjs, typescript
Language: JavaScript
Homepage:
Size: 42.6 MB
Stars: 18
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Porsche Digital ESLint Config

[![npm version](http://img.shields.io/npm/v/@porscheofficial/eslint-config-porschedigital-base.svg?style=flat)](https://www.npmjs.com/package/@porscheofficial/eslint-config-porschedigital-base)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/porscheofficial/eslint-config-porschedigital/main/LICENSE.md)

[![npm](https://img.shields.io/npm/dm/@porscheofficial/eslint-config-porschedigital-base.svg)](https://www.npmjs.com/package/@porscheofficial/eslint-config-porschedigital-base)

An opinionated ESLint config which supports: JavaScript, TypeScript, Jest and React.

## 🚀 Usage of ESLint configs

Currently there are the following eslint configs provided as extensible shared components

- [Base Config](/packages/eslint-config-porschedigital-base)

- [React Config](/packages/eslint-config-porschedigital-react)

### Prettier

Make sure to also include our [prettier config](/packages/prettier-config-porschedigital).

## 📜 Decisions

### Prettier

We differ between code quality rules and stylistic rules.

Therefore, we follow the [recommendation of prettier](https://prettier.io/docs/en/integrating-with-linters.html).

That means, that we use `eslint` exclusively for code quality and `prettier` for the style.

That's why this project also contains a package with a shared `prettier` config containing the rules we have agreed on.

### Dependencies

In order to keep this opinionated config as plug- and playable as possible, we decided to declare the dependencies not as `peerDependencies`.

## Contributing

See [CONTRIBUTING](./CONTRIBUTING.md).

## License

See [LICENSE](./LICENSE.md).