@@ -542,6 +542,13 @@ rules[ 'stdlib/jsdoc-fenced-code-marker' ] = [ 'error', '`' ];
542542*/
543543rules [ 'stdlib/jsdoc-final-definition' ] = 'error' ;
544544
545+ /**
546+ * Require first heading level be a level `2` heading in JSDoc comments. A level `1` heading is implied.
547+ *
548+ * @see [first-heading-level]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-first-heading-level}
549+ */
550+ rules [ 'stdlib/jsdoc-first-heading-level' ] = [ 'error' , 2 ] ;
551+
545552/**
546553* Prevent too many spaces from being used to hard break.
547554*
@@ -593,6 +600,61 @@ rules[ 'stdlib/jsdoc-final-definition' ] = 'error';
593600*/
594601rules [ 'stdlib/jsdoc-hard-break-spaces' ] = 'error' ;
595602
603+ /**
604+ * Warn when headings increment by more than 1 level.
605+ *
606+ * @see [heading-increment]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-increment}
607+ */
608+ rules [ 'stdlib/jsdoc-heading-increment' ] = [ 'warn' ] ;
609+
610+ /**
611+ * Require `atx` heading style.
612+ *
613+ * @see [heading-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style}
614+ *
615+ * @example
616+ * // Bad...
617+ *
618+ * /**
619+ * * Returns a pseudo-random number on `[0,1]`
620+ * *
621+ * * Beep
622+ * * ===
623+ * *
624+ * * ## Boop
625+ * *
626+ * * @returns {number } uniform random number
627+ * *
628+ * * @example
629+ * * var y = rand();
630+ * * // e.g., returns 0.5363925252089496
631+ * *\/
632+ * function rand() {
633+ * return Math.random();
634+ * }
635+ *
636+ * @example
637+ * // Good...
638+ *
639+ * /**
640+ * * Returns a pseudo-random number on `[0,1]`
641+ * *
642+ * * # Beep
643+ * *
644+ * * ## Boop
645+ * *
646+ * * @returns {number } uniform random number
647+ * *
648+ * * @example
649+ * * var y = rand();
650+ * * // e.g., returns 0.5363925252089496
651+ * *\/
652+ * function rand() {
653+ * return Math.random();
654+ * }
655+ */
656+ rules [ 'stdlib/jsdoc-heading-style' ] = [ 'error' , 'atx' ] ;
657+
596658/**
597659* Require that JSDoc descriptions start with an uppercase letter and end with a period.
598660*
0 commit comments