orbitdb-lint

Linter and linting rules for OrbitDB JavaScript modules.

Uses eslint and OrbitDB linting rules to provide linting for development of OrbitDB and its modules.

Using in your project

Install the orbitdb-lint and add the module to your project's dev dependencies:

npm install @orbitdb/lint --save-dev

This will install eslint (the linter), eslint-config-orbitdb (linting rules) and their dependencies to your project.

Create .eslintrc file in your project's root directory:

touch .eslintrc

Edit .eslintrc to contain:

{
  "extends": ["@orbitdb/eslint-config-orbitdb"]
}

Add a lint script to your project's package.json:

"scripts": {
  "lint": "eslint src/"
}

Finally, to test it all works, run the linter:

npm run lint

TODO