@zthun/janitor-web 18.0.5 → 18.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/dist/assets/hierarchy.js +1 -0
  2. package/dist/assets/icons.js +1 -1
  3. package/dist/assets/icons.svg +1 -1
  4. package/dist/assets/main.js +5 -5
  5. package/dist/assets/navigation.js +1 -1
  6. package/dist/assets/search.js +1 -1
  7. package/dist/assets/style.css +1435 -1288
  8. package/dist/classes/_zthun_lint-janitor.ZConfigExtender.html +23 -0
  9. package/dist/classes/_zthun_lint-janitor.ZConfigReaderCosmic.html +27 -0
  10. package/dist/classes/_zthun_lint-janitor.ZConfigReaderNull.html +6 -0
  11. package/dist/classes/_zthun_lint-janitor.ZConfigReaderPrettier.html +8 -0
  12. package/dist/classes/_zthun_lint-janitor.ZContentLinterHtml.html +9 -0
  13. package/dist/classes/_zthun_lint-janitor.ZContentLinterJson.html +6 -0
  14. package/dist/classes/_zthun_lint-janitor.ZContentLinterPretty.html +9 -0
  15. package/dist/classes/_zthun_lint-janitor.ZContentLinterYaml.html +7 -0
  16. package/dist/classes/_zthun_lint-janitor.ZFileReportLint.html +13 -0
  17. package/dist/classes/_zthun_lint-janitor.ZLintJanitor.html +39 -0
  18. package/dist/classes/_zthun_lint-janitor.ZLinterEs.html +16 -0
  19. package/dist/classes/_zthun_lint-janitor.ZLinterFile.html +13 -0
  20. package/dist/classes/_zthun_lint-janitor.ZLinterMarkdown.html +12 -0
  21. package/dist/classes/_zthun_lint-janitor.ZLinterSilent.html +8 -0
  22. package/dist/classes/_zthun_lint-janitor.ZLinterSpelling.html +13 -0
  23. package/dist/classes/_zthun_lint-janitor.ZLinterStyle.html +12 -0
  24. package/dist/hierarchy.html +1 -2
  25. package/dist/index.html +4 -5
  26. package/dist/interfaces/_zthun_lint-janitor.IZConfigDiscovery.html +6 -0
  27. package/dist/interfaces/_zthun_lint-janitor.IZConfigExtender.html +5 -0
  28. package/dist/interfaces/_zthun_lint-janitor.IZConfigReader.html +6 -0
  29. package/dist/interfaces/_zthun_lint-janitor.IZContentLinter.html +9 -0
  30. package/dist/interfaces/_zthun_lint-janitor.IZLintJanitorArgs.html +4 -0
  31. package/dist/interfaces/_zthun_lint-janitor.IZLintJanitorOptions.html +21 -0
  32. package/dist/interfaces/_zthun_lint-janitor.IZLinter.html +10 -0
  33. package/dist/modules/_zthun_eslint-config.html +13 -0
  34. package/dist/modules/_zthun_htmlhint-config.html +14 -0
  35. package/dist/modules/_zthun_lint-janitor-config.html +6 -0
  36. package/dist/modules/_zthun_lint-janitor.html +264 -0
  37. package/dist/modules/_zthun_markdownlint-config.html +17 -0
  38. package/dist/modules/_zthun_prettier-config.html +10 -0
  39. package/dist/modules/_zthun_stylelint-config-less.html +11 -0
  40. package/dist/modules/_zthun_stylelint-config-sass.html +11 -0
  41. package/dist/modules/_zthun_stylelint-config.html +10 -0
  42. package/dist/modules.html +1 -2
  43. package/package.json +6 -7
  44. package/dist/classes/_zthun_lint_janitor.ZConfigExtender.html +0 -24
  45. package/dist/classes/_zthun_lint_janitor.ZConfigReaderCosmic.html +0 -28
  46. package/dist/classes/_zthun_lint_janitor.ZConfigReaderNull.html +0 -7
  47. package/dist/classes/_zthun_lint_janitor.ZConfigReaderPrettier.html +0 -9
  48. package/dist/classes/_zthun_lint_janitor.ZContentLinterHtml.html +0 -10
  49. package/dist/classes/_zthun_lint_janitor.ZContentLinterJson.html +0 -7
  50. package/dist/classes/_zthun_lint_janitor.ZContentLinterPretty.html +0 -10
  51. package/dist/classes/_zthun_lint_janitor.ZContentLinterYaml.html +0 -8
  52. package/dist/classes/_zthun_lint_janitor.ZFileReportLint.html +0 -14
  53. package/dist/classes/_zthun_lint_janitor.ZLintJanitor.html +0 -40
  54. package/dist/classes/_zthun_lint_janitor.ZLinterEs.html +0 -17
  55. package/dist/classes/_zthun_lint_janitor.ZLinterFile.html +0 -14
  56. package/dist/classes/_zthun_lint_janitor.ZLinterMarkdown.html +0 -13
  57. package/dist/classes/_zthun_lint_janitor.ZLinterSilent.html +0 -9
  58. package/dist/classes/_zthun_lint_janitor.ZLinterSpelling.html +0 -14
  59. package/dist/classes/_zthun_lint_janitor.ZLinterStyle.html +0 -13
  60. package/dist/interfaces/_zthun_lint_janitor.IZConfigDiscovery.html +0 -7
  61. package/dist/interfaces/_zthun_lint_janitor.IZConfigExtender.html +0 -6
  62. package/dist/interfaces/_zthun_lint_janitor.IZConfigReader.html +0 -7
  63. package/dist/interfaces/_zthun_lint_janitor.IZContentLinter.html +0 -10
  64. package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorArgs.html +0 -5
  65. package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorOptions.html +0 -22
  66. package/dist/interfaces/_zthun_lint_janitor.IZLinter.html +0 -11
  67. package/dist/modules/_zthun_eslint_config.html +0 -14
  68. package/dist/modules/_zthun_htmlhint_config.html +0 -15
  69. package/dist/modules/_zthun_lint_janitor.html +0 -288
  70. package/dist/modules/_zthun_lint_janitor_config.html +0 -7
  71. package/dist/modules/_zthun_markdownlint_config.html +0 -18
  72. package/dist/modules/_zthun_prettier_config.html +0 -11
  73. package/dist/modules/_zthun_stylelint_config.html +0 -11
  74. package/dist/modules/_zthun_stylelint_config_less.html +0 -12
  75. package/dist/modules/_zthun_stylelint_config_sass.html +0 -12
  76. /package/dist/{janitor.svg → assets/favicon.svg} +0 -0
package/dist/modules/_zthun_eslint-config.html ADDED
@@ -0,0 +1,13 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/eslint-config | Janitor</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Janitor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">@zthun/eslint-config</a></li></ul><h1>Module @zthun/eslint-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="eslint-config" class="tsd-anchor-link">ESLint Config<a href="#eslint-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared eslint configuration for zthun scoped projects.</p>
2
+ <h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
3
+ </code><button type="button">Copy</button></pre>
4
+
5
+ <p>Make sure to install typescript and @typescript-eslint/eslint-plugin with all
6
+ peer dependencies.</p>
7
+ <h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the .eslintrc file, add the following</p>
8
+ <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/eslint-config&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
9
+ </code><button type="button">Copy</button></pre>
10
+
11
+ <p>That's it. You now have the recommended rules for zthun scoped projects with
12
+ typescript.</p>
13
+ </section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#eslint-config"><span>ES<wbr/>Lint <wbr/>Config</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Janitor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/modules/_zthun_htmlhint-config.html ADDED
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/htmlhint-config | Janitor</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Janitor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">@zthun/htmlhint-config</a></li></ul><h1>Module @zthun/htmlhint-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="htmlhint-config" class="tsd-anchor-link">HTMLHint Config<a href="#htmlhint-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared htmlhint configuration for zthun scoped projects. Note that
2
+ currently, as of htmlhint 0.14.x, extendable configs are not supported, but
3
+ lint-janitor indirectly adds support for it.</p>
4
+ <h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/htmlhint-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/htmlhint-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
5
+ </code><button type="button">Copy</button></pre>
6
+
7
+ <h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the htmlhint config file, add the following</p>
8
+ <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/htmlhint-config&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
9
+ </code><button type="button">Copy</button></pre>
10
+
11
+ <p>That's it. You now have the recommended rules for zthun scoped projects.</p>
12
+ <h2 id="htmlhint" class="tsd-anchor-link">HTMLHint<a href="#htmlhint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The actual HTMLHint application does NOT support the extends pattern without
13
+ lint-janitor.</p>
14
+ </section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#htmlhint-config"><span>HTML<wbr/>Hint <wbr/>Config</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#usage"><span>Usage</span></a></li><li><a href="#htmlhint"><span>HTML<wbr/>Hint</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Janitor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/modules/_zthun_lint-janitor-config.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/lint-janitor-config | Janitor</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Janitor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">@zthun/lint-janitor-config</a></li></ul><h1>Module @zthun/lint-janitor-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="lint-janitor-config" class="tsd-anchor-link">Lint Janitor Config<a href="#lint-janitor-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is a shared configuration for lint-janitor that contains all of the zthun
2
+ scoped shared configurations.</p>
3
+ <h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
4
+ </code><button type="button">Copy</button></pre>
5
+
6
+ </section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#lint-janitor-config"><span>Lint <wbr/>Janitor <wbr/>Config</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Janitor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/modules/_zthun_lint-janitor.html ADDED
@@ -0,0 +1,264 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/lint-janitor | Janitor</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Janitor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">@zthun/lint-janitor</a></li></ul><h1>Module @zthun/lint-janitor</h1></div><section class="tsd-panel tsd-typography"><h1 id="lint-janitor" class="tsd-anchor-link">Lint Janitor<a href="#lint-janitor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Code gets messy. You will find that most places you work at will always have a
2
+ big long list of tech debt tasks that need to be taken care of and this becomes
3
+ a maintenance nightmare as it becomes very expensive to fix. Companies rarely
4
+ want to let developers fix these issues because they tend to only look at the
5
+ short term ROI, which isn't high for this kind of task. What then happens is
6
+ that more functional, but messy, code gets introduced and the software begins to
7
+ rot.</p>
8
+ <p>One way to fix something like this is to start with linters. Linters will scour
9
+ through your code base and notify you that you have various issues. In a good
10
+ development pipeline, they will prevent developers from generating a messy room
11
+ and will force them to write clean consistent code with the rest of the
12
+ development team. They aren't a silver bullet, and messy solutions can still
13
+ crop up, but linters take care of most of the inconsistent and formatting errors
14
+ that can develop in a code base. Good developers love them - it keeps the entire
15
+ team consistent in their code structure.</p>
16
+ <p>Of course, linters are not without their issues as well. There's an outrageous
17
+ amount of them out there and you have to be well versed in each one of them in
18
+ order to set each one of them up and run them in your pipeline to verify all of
19
+ the different code files you have. There's linters for code, applications,
20
+ spelling, and formatting; it's easy to get overwhelmed.</p>
21
+ <p><strong>Lint Janitor</strong> was created under the guise that there is beauty in simplicity.
22
+ Having a single application that takes care of ones needs leads to greater
23
+ happiness then having to piece meal together tons of tools, each with individual
24
+ needs and maintainability issues. Just let <strong>Lint Janitor</strong> do the heavy lifting
25
+ for you.</p>
26
+ <h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
27
+ </code><button type="button">Copy</button></pre>
28
+
29
+ <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Lint Janitor uses an opt-in approach to linting, meaning that it will not lint
30
+ any files that you do not tell it to lint. You will need to add a configuration
31
+ file that describes the list of files to lint and the sub configurations of each
32
+ internal linter. Each linter is described in further detail. In the end, the
33
+ expectation is that you will provide you're own collection of shared
34
+ configurations that you can reuse in all your projects.</p>
35
+ <p>Lint Janitor uses the <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a>
36
+ standard for loading its configuration. In short, it will search the current
37
+ working directory for the following files:</p>
38
+ <ol>
39
+ <li>A property in your package.json named <strong>lint-janitor</strong>.</li>
40
+ <li>A json file or yaml file named <strong>lint-janitorrc</strong>.</li>
41
+ <li>A json file named <strong>lint-janitorrc.json</strong>.</li>
42
+ <li>A yaml file named <strong>lint-janitorrc.yaml</strong> or <strong>lint-janitorrc.yml</strong>.</li>
43
+ <li>A javascript file named <strong>lint-janitorrc.js</strong>, <strong>lint-janitor.config.js</strong>.</li>
44
+ </ol>
45
+ <blockquote>
46
+ <p>It is highly recommended to use a config.js convention for these types of
47
+ configurations. The main reason is that config.js offers the most flexible way
48
+ to configure an application and also naturally allows you to use the module
49
+ syntax to import other configurations.</p>
50
+ </blockquote>
51
+ <p>The configuration file uses the following schema.</p>
52
+ <pre><code class="ts"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for ECMAScript based linting.</span><br/><span class="hl-2"> </span><span class="hl-6">esConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for CSS, Less, and Sass based linting.</span><br/><span class="hl-2"> </span><span class="hl-6">styleConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for HTML linting.</span><br/><span class="hl-2"> </span><span class="hl-6">htmlConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for Markdown based linting</span><br/><span class="hl-2"> </span><span class="hl-6">markdownConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for Spelling checks</span><br/><span class="hl-2"> </span><span class="hl-6">spellingConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// The configuration file or module for formatting checks</span><br/><span class="hl-2"> </span><span class="hl-6">prettyConfig</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-0">// The white list of ECMAScript globs to lint. This should</span><br/><span class="hl-2"> </span><span class="hl-0">// include JavaScript and TypeScript based files</span><br/><span class="hl-2"> </span><span class="hl-0">// Note that eslint supports excludes directly in the</span><br/><span class="hl-2"> </span><span class="hl-0">// config file so there is no exclude support for it here.</span><br/><span class="hl-2"> </span><span class="hl-6">esFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of CSS, Less, and Sass globs to lint.</span><br/><span class="hl-2"> </span><span class="hl-0">// Note that stylelint supports excludes directly in</span><br/><span class="hl-2"> </span><span class="hl-0">// the config file so there is no exclude support for it here.</span><br/><span class="hl-2"> </span><span class="hl-6">styleFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of HTML globs to lint.</span><br/><span class="hl-2"> </span><span class="hl-6">htmlFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of HTML globs to exclude from linting.</span><br/><span class="hl-2"> </span><span class="hl-6">htmlFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of Markdown globs to lint.</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of Markdown globs to exclude from linting.</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of JSON globs to lint.</span><br/><span class="hl-2"> </span><span class="hl-6">jsonFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of JSON globs to exclude from linting.</span><br/><span class="hl-2"> </span><span class="hl-6">jsonFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of YAML globs to lint.</span><br/><span class="hl-2"> </span><span class="hl-6">yamlFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of YAML globs to exclude from linting.</span><br/><span class="hl-2"> </span><span class="hl-6">yamlFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of globs to check for spelling errors.</span><br/><span class="hl-2"> </span><span class="hl-6">spellingFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of globs to exclude from spell checking.</span><br/><span class="hl-2"> </span><span class="hl-6">spellingFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The white list of globs to check for code formatting.</span><br/><span class="hl-2"> </span><span class="hl-6">prettyFiles</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">// The black list of globs to exclude from code formatting.</span><br/><span class="hl-2"> </span><span class="hl-6">prettyFilesExclude</span><span class="hl-2">?: </span><span class="hl-6">string</span><span class="hl-2">[];</span><br/><span class="hl-2">}</span>
53
+ </code><button type="button">Copy</button></pre>
54
+
55
+ <p>The following is an example configuration that lint-janitor will read.</p>
56
+ <pre><code class="js"><span class="hl-0">// lint-janitor.config.js</span><br/><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-0">// Configurations are generally optional and will load using the</span><br/><span class="hl-2"> </span><span class="hl-0">// default rules of the application if not specified. However, you</span><br/><span class="hl-2"> </span><span class="hl-0">// can always override the configurations in this file.</span><br/><span class="hl-2"> </span><span class="hl-6">esConfig:</span><span class="hl-2"> </span><span class="hl-3">&#39;configs/.eslintrc&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-0">// Using globs to find files</span><br/><span class="hl-2"> </span><span class="hl-6">esFiles:</span><span class="hl-2"> [</span><span class="hl-3">&#39;packages/**/src/**/*.ts&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// The configurations can also be shared configuration modules</span><br/><span class="hl-2"> </span><span class="hl-0">// found in node_modules if you&#39;re not using IDE extensions.</span><br/><span class="hl-2"> </span><span class="hl-6">styleConfig:</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/stylelint-config&#39;</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">// Globs are relative to the current working directory.</span><br/><span class="hl-2"> </span><span class="hl-6">styleFiles</span><span class="hl-2">: [</span><span class="hl-3">&#39;packages/**/src/**/*.less&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// See notes on html below</span><br/><span class="hl-2"> </span><span class="hl-6">htmlFiles:</span><span class="hl-2"> [</span><span class="hl-3">&#39;packages/**/src/**/*.html&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// You can have as many globs as you want.</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFiles:</span><span class="hl-2"> [</span><span class="hl-3">&#39;packages/**/*.md&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;*.md&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// You can also exclude files from the include list. These are normally</span><br/><span class="hl-2"> </span><span class="hl-0">// used for code generated files and should not be linted.</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFilesExclude:</span><span class="hl-2"> [</span><span class="hl-3">&#39;**/CHANGELOG.md&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// You can also specify specific files - json and yaml have no</span><br/><span class="hl-2"> </span><span class="hl-0">// configurations as they are very specific formats.</span><br/><span class="hl-2"> </span><span class="hl-6">jsonFiles:</span><span class="hl-2"> [</span><span class="hl-3">&#39;package.json&#39;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-0">// Removes the linter</span><br/><span class="hl-2"> </span><span class="hl-6">spellingFiles:</span><span class="hl-2"> </span><span class="hl-4">null</span><br/><span class="hl-2">};</span>
57
+ </code><button type="button">Copy</button></pre>
58
+
59
+ <p>In your package json, add the following</p>
60
+ <pre><code class="sh"><span class="hl-1">&quot;scripts&quot;</span><span class="hl-1">:</span><span class="hl-2"> </span><span class="hl-3">{</span><br/><span class="hl-2"> </span><span class="hl-1">&quot;lint&quot;</span><span class="hl-1">:</span><span class="hl-2"> </span><span class="hl-3">&quot;lint-janitor&quot;</span><br/><span class="hl-2">}</span>
61
+ </code><button type="button">Copy</button></pre>
62
+
63
+ <p>Now you can lint everything with a single command.</p>
64
+ <pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">run</span><span class="hl-2"> </span><span class="hl-3">lint</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">lint</span><br/><span class="hl-0"># NPX</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">lint-janitor</span>
65
+ </code><button type="button">Copy</button></pre>
66
+
67
+ <h2 id="command-line" class="tsd-anchor-link">Command Line<a href="#command-line" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can always run lint-janitor on the command line using npx or if it is
68
+ installed globally, which is not recommended. There are very few command line
69
+ options, as lint-janitor intends to be fully driven by the config file.</p>
70
+ <p><strong>lint-janitor</strong> [options]</p>
71
+ <pre><code class="json"><span class="hl-2">[</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--version&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Show version number&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;boolean&quot;</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--config&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;alias&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;-c&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Optional config file to use&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;string&quot;</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--help&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Show help&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;boolean&quot;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">]</span>
72
+ </code><button type="button">Copy</button></pre>
73
+
74
+ <h2 id="linters" class="tsd-anchor-link">Linters<a href="#linters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="shared-configurations" class="tsd-anchor-link">Shared Configurations<a href="#shared-configurations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>While you can always recreate individual configurations for each linter, it is
75
+ <strong>HIGHLY</strong> recommended to create a set of shared configurations for your
76
+ organization. Most linters supported by Lint Janitor have some form of support
77
+ for extending configurations and sharing them so you don't need to reinvent the
78
+ wheel. In the place that such extensions are missing, Lint Janitor attempts to
79
+ bridge this gap but it will not add support for IDE based tooling and
80
+ extensions. You'll have to decide what's best for your project and your
81
+ organization.</p>
82
+ <p>One note is that the housing repository for lint-janitor contains multiple
83
+ shared configurations used by zthun scoped projects. You can use them, but it is
84
+ recommended for your organization to create it's own set of configurations that
85
+ meets its needs.</p>
86
+ <h3 id="json-and-yaml" class="tsd-anchor-link">JSON and YAML<a href="#json-and-yaml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>JSON does not use an external tool. It's impossible to have lint errors in JSON
87
+ as if there are, it wouldn't be valid JSON and you won't be able to parse it.
88
+ Thus, when we talk about linting JSON, it's really just a parse check to make
89
+ sure you're JSON is valid.</p>
90
+ <p>For YAML, the same rule applies. It's just a parse check, but since YAML isn't
91
+ supported in JavaScript out of the box, it uses
92
+ <a href="https://www.npmjs.com/package/js-yaml">js-yaml</a> under the hood to parse and
93
+ check your files.</p>
94
+ <p>Neither of these checks verify schemas so be warned about that.</p>
95
+ <h3 id="ecmascript" class="tsd-anchor-link">ECMAScript<a href="#ecmascript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The linter of choice for ECMAScript, is <a href="https://eslint.org/">ESLint</a>. ESLint
96
+ has a very large eco system with support for shared configurations and plugins.
97
+ It supports both TypeScript and JavaScript so it covers the entire feature
98
+ spectrum. The configuration file for ESLint uses something similar to a
99
+ <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard but it's more
100
+ restrictive. Instead, it looks for the following files in the current working
101
+ directory.</p>
102
+ <ol>
103
+ <li>.eslintrc.js</li>
104
+ <li>.eslintrc.cjs</li>
105
+ <li>.eslintrc.yaml</li>
106
+ <li>.eslintrc.yml</li>
107
+ <li>.eslintrc.json</li>
108
+ <li>package.json</li>
109
+ </ol>
110
+ <p>There is also a
111
+ <a href="https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint">VisualStudio Code plugin</a>
112
+ that will give you highlighting for any linting errors while you type. This
113
+ makes ESLint the go to linter for web based ECMAScript code.</p>
114
+ <p>For the configuration schema, you can find it
115
+ <a href="https://eslint.org/docs/user-guide/configuring/">here</a>. If you create a shared
116
+ configuration, as recommended, you can simply add that to the extends key in the
117
+ ESLint configuration file to share configuration throughout your organization.</p>
118
+ <pre><code class="js"><span class="hl-0">// .eslintrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/eslint-config&quot;</span><span class="hl-2">);</span>
119
+ </code><button type="button">Copy</button></pre>
120
+
121
+ <h3 id="styles-css-less-sass" class="tsd-anchor-link">Styles (CSS, Less, SASS)<a href="#styles-css-less-sass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>There are several linters for style based files.</p>
122
+ <ol>
123
+ <li><a href="https://github.com/CSSLint/csslint">CSSLint</a></li>
124
+ <li><a href="https://github.com/sasstools/sass-lint">SassLint</a></li>
125
+ <li><a href="https://stylelint.io/">StyleLint</a></li>
126
+ </ol>
127
+ <p>CSSLint and SassLint are no longer actively maintained. Thus, for linting style
128
+ based files, Lint Janitor uses StyleLint under the hood.</p>
129
+ <p>StyleLint is similar to <a href="https://eslint.org/">ESLint</a>. It too, has a nice
130
+ ecosystem of plugins and it supports shared configurations. Stylelint, unlike
131
+ ESLint, does support the
132
+ <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard, but it is
133
+ recommended to use .stylelintrc.json convention. The main reason is that the
134
+ actual
135
+ <a href="https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint">VisualStudio Code plugin</a>
136
+ specifically looks for this file so you can get lint errors directly in your
137
+ IDE.</p>
138
+ <p>You can find the configuration schema
139
+ <a href="https://stylelint.io/user-guide/configure">here</a> and you can use the extends
140
+ key in the configuration to load a shared configuration.</p>
141
+ <pre><code class="jsonc"><span class="hl-0">// .stylelintrc.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/stylelint-config&quot;</span><span class="hl-2">],</span><br/><span class="hl-2">}</span>
142
+ </code><button type="button">Copy</button></pre>
143
+
144
+ <p>As usual, the list of html rules are
145
+ <a href="https://htmlhint.com/docs/user-guide/list-rules">here</a>.</p>
146
+ <h3 id="html" class="tsd-anchor-link">HTML<a href="#html" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>There is not a lot of support for HTML linters. There is only really one that is
147
+ used and it is somewhat old and doesn't have a lot of support. A promise of a
148
+ 1.0.0 release has been made, but we will have to wait and see what happens. That
149
+ application is <a href="https://github.com/htmlhint/HTMLHint">HTMLHint</a>.</p>
150
+ <p>HTMLHint does NOT support shared configurations at all. To do that,
151
+ <a href="https://github.com/htmlhint/HTMLHint/issues/621">this issue</a> would need to be
152
+ approved and supported. In the meantime, Lint Janitor bridges this gap by
153
+ sending just the content to HTMLHint instead of the file list. This allows Lint
154
+ Janitor to implement a <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a>
155
+ standard for loading and extending the configuration to support shared configs.
156
+ It will be up to you if you want to do this because the
157
+ <a href="https://marketplace.visualstudio.com/items?itemName=mkaufman.HTMLHint">VisualStudio Code plugin</a>
158
+ does not support this and expects the standard json file to be at the root of
159
+ your project.</p>
160
+ <p>If you do choose to use a shared configuration, you can just use a
161
+ htmlhint.config.js file at the root of your repository.</p>
162
+ <pre><code class="js"><span class="hl-0">//htmlhint.config.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/htmlhint-config&quot;</span><span class="hl-2">);</span>
163
+ </code><button type="button">Copy</button></pre>
164
+
165
+ <h3 id="markdown" class="tsd-anchor-link">Markdown<a href="#markdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Good old markdown has a couple of linters available, but considering that
166
+ <a href="https://github.com/DavidAnson/markdownlint">MarkdownLint</a> has a working
167
+ <a href="https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint">VisualStudio Code plugin</a>,
168
+ that's the one that Lint Janitor uses.</p>
169
+ <p>MarkdownLint searches for the following configuration files at the root of your
170
+ repository.</p>
171
+ <ol>
172
+ <li>.markdownlint.json</li>
173
+ <li>.markdownlint.yaml or .markdownlint.yml</li>
174
+ <li>.markdownlintrc</li>
175
+ </ol>
176
+ <p>Strangely enough, if you are using the vscode plugin, then it is recommended to
177
+ just use the .markdownlint.json name because that seems to be the only one that
178
+ the plugin will respect. There's not a lot of rules to markdown. You can find
179
+ the list of rules <a href="https://github.com/DavidAnson/markdownlint">here</a>. While it's
180
+ not documented, MarkdownLint does have support for shared configurations, but
181
+ there is a gotcha with it. The actual shared configuration MUST be in a json
182
+ format. If you are creating a shared configuration for markdown, you will want
183
+ to export a module of it and also have an actual json formatted file that comes
184
+ along with it.</p>
185
+ <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;@zthun/markdownlint-config/as-json&quot;</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">// node_modules/@zthun/markdownlint-config/as-json.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;line-length&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;no-inline-html&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;no-duplicate-heading&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><br/><span class="hl-2">}</span>
186
+ </code><button type="button">Copy</button></pre>
187
+
188
+ <p>You can still export a node module that has your shared configuration.</p>
189
+ <pre><code class="js"><span class="hl-0">// index.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;./as-json.json&quot;</span><span class="hl-2">);</span>
190
+ </code><button type="button">Copy</button></pre>
191
+
192
+ <h3 id="spelling" class="tsd-anchor-link">Spelling<a href="#spelling" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This one is pretty optional, but it's useful in that it keeps you honest. With
193
+ spelling, you won't use a shared configuration as this is truly unique across
194
+ all projects. It is not possible to have a be all end all language that knows
195
+ every word in existence so this will look for the
196
+ <a href="https://www.npmjs.com/package/cspell">CSpell</a> configuration at the root of the
197
+ repository. If you combine this with the
198
+ <a href="https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker">VisualStudio Code plugin</a>,
199
+ it's pretty powerful and lets you add words as the repository vocabulary grows.
200
+ When using spelling here, you'll need to decide if there are words you want to
201
+ support, what dictionaries your repository is going to support, and what are
202
+ your forbidden words and phrases. There are no rules here, just lists of allowed
203
+ words and dictionaries.</p>
204
+ <p>You may want to consider having a shared dictionary for your organizations
205
+ custom lingo. You can do this through the dictionaryDefinitions key, but you'll
206
+ have to export a txt file for reuse.</p>
207
+ <pre><code class="json"><span class="hl-0">// cspell.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;version&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;0.1&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;$schema&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;language&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;en&quot;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;words&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;errored&quot;</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;dictionaries&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;typescript&quot;</span><span class="hl-2">, </span><span class="hl-3">&quot;en_US&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
208
+ </code><button type="button">Copy</button></pre>
209
+
210
+ <h3 id="formatting" class="tsd-anchor-link">Formatting<a href="#formatting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Finally, and possibly most importantly, is code formatting consistency. There
211
+ are generally two tools that are used for this.</p>
212
+ <ol>
213
+ <li><a href="https://editorconfig.org/">EditorConfig</a></li>
214
+ <li><a href="https://prettier.io/">Prettier</a></li>
215
+ </ol>
216
+ <p>For code formatting, Lint Janitor went with Prettier since it supports all the
217
+ features of EditorConfig and a bunch of others. Prettier also supports shared
218
+ configurations and is highly recommended to use them because the
219
+ <a href="https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode">VisualStudio Code plugin</a>
220
+ has support to auto format your files when you save them, making sure that your
221
+ teams formatting is completely consistent.</p>
222
+ <p>It's file lookup is similar to that of ESLint, but we recommended using
223
+ .prettierrc.js to enable support for shared configurations.</p>
224
+ <pre><code class="js"><span class="hl-0">//.prettierrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/prettier-config&quot;</span><span class="hl-2">);</span>
225
+ </code><button type="button">Copy</button></pre>
226
+
227
+ <p>Options are <a href="https://prettier.io/docs/en/options.html">here</a>, and there's not a
228
+ lot of them. See <a href="https://prettier.io/docs/en/option-philosophy.html">why</a>, as
229
+ there's a good reason for this.</p>
230
+ <p>When doing formatting linting, only the formatting is checked and you are
231
+ notified if the files are formatted or unformatted. The best way to prevent
232
+ these issues all together is to just use the Prettier IDE extension and auto
233
+ format as you type.</p>
234
+ <h3 id="faq" class="tsd-anchor-link">FAQ<a href="#faq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Q. Can this support my other favorite linter?</p>
235
+ <p>A. Possibly, but whether or not Lint Janitor will bother at the moment depends
236
+ on a few factors:</p>
237
+ <ol>
238
+ <li>Is there an IDE plugin that makes it so you can validate, lint, and cleanup
239
+ while you go along so you're not left with a lot of surprises at the end?</li>
240
+ <li>Does the linter support shared configuration to not reinvent the wheel
241
+ everywhere? Does Lint Janitor have to bridge that gap?</li>
242
+ <li>Is the linter in question a node linter that has its API exported and can be
243
+ integrated into a node application? <strong>Important!</strong></li>
244
+ </ol>
245
+ <p>If you answered No to the last question, then the answer is No. Lint Janitor
246
+ does not invoke external command lines of linters and instead calls into their
247
+ node API directly. This is how Lint Janitor succeeds in not having you worry
248
+ about what tools to install and what versions to use; it uses transitive
249
+ dependencies.</p>
250
+ <p>If the last question is a Yes, then it becomes a question of, is it worth it?
251
+ That'll need to be prioritized. For the most part, using
252
+ <a href="https://prettier.io/">Prettier</a> takes care of almost all linting issues so you
253
+ may not need more than what is available here. If you need the mother of all
254
+ linters, there is the heavy
255
+ <a href="https://github.com/nvuillam/mega-linter">Mega Linter</a> which aggregates every
256
+ linter in existence. Very cool, but a bit overkill for the solution we are
257
+ trying to solve with Lint Janitor.</p>
258
+ <p>Q. Is there an IDE plugin for Lint Janitor?</p>
259
+ <p>A. Not yet. That would solve the issue of wanting an IDE plugin for each
260
+ individual linter and would allow you to just have a single
261
+ lint-janitor.config.js file at the root of your repository that would handle all
262
+ linting needs. There is one planned, but it still need to be researched and
263
+ scoped out.</p>
264
+ </section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="zconfigextender"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZConfigExtender.html">ZConfigExtender</a><a href="#zconfigextender" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zconfigreadercosmic"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZConfigReaderCosmic.html">ZConfigReaderCosmic</a><a href="#zconfigreadercosmic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zconfigreadernull"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZConfigReaderNull.html">ZConfigReaderNull</a><a href="#zconfigreadernull" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zconfigreaderprettier"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZConfigReaderPrettier.html">ZConfigReaderPrettier</a><a href="#zconfigreaderprettier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zcontentlinterhtml"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZContentLinterHtml.html">ZContentLinterHtml</a><a href="#zcontentlinterhtml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zcontentlinterjson"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZContentLinterJson.html">ZContentLinterJson</a><a href="#zcontentlinterjson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zcontentlinterpretty"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZContentLinterPretty.html">ZContentLinterPretty</a><a href="#zcontentlinterpretty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zcontentlinteryaml"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZContentLinterYaml.html">ZContentLinterYaml</a><a href="#zcontentlinteryaml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zfilereportlint"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZFileReportLint.html">ZFileReportLint</a><a href="#zfilereportlint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlinteres"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterEs.html">ZLinterEs</a><a href="#zlinteres" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlinterfile"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterFile.html">ZLinterFile</a><a href="#zlinterfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlintermarkdown"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterMarkdown.html">ZLinterMarkdown</a><a href="#zlintermarkdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlintersilent"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterSilent.html">ZLinterSilent</a><a href="#zlintersilent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlinterspelling"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterSpelling.html">ZLinterSpelling</a><a href="#zlinterspelling" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlinterstyle"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLinterStyle.html">ZLinterStyle</a><a href="#zlinterstyle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="zlintjanitor"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_lint-janitor.ZLintJanitor.html">ZLintJanitor</a><a href="#zlintjanitor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Interfaces</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="izconfigdiscovery"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZConfigDiscovery.html">IZConfigDiscovery</a><a href="#izconfigdiscovery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izconfigextender"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZConfigExtender.html">IZConfigExtender</a><a href="#izconfigextender" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izconfigreader"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZConfigReader.html">IZConfigReader</a><a href="#izconfigreader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izcontentlinter"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZContentLinter.html">IZContentLinter</a><a href="#izcontentlinter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izlinter"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZLinter.html">IZLinter</a><a href="#izlinter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izlintjanitorargs"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZLintJanitorArgs.html">IZLintJanitorArgs</a><a href="#izlintjanitorargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="izlintjanitoroptions"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_lint-janitor.IZLintJanitorOptions.html">IZLintJanitorOptions</a><a href="#izlintjanitoroptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#lint-janitor"><span>Lint <wbr/>Janitor</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#command-line"><span>Command <wbr/>Line</span></a></li><li><a href="#linters"><span>Linters</span></a></li><li><ul><li><a href="#shared-configurations"><span>Shared <wbr/>Configurations</span></a></li><li><a href="#json-and-yaml"><span>JSON and <wbr/>YAML</span></a></li><li><a href="#ecmascript"><span>ECMA<wbr/>Script</span></a></li><li><a href="#styles-css-less-sass"><span>Styles (<wbr/>CSS, <wbr/>Less, <wbr/>SASS)</span></a></li><li><a href="#html"><span>HTML</span></a></li><li><a href="#markdown"><span>Markdown</span></a></li><li><a href="#spelling"><span>Spelling</span></a></li><li><a href="#formatting"><span>Formatting</span></a></li><li><a href="#faq"><span>FAQ</span></a></li></ul></li></ul><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#zconfigextender"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Config<wbr/>Extender</span></a><a href="#zconfigreadercosmic"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Config<wbr/>Reader<wbr/>Cosmic</span></a><a href="#zconfigreadernull"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Config<wbr/>Reader<wbr/>Null</span></a><a href="#zconfigreaderprettier"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Config<wbr/>Reader<wbr/>Prettier</span></a><a href="#zcontentlinterhtml"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Content<wbr/>Linter<wbr/>Html</span></a><a href="#zcontentlinterjson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Content<wbr/>Linter<wbr/>Json</span></a><a href="#zcontentlinterpretty"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Content<wbr/>Linter<wbr/>Pretty</span></a><a href="#zcontentlinteryaml"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Content<wbr/>Linter<wbr/>Yaml</span></a><a href="#zfilereportlint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>File<wbr/>Report<wbr/>Lint</span></a><a href="#zlinteres"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>Es</span></a><a href="#zlinterfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>File</span></a><a href="#zlintermarkdown"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>Markdown</span></a><a href="#zlintersilent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>Silent</span></a><a href="#zlinterspelling"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>Spelling</span></a><a href="#zlinterstyle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Linter<wbr/>Style</span></a><a href="#zlintjanitor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>Z<wbr/>Lint<wbr/>Janitor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Interfaces</summary><div><a href="#izconfigdiscovery"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Config<wbr/>Discovery</span></a><a href="#izconfigextender"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Config<wbr/>Extender</span></a><a href="#izconfigreader"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Config<wbr/>Reader</span></a><a href="#izcontentlinter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Content<wbr/>Linter</span></a><a href="#izlinter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Linter</span></a><a href="#izlintjanitorargs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Lint<wbr/>Janitor<wbr/>Args</span></a><a href="#izlintjanitoroptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZ<wbr/>Lint<wbr/>Janitor<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Janitor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/modules/_zthun_markdownlint-config.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/markdownlint-config | Janitor</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Janitor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">@zthun/markdownlint-config</a></li></ul><h1>Module @zthun/markdownlint-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="markdownlint-config" class="tsd-anchor-link">Markdownlint Config<a href="#markdownlint-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared markdownlint configuration for zthun scoped projects.</p>
2
+ <h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/markdownlint-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/markdownlint-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
3
+ </code><button type="button">Copy</button></pre>
4
+
5
+ <h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the markdownlint config file, add the following</p>
6
+ <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/markdownlint-config&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
7
+ </code><button type="button">Copy</button></pre>
8
+
9
+ <p>That's it. You now have the recommended rules for zthun scoped projects when
10
+ using lint-janitor.</p>
11
+ <p>If you are using the Atom or VSCode plugin, it may not recognize the imported js
12
+ configuration style. Instead, you can use the provided as-json.json file.</p>
13
+ <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;@zthun/markdownlint-config/as-json.json&quot;</span><br/><span class="hl-2">}</span>
14
+ </code><button type="button">Copy</button></pre>
15
+
16
+ <p>That works just as well.</p>
17
+ </section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#markdownlint-config"><span>Markdownlint <wbr/>Config</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Janitor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>