eslint-config-oceanprotocol

eslint-config-oceanprotocol

💅 🦋 Shareable ESLint config for keeping JavaScript consistent across all of Ocean Protocol's projects, built upon JavaScript Standard Style.

This cat clearly forgot to lint her JavaScript before deployment:

_{Exhibit A: cat not linting correctly}

Don't be like that cat.

Table of Contents

• Usage
  • React
  • Prettier
  • Editor Plugins
• Rules
• Development
• npm releases
• Changelog
• Contributing
• License

---

Usage

For every project containing JavaScript, ESLint should be set up with this base setup.

npm install --save-dev eslint eslint-config-oceanprotocol

Then, create a new file .eslintrc in the root of your project and fill with:

{
  "extends": "oceanprotocol"
}

React

When using within a React project use this to get set up:

npm i -D eslint eslint-config-oceanprotocol

And in your .eslintrc:

{
  "extends": ["oceanprotocol", "oceanprotocol/react"]
}

Prettier

Additionally, you should add Prettier to your project and work with it through ESLint:

npm i -D prettier eslint-config-prettier eslint-plugin-prettier

Then add a .prettierrc file to the root of your project with this content:

{
    "semi": false,
    "singleQuote": true,
    "trailingComma": "none"
}

Finally, modify your .eslintrc:

{
  "extends": ["oceanprotocol", "prettier/standard", "plugin:prettier/recommended"],
  "plugins": ["prettier"]
}

Editor Plugins

For maximum fun during coding, install an ESLint plugin in your favorite editor to get suggestions and autofixes as you type.

• VS Code: ESLint
• Atom: linter-eslint
• PyCharm: Installing, enabling, and configuring ESLint in PyCharm
• Sublime Text: SublimeLinter-eslint
• IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm, AppCode, Android Studio: ESLint
• Vim, NeoVim: ALE

Rules

We keep it simple and follow almost everything defined in the JavaScript Standard Style. Only deviations are:

• indentation: 4
• no space before function parenthesis
• double quotes for jsx attributes
• prefer destructuring from objects & arrays
• enforce spacing inside curly braces

Development

Again, keeping it simple with 2 files for now:

• index.js: holds all the custom JavaScript linting rules
• react.js: holds all the custom React linting rules

For local development, clone this repo and install all dependencies:

git clone [e-mail]:oceanprotocol/eslint-config-oceanprotocol.git
cd eslint-config-oceanprotocol/

npm i

Linting is setup against the actual rules within this repo so for testing new rules against every js file in this repo, you can run:

npm test

npm releases

From a clean master branch you can run any release task doing the following:

• bumps the project version in package.json, package-lock.json
• auto-generates and updates the CHANGELOG.md file from commit messages
• creates a Git tag
• commits and pushes everything
• creates a GitHub release with commit messages as description
• Git tag push will trigger Travis to do a npm release

Command is powered by release-it package, defined in the package.json. You can execute the script using arguments to bump the version accordingly:

• To bump a patch version: npm run release
• To bump a minor version: npm run release minor
• To bump a major version: npm run release major

For the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN is required. Setup

In case you have 2FA setup on npm.js, pass a code as One Time Password:

npm run release --otp <yourcode>

Changelog

See the CHANGELOG.md file. This file is auto-generated during the above mentioned release process.

Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

License

Copyright 2018 Ocean Protocol Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file 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.

Changelog

v1.4.0

19 August 2019

• Updates #32
• Update release-it to the latest version 🚀 #28
• Update eslint-plugin-node to the latest version 🚀 #27
• Update release-it to the latest version 🚀 #26
• Update release-it to the latest version 🚀 #24
• Update release-it to the latest version 🚀 #23
• Standardize contrib guidelines across public repos #22
• 1.3.0 #20
• Update release-it to the latest version 🚀 #21
• upgraded eslint-plugin-node to 8.0, removed peer deps #19
• package updates, add changelog 9385d71
• add prettier faf1e86
• document prettier 84ff8f7