Skip to content
ESLint configuration for awesome projects
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
rules
.editorconfig
.eslintrc.js
.gitignore
.prettierrc.js
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
commitlint.config.js
index.js
package.json
yarn.lock

README.md

React Sceleto

Welcome to ESLint config Cecilia

npm version Dependency Status license

ESLint configuration for awesome projects.

ESLint config Cecilia is a sharable ESLint config used in JavaScript projects (Vanilla.js, React.js or Node.js).

The goal of the ESLint config Cecilia is to keep the code clean and consistent.

ESLint config Cecilia rules are based on eslint-config-airbnb.

Table of Contents

  1. Getting Started
  2. Contributing
  3. Questions
  4. License

Getting Started

Installation

Install ESLint config Cecilia.

Step 1 - Install with Yarn

yarn add eslint-config-cecilia --dev

Or install with npm

npm install -D eslint-config-cecilia

Usage

Step 2 - Create a .eslintrc.js file in your project root directory and use the extends attribute.

Paste this code to extend the ESLint ruleset:

module.exports = {
  extends: 'cecilia',
}

Optional - override rules

module.exports = {
  extends: 'cecilia',
  rules: {
    //
    // rules to override.
    //
  }
}

Step 3 - Create a .prettierrc.js file in your project root directory and change some rules.

module.exports = {
  semi: false,
  singleQuote: true,
  trailingComma: 'all',
}

Step 4 - Add scripts to the package.json file

Open the package.json file and add the following scripts entries:

  ...

  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix",
    "lint:format": "prettier --write \"./**/*.{js,jsx,json}\""
  },

  ...

Step 5 - Run the script

yarn lint or npm run lint to lint your code.

yarn lint:fix or npm run lint:fix to lint and fix your code.

yarn lint:format or npm run lint:format to format your code.

Pro tip

Install ESLint and Prettier extensions for Visual Studio Code.

Credits

Contributing

Want to contribute? All contributions are welcome. Read the contributing guide.

Questions

If you have questions tweet me at @sandro_m_m or open an issue.

License

This project is licensed under the MIT License - see the LICENSE file for details

**~ sharing is caring ~**

You can’t perform that action at this time.