Skip to content

Commit

Permalink
Add lint note to javascript guidelines
Browse files Browse the repository at this point in the history
This adds a note about aegir-lint. See #225 (comment)
  • Loading branch information
RichardLitt committed Feb 7, 2017
1 parent 607c2f2 commit 487ea55
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions js-project-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ IPFS JavaScript projects default to [standard](https://github.com/feross/standar

However, we've added an extra linting rule: Enforce the use of [strict mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode). This avoids issues we had when using ES2015 features outside of strict mode. We enforce this rule by using [eslint](http://eslint.org/) and extending [standard module](https://github.com/feross/standard) with the [eslint-config-standard](https://github.com/feross/eslint-config-standard).

Using [aegir-lint](#aegir) will help you do this easily; it automatically lints your documents.

### Testing

Since `js-ipfs` is meant to be both a Node.js and Browser app, we strongly recommend having tests that run in both platforms, always. For most cases, we use [mocha](http://mochajs.org) to run write the tests and [karma](http://karma-runner.github.io) to automate the test execution in the browser. This solution has been extremely convenient.
Expand Down

0 comments on commit 487ea55

Please sign in to comment.