File tree Expand file tree Collapse file tree 1 file changed +2
-24
lines changed Expand file tree Collapse file tree 1 file changed +2
-24
lines changed Original file line number Diff line number Diff line change 16
16
- [ Versioning & Semver] ( #versioning--semver )
17
17
- [ Usage] ( #usage )
18
18
- [ Rules] ( #rules )
19
- - [ Browser Usage] ( #browser-usage )
20
19
21
20
## Plugin installation
22
21
22
+ ** NB** Since ` jscs v2.0 ` the plugin ` jscs-jsdoc ` is bundled into it.
23
+
23
24
` jscs-jsdoc ` can be installed using NPM and requires [ jscs] ( https://github.com/jscs-dev/node-jscs/#installation ) .
24
25
25
26
Install it globally if you are using globally installed ` jscs `
@@ -961,26 +962,3 @@ function method() {
961
962
return false ;
962
963
}
963
964
```
964
-
965
-
966
- ## Browser Usage
967
-
968
- NOT SUPPORTED ATM. SORRY.
969
-
970
- File [ jscs-jsdoc-browser.js] ( jscs-jsdoc-browser.js ) contains browser-compatible version of ` jscs-jsdoc ` .
971
-
972
- Download and include ` jscs-jsdoc-browser.js ` into your page just after ` jscs-browser.js ` .
973
-
974
- ``` html
975
- <script src =" jscs-browser.js" ></script >
976
- <script src =" jscs-jsdoc-browser.js" ></script >
977
- <script >
978
- var checker = new JscsStringChecker ();
979
- checker .registerDefaultRules ();
980
- checker .configure ({' jsDoc' : {/* ... */ }});
981
- var errors = checker .checkString (' var x, y = 1;' );
982
- errors .getErrorList ().forEach (function (error ) {
983
- console .log (errors .explainError (error));
984
- });
985
- </script >
986
- ```
You can’t perform that action at this time.
0 commit comments