Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/enactjs/eslint-config-enact

ESLint config for Enact
https://github.com/enactjs/eslint-config-enact

Last synced: about 1 month ago
JSON representation

ESLint config for Enact

Awesome Lists containing this project

README

        

# eslint-config-enact

> A set of linting rules designed by the Enact team.

This module includes both a standard set of rules and a set of stricter rules that represent the Enact team style.

## Usage

Reference this set of rules from your `.eslintrc` or `package.json` file and then use `eslint`. If you are using the `cli` tools, simply use `npm run lint` from your project directory.

For more information (including editor/IDE setup), please see the [docs](docs/index.md).

## Installation

`eslint-config-enact` can be installed locally or globally. The following command will install the config and all its dependencies globally:

```bash
npm install -g eslint eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-babel eslint-plugin-jest eslint-plugin-enact eslint-config-enact @babel/eslint-parser
```

>**NOTE**: Using the [`cli` tools](https://github.com/enactjs/cli/) to create your projects eliminates the need to globally install these dependencies unless you wish editor integration.

## Copyright and License Information

Unless otherwise specified, all content, including all source code files and
documentation files in this repository are:

Copyright (c) 2012-2024 LG Electronics

Unless otherwise specified or set forth in the NOTICE file, all content,
including all source code files and documentation files in this repository are:
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this content except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.