Skip to content

Commit

Permalink
feat(responsibilities): clean dependencies and config
Browse files Browse the repository at this point in the history
* build(dependencies): add eslint-config-scanjs
* build(dependencies): remove pluralize (unused)
* build(manifest): update node.engines to >=7.0.0
* ci(bithound): exclude tests from analysis
* docs(api): update
* docs(issues): revise ISSUE_TEMPLATE copy
* style(eslint): alphabetize and beautify .eslintrc.[yml,json]
* style(eslint): update parserOptions to ES 2017 and Node v7.x or higher
* style(scanjs): enable eslint-plugin-scanjs

#44,#187
  • Loading branch information
gregswindle committed Jan 15, 2018
1 parent 8df0000 commit 8de115a
Show file tree
Hide file tree
Showing 29 changed files with 1,588 additions and 960 deletions.
27 changes: 14 additions & 13 deletions .bithoundrc
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
{
"critics": {
"lint": {
"engine": "eslint"
}
},
"ignore": [
"**/node_modules/**",
"docs/** "
],
"test": [
"**/tests/**",
"**/*.spec.js"
]
"critics":{
"lint":{
"engine":"eslint"
}
},
"ignore":[
"**/node_modules/**",
"docs/**",
"tests/**"
],
"test":[
"**/tests/**",
"**/*.spec.js"
]
}
568 changes: 253 additions & 315 deletions .eslintrc.yml

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -890,12 +890,13 @@
| [esquery@1.0.0](https://github.com/jrfeenst/esquery#readme) | A query library for ECMAScript AST using a CSS selector like query language. | 1.0.0 | BSD | production |
| [lodash@4.17.4](https://lodash.com/) | Lodash modular utilities. | 4.17.4 | MIT | production |
| [meow@4.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production |
| [pluralize@7.0.0](https://github.com/blakeembrey/pluralize#readme) | Pluralize and singularize any word | 7.0.0 | MIT | production |
| [requireindex@1.1.0](https://github.com/stephenhandley/requireindex#readme) | Write minimal node index.js files that require and export siblings by file basename | 1.1.0 | MIT | production |
| [babel-register@6.26.0](https://github.com/babel/babel/tree/master/packages/babel-register) | babel require hook | 6.26.0 | MIT | dev |
| [bithound@1.7.0](https://github.com/bithound/cli.bithound.io) | Commands for interacting with bitHound: https://bithound.io | 1.7.0 | MIT | dev |
| [chai@4.1.2](http://chaijs.com) | BDD/TDD assertion library for node.js and the browser. Test framework agnostic. | 4.1.2 | MIT | dev |
| [coveralls@3.0.0](https://github.com/nickmerwin/node-coveralls#readme) | takes json-cov output into stdin and POSTs to coveralls.io | 3.0.0 | BSD-2-Clause | dev |
| [docdash@0.4.0](https://github.com/clenemt/docdash#readme) | A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami | 0.4.0 | Apache-2.0 | dev |
| [eslint-config-scanjs@1.0.0-beta4](https://github.com/mozfreddyb/eslint-config-scanjs#readme) | umbrella config to get scanjs-like functionality from eslint | 1.0.0-beta4 | MPL-2.0 | dev |
| [eslint-config-xo-space@0.17.0](https://github.com/sindresorhus/eslint-config-xo-space#readme) | ESLint shareable config for XO with 2-space indent | 0.17.0 | MIT | dev |
| [eslint-plugin-import@2.8.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.8.0 | MIT | dev |
| [eslint-plugin-jsdoc@3.3.1](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.3.1 | BSD-3-Clause | dev |
Expand All @@ -906,6 +907,7 @@
| [eslint-plugin-scanjs-rules@0.2.1](https://github.com/mozfreddyb/eslint-plugin-scanjs-rules/) | ESLint plugin that contains ScanJS rules | 0.2.1 | MPL-2.0 | dev |
| [eslint-plugin-security@1.4.0](https://github.com/nodesecurity/eslint-plugin-security#readme) | Security rules for eslint | 1.4.0 | Apache-2.0 | dev |
| [eslint-plugin-standard@3.0.1](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev |
| [eslint-plugin-unicorn@3.0.1](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 3.0.1 | MIT | dev |
| [eslint-plugin-xss@0.1.9](https://github.com/Rantanen/eslint-plugin-xss#readme) | Validates XSS related issues of mixing HTML and non-HTML content in variables. | 0.1.9 | ISC | dev |
| [jsdoc@3.5.5](https://github.com/jsdoc3/jsdoc#readme) | An API documentation generator for JavaScript. | 3.5.5 | Apache-2.0 | dev |
| [lec@^1.0.1](https://github.com/iShafayet/lec) | Command Line Wrapper for Line Ending Corrector (An utility that makes sure your files have consistent line endings) | 1.0.1 | MIT | dev |
Expand All @@ -918,6 +920,7 @@
| [nyc@11.4.1](https://github.com/istanbuljs/nyc#readme) | the Istanbul command line interface | 11.4.1 | ISC | dev |
| [properties-parser@0.3.1](https://github.com/xavi-/node-properties-parser#readme) | A parser for .properties files written in javascript | 0.3.1 | MIT | dev |
| [semantic-release@12.2.2](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 12.2.2 | MIT | dev |
| [simple-mock@0.8.0](https://github.com/jupiter/simple-mock) | Super simple stubs and spies with 1-step sandbox restore | 0.8.0 | MIT | dev |
| [snyk@1.68.0](https://github.com/snyk/snyk#readme) | snyk library and cli utility | 1.68.0 | Apache-2.0 | dev |
| [standard-version@4.3.0](https://github.com/conventional-changelog/standard-version#readme) | replacement for `npm version` with automatic CHANGELOG generation | 4.3.0 | ISC | dev |
<!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE:dev=true) -->
Expand Down
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,23 @@

<!--- If you're suggesting a change/improvement, uncomment this block -->
## User story

As an API producer and consumer,
I must/need/want/should {do something}
In order to {achieve business value}.
In order to {add value}.

<!--- Write each criterion in the present tense. Criteria should express the
plugin's state once the ESLint: Rule's or ESLint: Processor's requirements
have been met and all tests pass with full coverage. -->
## Acceptance criteria

- [ ] 1. {criterion-one}
- [ ] 2. {criterion-two}
- [ ] 3. {criterion-three}
- [ ] 4. {criterion-four}

#### :zap: Rule developers _must_ use the `eslint:rule` subgenerator!

> When you create a new rule, be sure to use the `eslint:rule` subgenerator, since it will
> 1. Create a stubbed rule,
> 2. The rule's stubbed BDD specs,
Expand Down
8 changes: 4 additions & 4 deletions docs/api/eslint-plugin-crc/0.2.0/ClassMatcherCrcClass.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h4 class="name" id="ClassMatcherCrcClass"><span class="type-signature"></span>n

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line11">line 11</a>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line12">line 12</a>
</li></ul></dd>


Expand Down Expand Up @@ -173,7 +173,7 @@ <h4 class="name" id=".descriptor"><span class="type-signature">(static) </span>d

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line40">line 40</a>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line43">line 43</a>
</li></ul></dd>


Expand Down Expand Up @@ -242,7 +242,7 @@ <h4 class="name" id=".factory"><span class="type-signature">(static) </span>fact

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line23">line 23</a>
<a href="crc_descriptors_class-matcher-crc-class.js.html">crc/descriptors/class-matcher-crc-class.js</a>, <a href="crc_descriptors_class-matcher-crc-class.js.html#line25">line 25</a>
</li></ul></dd>


Expand Down Expand Up @@ -404,7 +404,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/eslint-plugin-crc/0.2.0/CrcClass.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h4 class="name" id="CrcClass"><span class="type-signature"></span>new CrcClass<

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line44">line 44</a>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line61">line 61</a>
</li></ul></dd>


Expand Down Expand Up @@ -547,7 +547,7 @@ <h4 class="name" id=".factory"><span class="type-signature">(static) </span>fact

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line89">line 89</a>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line106">line 106</a>
</li></ul></dd>


Expand Down Expand Up @@ -709,7 +709,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/eslint-plugin-crc/0.2.0/CrcContext.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h4 class="name" id="CrcContext"><span class="type-signature"></span>new CrcCont

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-context.js.html">crc/crc-context.js</a>, <a href="crc_crc-context.js.html#line12">line 12</a>
<a href="crc_crc-context.js.html">crc/crc-context.js</a>, <a href="crc_crc-context.js.html#line13">line 13</a>
</li></ul></dd>


Expand Down Expand Up @@ -167,7 +167,7 @@ <h4 class="name" id=".create"><span class="type-signature">(static) </span>creat

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-context.js.html">crc/crc-context.js</a>, <a href="crc_crc-context.js.html#line29">line 29</a>
<a href="crc_crc-context.js.html">crc/crc-context.js</a>, <a href="crc_crc-context.js.html#line32">line 32</a>
</li></ul></dd>


Expand Down Expand Up @@ -352,7 +352,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/eslint-plugin-crc/0.2.0/CrcModel.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h4 class="name" id="CrcModel"><span class="type-signature"></span>new CrcModel<

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-model.js.html">crc/crc-model.js</a>, <a href="crc_crc-model.js.html#line19">line 19</a>
<a href="crc_crc-model.js.html">crc/crc-model.js</a>, <a href="crc_crc-model.js.html#line21">line 21</a>
</li></ul></dd>


Expand Down Expand Up @@ -401,7 +401,7 @@ <h6>Properties</h6>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/eslint-plugin-crc/0.2.0/CrcResponsibility.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h4 class="name" id="CrcResponsibility"><span class="type-signature"></span>new

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-responsibility.js.html">crc/crc-responsibility.js</a>, <a href="crc_crc-responsibility.js.html#line64">line 64</a>
<a href="crc_crc-responsibility.js.html">crc/crc-responsibility.js</a>, <a href="crc_crc-responsibility.js.html#line78">line 78</a>
</li></ul></dd>


Expand Down Expand Up @@ -167,7 +167,7 @@ <h4 class="name" id=".create"><span class="type-signature">(static) </span>creat

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-responsibility.js.html">crc/crc-responsibility.js</a>, <a href="crc_crc-responsibility.js.html#line76">line 76</a>
<a href="crc_crc-responsibility.js.html">crc/crc-responsibility.js</a>, <a href="crc_crc-responsibility.js.html#line91">line 91</a>
</li></ul></dd>


Expand Down Expand Up @@ -350,7 +350,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
101 changes: 57 additions & 44 deletions docs/api/eslint-plugin-crc/0.2.0/crc_ast-config.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,83 +38,96 @@ <h1 class="page-title">crc/ast-config.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
@fileoverview Espree AST parsing options. Ensure that the "tokens" property is set to true
in order for CRC models to maintain a list of "references", i.e., where they
themselves are referenced.
* @fileoverview Espree AST parsing options. Ensure that the "tokens" property is set to true
* in order for CRC models to maintain a list of "references", i.e., where they
* themselves are referenced.
*/

module.exports = {

/**
* Attach range information to each node.
* Attach comments to the closest relevant node as leadingComments and
* trailingComments.
*/
range: true,

/**
* Attach line/column location information to each node.
*/
loc: true,
"attachComment": true,

/**
* Create a top-level comments array containing all comments.
*/
comment: true,

/**
* Attach comments to the closest relevant node as leadingComments and
* trailingComments.
*/
attachComment: true,
"comment": true,

/**
* Create a top-level tokens array containing all tokens
* Specify additional language features
*/
tokens: true,

"ecmaFeatures": {

/**
* Allow experimental object rest/spread
*/

"experimentalObjectRestSpread": true,

/**
* Enable return in global scope
*/

"globalReturn": true,

/**
* Enable implied strict mode (if ecmaVersion >= 5)
*/

"impliedStrict": true,

/**
* Enable JSX parsing
*/

"jsx": true
},

/**
* Specify the version of ECMAScript syntax you want to use.
* Valid versions are:
* * 3
* * 5 (default)
* * 6
* * 7
* * 8
* * 6 (2015)
* * 7 (2016)
* * 8 (2017)
* * 9
* You can also set to 2015 (same as 6), 2016 (same as 7), or 2017
* (same as 8) to use the year-based naming.
*/
ecmaVersion: 6,

"ecmaVersion": 6,

/**
* Specify which type of script you're parsing (script or module, default
* is script)
* Attach line/column location information to each node.
*/
sourceType: "module",

"loc": true,

/**
* Specify additional language features
* Attach range information to each node.
*/
ecmaFeatures: {

/**
* Enable JSX parsing
*/
jsx: true,
"range": true,

/**
* Enable return in global scope
*/
globalReturn: true,
/**
* Specify which type of script you're parsing (script or module, default
* is script)
*/

/**
* Enable implied strict mode (if ecmaVersion >= 5)
*/
impliedStrict: true,
"sourceType": "module",

/**
* Allow experimental object rest/spread
*/
experimentalObjectRestSpread: true
}
/**
* Create a top-level tokens array containing all tokens
*/

"tokens": true
};
</code></pre>
</article>
Expand All @@ -128,7 +141,7 @@ <h1 class="page-title">crc/ast-config.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 01:37:09 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 14 2018 20:20:34 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 8de115a

Please sign in to comment.