File tree Expand file tree Collapse file tree 3 files changed +23
-5
lines changed
lib/node_modules/@stdlib/_tools/repl-txt/rules/has-alias-signature Expand file tree Collapse file tree 3 files changed +23
-5
lines changed Original file line number Diff line number Diff line change 1+ {
2+ "@stdlib/_tools/repl-txt/rules/code-return-values": "error",
3+ "@stdlib/_tools/repl-txt/rules/code-semicolons": "error",
4+ "@stdlib/_tools/repl-txt/rules/has-parameters-section": "error",
5+ "@stdlib/_tools/repl-txt/rules/has-alias-signature": "error",
6+ "@stdlib/_tools/repl-txt/rules/line-length": [ "error", 80 ],
7+ "@stdlib/_tools/repl-txt/rules/match-signature": "error",
8+ "@stdlib/_tools/repl-txt/rules/resolvable-aliases": "error",
9+ "@stdlib/_tools/repl-txt/rules/section-order": "error",
10+ "@stdlib/_tools/repl-txt/rules/section-style": "error",
11+ "@stdlib/_tools/repl-txt/rules/see-also": "error",
12+ "@stdlib/_tools/repl-txt/rules/tag-description-style": "error",
13+ "@stdlib/_tools/repl-txt/rules/tag-typedef-typos": "error",
14+ "@stdlib/_tools/repl-txt/rules/whitelisted-sections": "error"
15+ }
Original file line number Diff line number Diff line change @@ -26,22 +26,22 @@ var startsWith = require( '@stdlib/string/starts-with' );
2626// MAIN //
2727
2828/**
29- * Rule for enforcing that documentation starts with a proper function signature.
29+ * Rule for enforcing that documentation starts with an alias signature.
3030*
3131* @param {Context } context - lint context
3232* @returns {Object } validators
3333*/
3434function main ( context ) {
3535 /**
36- * Checks whether function documentation starts with a proper function signature.
36+ * Checks whether function documentation starts with an alias signature.
3737 *
3838 * @private
3939 * @param {Object } ast - full AST
4040 */
4141 function hasSignature ( ast ) {
4242 var signature = ast . signature ;
4343 if ( ! signature ) {
44- context . report ( 'REPL documentation must start with function signature' , ast ) ;
44+ context . report ( 'REPL documentation must start with an alias signature' , ast ) ;
4545 }
4646 if ( ast . idx === 0 && ! startsWith ( signature . raw , '{{alias}}' ) ) {
4747 context . report ( 'First function signature must start with `{{alias}}`' , ast ) ;
Original file line number Diff line number Diff line change 11{
2- "name" : " @stdlib/_tools/repl-txt/rules/has-signature" ,
2+ "name" : " @stdlib/_tools/repl-txt/rules/has-alias- signature" ,
33 "version" : " 0.0.0" ,
4- "description" : " Lint rule to enforce that documentation starts with a proper function signature." ,
4+ "description" : " Lint rule to enforce that documentation starts with an alias signature." ,
55 "license" : " Apache-2.0" ,
66 "author" : {
77 "name" : " The Stdlib Authors" ,
5757 " plugin" ,
5858 " code" ,
5959 " function" ,
60+ " constant" ,
61+ " alias" ,
62+ " aliases" ,
6063 " signature"
6164 ]
6265}
You can’t perform that action at this time.
0 commit comments