Skip to content

Commit 78efcd0

Browse files
committed
Enable rule
1 parent 9a1b399 commit 78efcd0

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

etc/eslint/rules/stdlib.js

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,51 @@ rules[ 'stdlib/jsdoc-definition-case' ] = 'error';
283283
*/
284284
rules[ 'stdlib/jsdoc-definition-spacing' ] = 'error';
285285

286+
/**
287+
* Require `_` be used as the emphasis marker.
288+
*
289+
* @name jsdoc-emphasis-marker
290+
* @memberof rules
291+
* @type {Array}
292+
* @default [ 'error', '_' ]
293+
* @see [definition-case]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker}
294+
*
295+
* @example
296+
* // Bad...
297+
*
298+
* /**
299+
* * Squares a *number*.
300+
* *
301+
* * @arg {number} x - input number
302+
* * @return {number} x squared
303+
* *
304+
* * @examples
305+
* * var y = square( 2.0 );
306+
* * // returns 4.0
307+
* *\/
308+
* function square( x ) {
309+
* return x*x;
310+
* }
311+
*
312+
* @example
313+
* // Good...
314+
*
315+
* /**
316+
* * Squares a _number_.
317+
* *
318+
* * @arg {number} x - input number
319+
* * @return {number} x squared
320+
* *
321+
* * @examples
322+
* * var y = square( 2.0 );
323+
* * // returns 4.0
324+
* *\/
325+
* function square( x ) {
326+
* return x*x;
327+
* }
328+
*/
329+
rules[ 'stdlib/jsdoc-emphasis-marker' ] = [ 'error', '_' ];
330+
286331
/**
287332
* Lint JSDoc descriptions using remark.
288333
*

0 commit comments

Comments
 (0)