Skip to content

Commit 487ea55

Browse files
committed
Add lint note to javascript guidelines
This adds a note about aegir-lint. See #225 (comment)
1 parent 607c2f2 commit 487ea55

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

js-project-guidelines.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ IPFS JavaScript projects default to [standard](https://github.com/feross/standar
9797

9898
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).
9999

100+
Using [aegir-lint](#aegir) will help you do this easily; it automatically lints your documents.
101+
100102
### Testing
101103

102104
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.

0 commit comments

Comments
 (0)