@zthun/janitor-web 19.5.1 → 19.5.3
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.
- package/dist/assets/style.css +3 -3
- package/dist/classes/_zthun_janitor-build-config.typedoc.ZTypedocConfigBuilder.html +16 -16
- package/dist/classes/_zthun_janitor-build-config.vite.ZViteConfigBuilder.html +15 -15
- package/dist/classes/_zthun_janitor-build-config.vite.ZViteLibraryBuilder.html +4 -4
- package/dist/classes/_zthun_janitor-build-config.vite.ZViteServerBuilder.html +2 -2
- package/dist/classes/_zthun_janitor-build-config.vite.ZViteTestBuilder.html +12 -12
- package/dist/classes/_zthun_janitor-lint.ZConfigExtender.html +4 -4
- package/dist/classes/_zthun_janitor-lint.ZConfigReaderCosmic.html +7 -7
- package/dist/classes/_zthun_janitor-lint.ZConfigReaderNull.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZConfigReaderPrettier.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZContentLinterHtml.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZContentLinterJson.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZContentLinterPretty.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZContentLinterYaml.html +2 -2
- package/dist/classes/_zthun_janitor-lint.ZJanitorLint.html +13 -13
- package/dist/classes/_zthun_janitor-lint.ZLinterEs.html +4 -4
- package/dist/classes/_zthun_janitor-lint.ZLinterFile.html +3 -3
- package/dist/classes/_zthun_janitor-lint.ZLinterMarkdown.html +3 -3
- package/dist/classes/_zthun_janitor-lint.ZLinterReport.html +3 -3
- package/dist/classes/_zthun_janitor-lint.ZLinterSilent.html +3 -3
- package/dist/classes/_zthun_janitor-lint.ZLinterSpelling.html +3 -3
- package/dist/classes/_zthun_janitor-lint.ZLinterStyle.html +3 -3
- package/dist/classes/_zthun_janitor-options.ZJanitorOptionsBuilder.html +3 -3
- package/dist/classes/_zthun_janitor-options.ZJanitorOptionsLintBuilder.html +35 -35
- package/dist/interfaces/_zthun_janitor-htmlhint-config.RuleSet.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZConfigDiscovery.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZConfigExtender.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZConfigReader.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZContentLinter.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZJanitorLintArgs.html +2 -2
- package/dist/interfaces/_zthun_janitor-lint.IZLinter.html +2 -2
- package/dist/interfaces/_zthun_janitor-options.IZJanitorOptions.html +2 -2
- package/dist/interfaces/_zthun_janitor-options.IZJanitorOptionsLint.html +22 -22
- package/dist/media/CONTRIBUTING.md +6 -6
- package/dist/modules/_zthun_janitor-build-config.html +2 -2
- package/dist/modules/_zthun_janitor-lint.html +23 -23
- package/dist/modules/_zthun_janitor-ts-config.html +6 -3
- package/dist/variables/_zthun_janitor-eslint-config.environments.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.imports.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.javascript.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.prettier.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.react.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.recommended.html +1 -1
- package/dist/variables/_zthun_janitor-eslint-config.typescript.html +1 -1
- package/dist/variables/_zthun_janitor-htmlhint-config.default.html +1 -1
- package/dist/variables/_zthun_janitor-markdownlint-config.default.html +1 -1
- package/dist/variables/_zthun_janitor-prettier-config.default.html +1 -1
- package/dist/variables/_zthun_janitor-stylelint-config-less.default.html +1 -1
- package/dist/variables/_zthun_janitor-stylelint-config-sass.default.html +1 -1
- package/dist/variables/_zthun_janitor-stylelint-config.default.html +1 -1
- package/package.json +6 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
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>IZJanitorOptionsLint | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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="../modules/_zthun_janitor-options.html">@zthun/janitor-options</a></li><li><a href="" aria-current="page">IZJanitorOptionsLint</a></li></ul><h1>Interface IZJanitorOptionsLint</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents options for linting in the zthunworks janitor system.</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZJanitorOptionsLint</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#esconfig">esConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#esfiles">esFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlconfig">htmlConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlfiles">htmlFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlfilesexclude">htmlFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsonfiles">jsonFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsonfilesexclude">jsonFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownconfig">markdownConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownfiles">markdownFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownfilesexclude">markdownFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyconfig">prettyConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyfiles">prettyFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyfilesexclude">prettyFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingconfig">spellingConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingfiles">spellingFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingfilesexclude">spellingFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#styleconfig">styleConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stylefiles">styleFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stylefilesexclude">styleFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yamlfiles">yamlFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yamlfilesexclude">yamlFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZJanitorOptionsLint</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#esconfig">esConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#esfiles">esFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlconfig">htmlConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlfiles">htmlFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#htmlfilesexclude">htmlFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsonfiles">jsonFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsonfilesexclude">jsonFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownconfig">markdownConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownfiles">markdownFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#markdownfilesexclude">markdownFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyconfig">prettyConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyfiles">prettyFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prettyfilesexclude">prettyFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingconfig">spellingConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingfiles">spellingFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#spellingfilesexclude">spellingFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#styleconfig">styleConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stylefiles">styleFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stylefilesexclude">styleFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yamlfiles">yamlFiles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yamlfilesexclude">yamlFilesExclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L4">janitor-options-lint.mts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#esconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Config?</span></a>
|
|
3
3
|
<a href="#esfiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Files?</span></a>
|
|
4
4
|
<a href="#htmlconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Config?</span></a>
|
|
5
5
|
<a href="#htmlfiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files?</span></a>
|
|
@@ -21,24 +21,24 @@
|
|
|
21
21
|
<a href="#yamlfiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files?</span></a>
|
|
22
22
|
<a href="#yamlfilesexclude" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files<wbr/>Exclude?</span></a>
|
|
23
23
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><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>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="esconfig"><code class="tsd-tag">Optional</code><span>es<wbr/>Config</span><a href="#esconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">esConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for eslint.</p>
|
|
24
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
25
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
26
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
27
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
28
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
29
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
30
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
31
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
32
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
33
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
34
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
35
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
36
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
37
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
38
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
39
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
40
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
41
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
42
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
43
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
44
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
24
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L8">janitor-options-lint.mts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="esfiles"><code class="tsd-tag">Optional</code><span>es<wbr/>Files</span><a href="#esfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">esFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with eslint.</p>
|
|
25
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L33">janitor-options-lint.mts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="htmlconfig"><code class="tsd-tag">Optional</code><span>html<wbr/>Config</span><a href="#htmlconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">htmlConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for htmlhint.</p>
|
|
26
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L12">janitor-options-lint.mts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="htmlfiles"><code class="tsd-tag">Optional</code><span>html<wbr/>Files</span><a href="#htmlfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">htmlFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with htmlhint.</p>
|
|
27
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L37">janitor-options-lint.mts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="htmlfilesexclude"><code class="tsd-tag">Optional</code><span>html<wbr/>Files<wbr/>Exclude</span><a href="#htmlfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">htmlFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with htmlhint.</p>
|
|
28
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L66">janitor-options-lint.mts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="jsonfiles"><code class="tsd-tag">Optional</code><span>json<wbr/>Files</span><a href="#jsonfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">jsonFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with json.</p>
|
|
29
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L41">janitor-options-lint.mts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="jsonfilesexclude"><code class="tsd-tag">Optional</code><span>json<wbr/>Files<wbr/>Exclude</span><a href="#jsonfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">jsonFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with json.</p>
|
|
30
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L70">janitor-options-lint.mts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="markdownconfig"><code class="tsd-tag">Optional</code><span>markdown<wbr/>Config</span><a href="#markdownconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">markdownConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for markdownlint.</p>
|
|
31
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L16">janitor-options-lint.mts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="markdownfiles"><code class="tsd-tag">Optional</code><span>markdown<wbr/>Files</span><a href="#markdownfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">markdownFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with markdownlint.</p>
|
|
32
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L45">janitor-options-lint.mts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="markdownfilesexclude"><code class="tsd-tag">Optional</code><span>markdown<wbr/>Files<wbr/>Exclude</span><a href="#markdownfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">markdownFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with markdownlint.</p>
|
|
33
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L74">janitor-options-lint.mts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prettyconfig"><code class="tsd-tag">Optional</code><span>pretty<wbr/>Config</span><a href="#prettyconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">prettyConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for prettier.</p>
|
|
34
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L20">janitor-options-lint.mts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prettyfiles"><code class="tsd-tag">Optional</code><span>pretty<wbr/>Files</span><a href="#prettyfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">prettyFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with prettier.</p>
|
|
35
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L49">janitor-options-lint.mts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prettyfilesexclude"><code class="tsd-tag">Optional</code><span>pretty<wbr/>Files<wbr/>Exclude</span><a href="#prettyfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">prettyFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with prettier.</p>
|
|
36
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L78">janitor-options-lint.mts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spellingconfig"><code class="tsd-tag">Optional</code><span>spelling<wbr/>Config</span><a href="#spellingconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">spellingConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for cspell.</p>
|
|
37
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L24">janitor-options-lint.mts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spellingfiles"><code class="tsd-tag">Optional</code><span>spelling<wbr/>Files</span><a href="#spellingfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">spellingFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with cspell.</p>
|
|
38
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L53">janitor-options-lint.mts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spellingfilesexclude"><code class="tsd-tag">Optional</code><span>spelling<wbr/>Files<wbr/>Exclude</span><a href="#spellingfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">spellingFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with cspell.</p>
|
|
39
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L82">janitor-options-lint.mts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="styleconfig"><code class="tsd-tag">Optional</code><span>style<wbr/>Config</span><a href="#styleconfig" 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><div class="tsd-signature"><span class="tsd-kind-property">styleConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The path to the config file for stylelint.</p>
|
|
40
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L28">janitor-options-lint.mts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stylefiles"><code class="tsd-tag">Optional</code><span>style<wbr/>Files</span><a href="#stylefiles" 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><div class="tsd-signature"><span class="tsd-kind-property">styleFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with stylelint.</p>
|
|
41
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L57">janitor-options-lint.mts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stylefilesexclude"><code class="tsd-tag">Optional</code><span>style<wbr/>Files<wbr/>Exclude</span><a href="#stylefilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">styleFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files to exclude from linting with stylelint.</p>
|
|
42
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L86">janitor-options-lint.mts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="yamlfiles"><code class="tsd-tag">Optional</code><span>yaml<wbr/>Files</span><a href="#yamlfiles" 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><div class="tsd-signature"><span class="tsd-kind-property">yamlFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The file globs to lint with yaml.</p>
|
|
43
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L61">janitor-options-lint.mts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="yamlfilesexclude"><code class="tsd-tag">Optional</code><span>yaml<wbr/>Files<wbr/>Exclude</span><a href="#yamlfilesexclude" 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><div class="tsd-signature"><span class="tsd-kind-property">yamlFilesExclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The files globs to exclude from linting with yaml.</p>
|
|
44
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-options/src/options/janitor-options-lint.mts#L90">janitor-options-lint.mts:90</a></li></ul></aside></section></section></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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#esconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Config</span></a><a href="#esfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Files</span></a><a href="#htmlconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Config</span></a><a href="#htmlfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files</span></a><a href="#htmlfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files<wbr/>Exclude</span></a><a href="#jsonfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files</span></a><a href="#jsonfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files<wbr/>Exclude</span></a><a href="#markdownconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Config</span></a><a href="#markdownfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files</span></a><a href="#markdownfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files<wbr/>Exclude</span></a><a href="#prettyconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Config</span></a><a href="#prettyfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files</span></a><a href="#prettyfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files<wbr/>Exclude</span></a><a href="#spellingconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Config</span></a><a href="#spellingfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files</span></a><a href="#spellingfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files<wbr/>Exclude</span></a><a href="#styleconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Config</span></a><a href="#stylefiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Files</span></a><a href="#stylefilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Files<wbr/>Exclude</span></a><a href="#yamlfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files</span></a><a href="#yamlfilesexclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files<wbr/>Exclude</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</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>
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
Thanks for taking the time to contribute! Generally, the big secret of this
|
|
4
4
|
project is that it is mostly done as a hobby. There is no big intention to make
|
|
5
|
-
janitor the code cleanliness standard and anyone who uses it would just
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
janitor the code cleanliness standard and anyone who uses it would just have to
|
|
6
|
+
find it useful. It is not marketed or advertised; a good product should sell
|
|
7
|
+
itself. However, at the minimum, people would need to know about it, so unless
|
|
8
|
+
you are looking to make code contributions, the minimum contribution that ANYONE
|
|
9
|
+
can make is to let their friends know about a tool that they found helpful and
|
|
10
|
+
provided value.
|
|
11
11
|
|
|
12
12
|
However, if you are looking to make code contributions to this repository, then
|
|
13
13
|
this document should get you set up.
|
|
@@ -1,5 +1,5 @@
|
|
|
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/janitor-build-config | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-build-config</a></li></ul><h1>Module @zthun/janitor-build-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="janitor-build-config" class="tsd-anchor-link">Janitor Build Config<a href="#janitor-build-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 set of common configurations for vite and vitest to simplify
|
|
2
|
-
|
|
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/janitor-build-config | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-build-config</a></li></ul><h1>Module @zthun/janitor-build-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="janitor-build-config" class="tsd-anchor-link">Janitor Build Config<a href="#janitor-build-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 set of common configurations for vite and vitest to simplify build
|
|
2
|
+
configuration files.</p>
|
|
3
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/janitor-build-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/janitor-build-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
4
4
|
</code><button type="button">Copy</button></pre>
|
|
5
5
|
|
|
@@ -1,24 +1,24 @@
|
|
|
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/janitor-lint | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-lint</a></li></ul><h1>Module @zthun/janitor-lint</h1></div><section class="tsd-panel tsd-typography"><h1 id="janitor-lint" class="tsd-anchor-link">Janitor Lint<a href="#janitor-lint" 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. Most places you work will have a long backlog of tech-debt
|
|
2
|
-
that never quite get addressed, and over time this becomes a maintenance
|
|
3
|
-
Fixing old problems is expensive, and companies tend to focus on
|
|
4
|
-
which means these issues often stay unresolved. New features
|
|
5
|
-
messy foundations, and the software slowly begins to rot.</p>
|
|
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/janitor-lint | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-lint</a></li></ul><h1>Module @zthun/janitor-lint</h1></div><section class="tsd-panel tsd-typography"><h1 id="janitor-lint" class="tsd-anchor-link">Janitor Lint<a href="#janitor-lint" 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. Most places you work will have a long backlog of tech-debt
|
|
2
|
+
tasks that never quite get addressed, and over time this becomes a maintenance
|
|
3
|
+
nightmare. Fixing old problems is expensive, and companies tend to focus on
|
|
4
|
+
short-term ROI — which means these issues often stay unresolved. New features
|
|
5
|
+
get built on top of messy foundations, and the software slowly begins to rot.</p>
|
|
6
6
|
<p>A common way to fight this is to start with linters. Linters scan your codebase
|
|
7
|
-
and notify you of issues. In a healthy development pipeline, they prevent
|
|
8
|
-
from creating a metaphorical messy room and encourage clean,
|
|
9
|
-
the team. They’re not a silver bullet — messy solutions
|
|
10
|
-
linters eliminate most inconsistent patterns and
|
|
11
|
-
love them because they keep everyone aligned.</p>
|
|
7
|
+
and notify you of issues. In a healthy development pipeline, they prevent
|
|
8
|
+
developers from creating a metaphorical messy room and encourage clean,
|
|
9
|
+
consistent code across the team. They’re not a silver bullet — messy solutions
|
|
10
|
+
can still appear — but linters eliminate most inconsistent patterns and
|
|
11
|
+
formatting errors. Good developers love them because they keep everyone aligned.</p>
|
|
12
12
|
<p>However, linters come with their own problems. There are so many of them. Each
|
|
13
13
|
has its own configuration style, quirks, and ecosystem. To cover your full
|
|
14
|
-
codebase, you often need multiple tools: ones for code quality, formatting,
|
|
15
|
-
applications, and more. It’s easy to feel overwhelmed, and maintaining
|
|
16
|
-
linters becomes its own form of tech debt.</p>
|
|
14
|
+
codebase, you often need multiple tools: ones for code quality, formatting,
|
|
15
|
+
spelling, applications, and more. It’s easy to feel overwhelmed, and maintaining
|
|
16
|
+
a stack of linters becomes its own form of tech debt.</p>
|
|
17
17
|
<p>Janitor Lint was created with the belief that there is beauty in simplicity. A
|
|
18
|
-
single tool that handles your linting needs is far better than stitching
|
|
19
|
-
a pile of utilities, each with its own configuration and upkeep. Let
|
|
20
|
-
Lint take on the heavy lifting so you can keep your codebase clean — and
|
|
21
|
-
developers happy.</p>
|
|
18
|
+
single tool that handles your linting needs is far better than stitching
|
|
19
|
+
together a pile of utilities, each with its own configuration and upkeep. Let
|
|
20
|
+
Janitor Lint take on the heavy lifting so you can keep your codebase clean — and
|
|
21
|
+
your developers happy.</p>
|
|
22
22
|
<h2 id="install" class="tsd-anchor-link">Install<a href="#install" 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-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-4">-D</span><span class="hl-2"> </span><span class="hl-3">@zthun/janitor-lint</span><br/><span class="hl-0"># Optionally pull in the shared rules</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-4">-D</span><span class="hl-2"> </span><span class="hl-3">@zthun/janitor-lint-config</span>
|
|
23
23
|
</code><button type="button">Copy</button></pre>
|
|
24
24
|
|
|
@@ -26,15 +26,15 @@ developers happy.</p>
|
|
|
26
26
|
</code><button type="button">Copy</button></pre>
|
|
27
27
|
|
|
28
28
|
<ul>
|
|
29
|
-
<li><code>--config</code> is optional. Without it, the CLI searches for a <code>janitor</code>
|
|
30
|
-
|
|
29
|
+
<li><code>--config</code> is optional. Without it, the CLI searches for a <code>janitor</code> config
|
|
30
|
+
using cosmiconfig (in order: <code>package.json#janitor</code>, <code>janitorrc</code>,
|
|
31
31
|
<code>janitorrc.json</code>, <code>janitorrc.yaml|yml</code>, <code>janitorrc.mjs</code>).</li>
|
|
32
32
|
<li>Exit code is <code>0</code> when every enabled linter passes and <code>1</code> when any fail.</li>
|
|
33
33
|
</ul>
|
|
34
|
-
<h2 id="configuration-shape" class="tsd-anchor-link">Configuration shape<a href="#configuration-shape" 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>Janitor Lint reads a <code>janitor</code> options config object with a <code>lint</code> section.
|
|
35
|
-
field is optional—only the linters you configure will run. You can
|
|
36
|
-
manually, OR you can use the package, @zthun/janitor-options, to
|
|
37
|
-
configuration.</p>
|
|
34
|
+
<h2 id="configuration-shape" class="tsd-anchor-link">Configuration shape<a href="#configuration-shape" 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>Janitor Lint reads a <code>janitor</code> options config object with a <code>lint</code> section.
|
|
35
|
+
Every field is optional—only the linters you configure will run. You can
|
|
36
|
+
configure this manually, OR you can use the package, @zthun/janitor-options, to
|
|
37
|
+
just build a configuration.</p>
|
|
38
38
|
<pre><code class="ts"><span class="hl-0">/**</span><br/><span class="hl-0"> * Represents options for linting in the zthunworks janitor system.</span><br/><span class="hl-0"> */</span><br/><span class="hl-5">export</span><span class="hl-2"> </span><span class="hl-4">interface</span><span class="hl-2"> </span><span class="hl-9">IZJanitorOptionsLint</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for eslint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">esConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for htmlhint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">htmlConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for markdownlint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">markdownConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for prettier.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">prettyConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for cspell.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">spellingConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The path to the config file for stylelint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">styleConfig</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with eslint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">esFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with htmlhint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">htmlFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with json.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">jsonFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with markdownlint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with prettier.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">prettyFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with cspell.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">spellingFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with stylelint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">styleFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The file globs to lint with yaml.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">yamlFiles</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with htmlhint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">htmlFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with json.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">jsonFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with markdownlint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">markdownFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with prettier.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">prettyFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with cspell.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">spellingFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files to exclude from linting with stylelint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">styleFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * The files globs to exclude from linting with yaml.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">yamlFilesExclude</span><span class="hl-2">?: </span><span class="hl-9">string</span><span class="hl-2">[];</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">/**</span><br/><span class="hl-0"> * Options for the zthunworks janitor system.</span><br/><span class="hl-0"> */</span><br/><span class="hl-5">export</span><span class="hl-2"> </span><span class="hl-4">interface</span><span class="hl-2"> </span><span class="hl-9">IZJanitorOptions</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-0">/**</span><br/><span class="hl-0"> * Linting options for janitor-lint.</span><br/><span class="hl-0"> */</span><br/><span class="hl-2"> </span><span class="hl-6">lint</span><span class="hl-2">?: </span><span class="hl-9">IZJanitorOptionsLint</span><span class="hl-2">;</span><br/><span class="hl-2">}</span>
|
|
39
39
|
</code><button type="button">Copy</button></pre>
|
|
40
40
|
|
|
@@ -1,14 +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/janitor-ts-config | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-ts-config</a></li></ul><h1>Module @zthun/janitor-ts-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="description" class="tsd-anchor-link">Description<a href="#description" 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 package contains shared tsconfig presets used across @zthun scoped
|
|
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/janitor-ts-config | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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/janitor-ts-config</a></li></ul><h1>Module @zthun/janitor-ts-config</h1></div><section class="tsd-panel tsd-typography"><h1 id="description" class="tsd-anchor-link">Description<a href="#description" 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 package contains shared tsconfig presets used across @zthun scoped
|
|
2
|
+
projects.</p>
|
|
2
3
|
<p>The configs are composable: start with <code>base.json</code> and layer on the
|
|
3
4
|
environment-specific presets you need.</p>
|
|
4
5
|
<h2 id="install" class="tsd-anchor-link">Install<a href="#install" 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">i</span><span class="hl-2"> </span><span class="hl-3">@zthun/janitor-ts-config</span><span class="hl-2"> </span><span class="hl-3">typescript</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><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/janitor-ts-config</span><span class="hl-2"> </span><span class="hl-3">typescript</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
5
6
|
</code><button type="button">Copy</button></pre>
|
|
6
7
|
|
|
7
8
|
<h2 id="available-presets" class="tsd-anchor-link">Available presets<a href="#available-presets" 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><ul>
|
|
8
|
-
<li><code>base.json</code> — strict defaults aimed as the root for all possible
|
|
9
|
+
<li><code>base.json</code> — strict defaults aimed as the root for all possible
|
|
10
|
+
configurations</li>
|
|
9
11
|
<li><code>node.json</code> — for node based projects.</li>
|
|
10
12
|
<li><code>browser.json</code> — for browser based projects.</li>
|
|
11
|
-
<li><code>react.json</code> — for projects that are browser based and use react as the
|
|
13
|
+
<li><code>react.json</code> — for projects that are browser based and use react as the
|
|
14
|
+
framework</li>
|
|
12
15
|
<li><code>nest-js.json</code> — for node based projects that use nest-js as a framework.</li>
|
|
13
16
|
</ul>
|
|
14
17
|
<h2 id="usage-examples" class="tsd-anchor-link">Usage examples<a href="#usage-examples" 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="node-based-libraries-clis-and-services" class="tsd-anchor-link">Node Based - Libraries, CLIs, and Services<a href="#node-based-libraries-clis-and-services" 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><pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-8">"extends"</span><span class="hl-2">: [</span><br/><span class="hl-2"> </span><span class="hl-3">"@zthun/janitor-ts-config/base.json"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-3">"@zthun/janitor-ts-config/node.json"</span><br/><span class="hl-2"> ],</span><br/><span class="hl-2"> </span><span class="hl-8">"compilerOptions"</span><span class="hl-2">: {</span><br/><span class="hl-2"> </span><span class="hl-8">"baseUrl"</span><span class="hl-2">: </span><span class="hl-3">"."</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-8">"include"</span><span class="hl-2">: [</span><span class="hl-3">"src/**/*.ts"</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
|
|
@@ -1 +1 @@
|
|
|
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>environments | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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="../modules/_zthun_janitor-eslint-config.html">@zthun/janitor-eslint-config</a></li><li><a href="" aria-current="page">environments</a></li></ul><h1>Variable environments<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">environments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">browser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="browser"><span class="tsd-kind-property">browser</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5 id="node"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
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>environments | Documentation</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Documentation"/><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">Documentation</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="../modules/_zthun_janitor-eslint-config.html">@zthun/janitor-eslint-config</a></li><li><a href="" aria-current="page">environments</a></li></ul><h1>Variable environments<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">environments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">browser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="browser"><span class="tsd-kind-property">browser</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5 id="node"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Config</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RulesConfig</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/cffa724b2b74a0fc5b85f657a480b02ad2b7f5ae/packages/janitor-eslint-config/src/configs/environments.mts#L14">environments.mts:14</a></li></ul></aside></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</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>
|