Skip to content

Commit 5f5bb2d

Browse files
stdlib-botkgryte
andauthored
docs: update namespace table of contents
PR-URL: #8425 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 2551c5f commit 5f5bb2d

File tree

54 files changed

+1479
-169
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1479
-169
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ var eslint = rules;
8080
- <span class="signature">[`no-require-index`][@stdlib/_tools/eslint/rules/no-require-index]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls which explicitly require `index.<ext>` files.</span>
8181
- <span class="signature">[`no-self-require`][@stdlib/_tools/eslint/rules/no-self-require]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that modules do not require themselves.</span>
8282
- <span class="signature">[`no-unassigned-require`][@stdlib/_tools/eslint/rules/no-unassigned-require]</span><span class="delimiter">: </span><span class="description">ESLint rule forbidding unassigned require statements.</span>
83+
- <span class="signature">[`no-unnecessary-nested-functions`][@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unnecessary function nesting when inner functions don't depend on outer scope variables.</span>
8384
- <span class="signature">[`repl-namespace-order`][@stdlib/_tools/eslint/rules/repl-namespace-order]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key).</span>
8485
- <span class="signature">[`require-file-extensions`][@stdlib/_tools/eslint/rules/require-file-extensions]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that `require()` calls of files end with a whitelisted file extension.</span>
8586
- <span class="signature">[`require-globals`][@stdlib/_tools/eslint/rules/require-globals]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that specified global variables are explicitly required.</span>
@@ -90,6 +91,7 @@ var eslint = rules;
9091
- <span class="signature">[`section-header-empty-lines`][@stdlib/_tools/eslint/rules/section-header-empty-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that section header comments are padded by empty lines.</span>
9192
- <span class="signature">[`section-headers`][@stdlib/_tools/eslint/rules/section-headers]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce formatting of section header comments.</span>
9293
- <span class="signature">[`ternary-condition-parentheses`][@stdlib/_tools/eslint/rules/ternary-condition-parentheses]</span><span class="delimiter">: </span><span class="description">ESLint rule requiring parentheses around ternary conditions.</span>
94+
- <span class="signature">[`tsdoc-declarations-doctest`][@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest]</span><span class="delimiter">: </span><span class="description">ESLint rule to ensure that return annotations in TSDoc examples match the actual output in TypeScript declaration files (`*.d.ts`).</span>
9395
- <span class="signature">[`uppercase-required-constants`][@stdlib/_tools/eslint/rules/uppercase-required-constants]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that required `stdlib` constants have uppercase variable names.</span>
9496
- <span class="signature">[`vars-order`][@stdlib/_tools/eslint/rules/vars-order]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing variable declarations inside of functions to be ordered by length.</span>
9597

@@ -428,6 +430,8 @@ console.log( getKeys( rules ) );
428430

429431
[@stdlib/_tools/eslint/rules/no-unassigned-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unassigned-require
430432

433+
[@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unnecessary-nested-functions
434+
431435
[@stdlib/_tools/eslint/rules/repl-namespace-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/repl-namespace-order
432436

433437
[@stdlib/_tools/eslint/rules/require-file-extensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-file-extensions
@@ -448,6 +452,8 @@ console.log( getKeys( rules ) );
448452

449453
[@stdlib/_tools/eslint/rules/ternary-condition-parentheses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/ternary-condition-parentheses
450454

455+
[@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/tsdoc-declarations-doctest
456+
451457
[@stdlib/_tools/eslint/rules/uppercase-required-constants]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/uppercase-required-constants
452458

453459
[@stdlib/_tools/eslint/rules/vars-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/vars-order

0 commit comments

Comments
 (0)