Skip to content

Commit 2983ed7

Browse files
committed
build: enable lint rule and add directives
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 1298006 commit 2983ed7

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

etc/eslint/rules/stdlib.js

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19-
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest */
19+
/* eslint-disable stdlib/jsdoc-doctest-marker, stdlib/jsdoc-doctest, stdlib/jsdoc-example-require-spacing */
2020

2121
'use strict';
2222

@@ -838,6 +838,49 @@ rules[ 'stdlib/jsdoc-emphasis-marker' ] = [ 'error', '_' ];
838838
*/
839839
rules[ 'stdlib/jsdoc-empty-line-before-example' ] = 'error';
840840

841+
/**
842+
* Enforce empty lines between requires and code in JSDoc examples.
843+
*
844+
* @name jsdoc-example-require-spacing
845+
* @memberof rules
846+
* @type {string}
847+
* @default 'error'
848+
*
849+
* @example
850+
* // Bad...
851+
*
852+
* /**
853+
* * Fréchet distribution constructor.
854+
* *
855+
* * @module @stdlib/stats/base/dists/frechet/ctor
856+
* *
857+
* * @example
858+
* * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
859+
* * var frechet = new Frechet( 1.0, 1.0, 0.5 );
860+
* *
861+
* * var y = frechet.cdf( 0.8 );
862+
* * // returns ~0.036
863+
* *\/
864+
*
865+
* @example
866+
* // Good...
867+
*
868+
* /**
869+
* * Fréchet distribution constructor.
870+
* *
871+
* * @module @stdlib/stats/base/dists/frechet/ctor
872+
* *
873+
* * @example
874+
* * var Frechet = require( '@stdlib/stats/base/dists/frechet/ctor' );
875+
* *
876+
* * var frechet = new Frechet( 1.0, 1.0, 0.5 );
877+
* *
878+
* * var y = frechet.cdf( 0.8 );
879+
* * // returns ~0.036
880+
* *\/
881+
*/
882+
rules[ 'stdlib/jsdoc-example-require-spacing' ] = 'error';
883+
841884
/**
842885
* Require `\`` be used as the fenced code marker.
843886
*

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing'
4242

4343
**Bad**:
4444

45-
<!-- eslint-disable stdlib/jsdoc-example-require-spacing -->
45+
<!-- eslint stdlib/jsdoc-example-require-spacing: "off", @cspell/spellchecker: "off" -->
4646

4747
```javascript
4848
/**
@@ -61,6 +61,8 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing'
6161

6262
**Good**:
6363

64+
<!-- eslint @cspell/spellchecker: "off" -->
65+
6466
```javascript
6567
/**
6668
* Fréchet distribution constructor.

lib/node_modules/@stdlib/_tools/eslint/rules/lib/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,15 @@ setReadOnly( rules, 'jsdoc-emphasis-marker', require( '@stdlib/_tools/eslint/rul
207207
*/
208208
setReadOnly( rules, 'jsdoc-empty-line-before-example', require( '@stdlib/_tools/eslint/rules/jsdoc-empty-line-before-example' ) );
209209

210+
/**
211+
* @name jsdoc-example-require-spacing
212+
* @memberof rules
213+
* @readonly
214+
* @type {Function}
215+
* @see {@link module:@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing}
216+
*/
217+
setReadOnly( rules, 'jsdoc-example-require-spacing', require( '@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing' ) );
218+
210219
/**
211220
* @name jsdoc-fenced-code-flag
212221
* @memberof rules

0 commit comments

Comments
 (0)