@zthun/janitor-web 16.1.2 → 17.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +14 -10
- package/dist/classes/_zthun_lint_janitor.ZConfigExtender.html +5 -5
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderCosmic.html +7 -7
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderNull.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderPrettier.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZContentLinterHtml.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZContentLinterJson.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZContentLinterPretty.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZContentLinterYaml.html +2 -2
- package/dist/classes/_zthun_lint_janitor.ZFileReportLint.html +3 -3
- package/dist/classes/_zthun_lint_janitor.ZLintJanitor.html +13 -13
- package/dist/classes/_zthun_lint_janitor.ZLinterEs.html +4 -4
- package/dist/classes/_zthun_lint_janitor.ZLinterFile.html +3 -3
- package/dist/classes/_zthun_lint_janitor.ZLinterMarkdown.html +3 -3
- package/dist/classes/_zthun_lint_janitor.ZLinterSilent.html +3 -3
- package/dist/classes/_zthun_lint_janitor.ZLinterSpelling.html +3 -3
- package/dist/classes/_zthun_lint_janitor.ZLinterStyle.html +3 -3
- package/dist/index.html +14 -10
- package/dist/interfaces/_zthun_lint_janitor.IZConfigDiscovery.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZConfigExtender.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZConfigReader.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZContentLinter.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorArgs.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorOptions.html +2 -2
- package/dist/interfaces/_zthun_lint_janitor.IZLinter.html +2 -2
- package/dist/media/CODE_OF_CONDUCT.md +70 -44
- package/dist/media/CONTRIBUTING.md +33 -23
- package/dist/media/LICENSE.md +14 -10
- package/dist/modules/_zthun_eslint_config.html +4 -2
- package/dist/modules/_zthun_htmlhint_config.html +5 -3
- package/dist/modules/_zthun_lint_janitor.html +177 -121
- package/dist/modules/_zthun_lint_janitor_config.html +2 -1
- package/dist/modules/_zthun_markdownlint_config.html +4 -3
- package/dist/modules/_zthun_prettier_config.html +1 -1
- package/dist/modules/_zthun_stylelint_config_less.html +2 -1
- package/dist/modules/_zthun_stylelint_config_sass.html +2 -1
- package/package.json +4 -4
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZLintJanitorOptions | Janitor</title><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../janitor.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Janitor</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Janitor</a></li><li><a href="../modules/_zthun_lint_janitor.html">@zthun/lint-janitor</a></li><li><a href="_zthun_lint_janitor.IZLintJanitorOptions.html">IZLintJanitorOptions</a></li></ul><h1>Interface IZLintJanitorOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZLintJanitorOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#esConfig">esConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#htmlConfig">htmlConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#markdownConfig">markdownConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#prettyConfig">prettyConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#spellingConfig">spellingConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#styleConfig">styleConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Janitor</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Janitor</a></li><li><a href="../modules/_zthun_lint_janitor.html">@zthun/lint-janitor</a></li><li><a href="_zthun_lint_janitor.IZLintJanitorOptions.html">IZLintJanitorOptions</a></li></ul><h1>Interface IZLintJanitorOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZLintJanitorOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#esConfig">esConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#htmlConfig">htmlConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#markdownConfig">markdownConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#prettyConfig">prettyConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#spellingConfig">spellingConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#styleConfig">styleConfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/><span> </span><a class="tsd-kind-property" href="_zthun_lint_janitor.IZLintJanitorOptions.html#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/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L1">lint-janitor/lint-janitor-options.mts:1</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> 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="_zthun_lint_janitor.IZLintJanitorOptions.html#esConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Config?</span></a>
|
|
3
3
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#esFiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Files?</span></a>
|
|
4
4
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#htmlConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Config?</span></a>
|
|
5
5
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#htmlFiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files?</span></a>
|
|
@@ -19,4 +19,4 @@
|
|
|
19
19
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#styleFiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Files?</span></a>
|
|
20
20
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#yamlFiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files?</span></a>
|
|
21
21
|
<a href="_zthun_lint_janitor.IZLintJanitorOptions.html#yamlFilesExclude" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files<wbr/>Exclude?</span></a>
|
|
22
|
-
</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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="esConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">es<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L2">lint-janitor/lint-janitor-options.mts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="esFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">es<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L9">lint-janitor/lint-janitor-options.mts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L4">lint-janitor/lint-janitor-options.mts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L11">lint-janitor/lint-janitor-options.mts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L12">lint-janitor/lint-janitor-options.mts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jsonFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">json<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L15">lint-janitor/lint-janitor-options.mts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jsonFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">json<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L16">lint-janitor/lint-janitor-options.mts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L5">lint-janitor/lint-janitor-options.mts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L13">lint-janitor/lint-janitor-options.mts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L14">lint-janitor/lint-janitor-options.mts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L7">lint-janitor/lint-janitor-options.mts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L21">lint-janitor/lint-janitor-options.mts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L22">lint-janitor/lint-janitor-options.mts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L6">lint-janitor/lint-janitor-options.mts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L19">lint-janitor/lint-janitor-options.mts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L20">lint-janitor/lint-janitor-options.mts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="styleConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">style<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L3">lint-janitor/lint-janitor-options.mts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="styleFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">style<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L10">lint-janitor/lint-janitor-options.mts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="yamlFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">yaml<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L17">lint-janitor/lint-janitor-options.mts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="yamlFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">yaml<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/1e0e9f3508ed1a89bbeea1bd5835ea75ae111832/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L18">lint-janitor/lint-janitor-options.mts:18</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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#esConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Config</span></a><a href="#esFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Files</span></a><a href="#htmlConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Config</span></a><a href="#htmlFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files</span></a><a href="#htmlFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files<wbr/>Exclude</span></a><a href="#jsonFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files</span></a><a href="#jsonFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files<wbr/>Exclude</span></a><a href="#markdownConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Config</span></a><a href="#markdownFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files</span></a><a href="#markdownFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files<wbr/>Exclude</span></a><a href="#prettyConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Config</span></a><a href="#prettyFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files</span></a><a href="#prettyFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files<wbr/>Exclude</span></a><a href="#spellingConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Config</span></a><a href="#spellingFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files</span></a><a href="#spellingFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files<wbr/>Exclude</span></a><a href="#styleConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Config</span></a><a href="#styleFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Files</span></a><a href="#yamlFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files</span></a><a href="#yamlFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Janitor</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
22
|
+
</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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="esConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">es<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L2">lint-janitor/lint-janitor-options.mts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="esFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">es<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L9">lint-janitor/lint-janitor-options.mts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L4">lint-janitor/lint-janitor-options.mts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L11">lint-janitor/lint-janitor-options.mts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="htmlFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">html<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L12">lint-janitor/lint-janitor-options.mts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jsonFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">json<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L15">lint-janitor/lint-janitor-options.mts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jsonFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">json<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L16">lint-janitor/lint-janitor-options.mts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L5">lint-janitor/lint-janitor-options.mts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L13">lint-janitor/lint-janitor-options.mts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markdownFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markdown<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L14">lint-janitor/lint-janitor-options.mts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L7">lint-janitor/lint-janitor-options.mts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L21">lint-janitor/lint-janitor-options.mts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prettyFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pretty<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L22">lint-janitor/lint-janitor-options.mts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L6">lint-janitor/lint-janitor-options.mts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L19">lint-janitor/lint-janitor-options.mts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spellingFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spelling<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L20">lint-janitor/lint-janitor-options.mts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="styleConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">style<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L3">lint-janitor/lint-janitor-options.mts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="styleFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">style<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L10">lint-janitor/lint-janitor-options.mts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="yamlFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">yaml<wbr/>Files</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L17">lint-janitor/lint-janitor-options.mts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="yamlFilesExclude" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">yaml<wbr/>Files<wbr/>Exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/lint-janitor/lint-janitor-options.mts#L18">lint-janitor/lint-janitor-options.mts:18</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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#esConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Config</span></a><a href="#esFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>es<wbr/>Files</span></a><a href="#htmlConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Config</span></a><a href="#htmlFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files</span></a><a href="#htmlFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>html<wbr/>Files<wbr/>Exclude</span></a><a href="#jsonFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files</span></a><a href="#jsonFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json<wbr/>Files<wbr/>Exclude</span></a><a href="#markdownConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Config</span></a><a href="#markdownFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files</span></a><a href="#markdownFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markdown<wbr/>Files<wbr/>Exclude</span></a><a href="#prettyConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Config</span></a><a href="#prettyFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files</span></a><a href="#prettyFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pretty<wbr/>Files<wbr/>Exclude</span></a><a href="#spellingConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Config</span></a><a href="#spellingFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files</span></a><a href="#spellingFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spelling<wbr/>Files<wbr/>Exclude</span></a><a href="#styleConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Config</span></a><a href="#styleFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style<wbr/>Files</span></a><a href="#yamlFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yaml<wbr/>Files</span></a><a href="#yamlFilesExclude" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Janitor</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZLinter | Janitor</title><meta name="description" content="Documentation for Janitor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../janitor.svg" />
|
|
2
2
|
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Janitor</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Janitor</a></li><li><a href="../modules/_zthun_lint_janitor.html">@zthun/lint-janitor</a></li><li><a href="_zthun_lint_janitor.IZLinter.html">IZLinter</a></li></ul><h1>Interface IZLinter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object that can lint glob patterns of files.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZLinter</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="_zthun_lint_janitor.IZLinter.html#lint.lint-1">lint</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">exclude</span><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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_lint_janitor.ZFileReportLint.html" class="tsd-signature-type tsd-kind-class">ZFileReportLint</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterEs.html" class="tsd-signature-type tsd-kind-class">ZLinterEs</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterFile.html" class="tsd-signature-type tsd-kind-class">ZLinterFile</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterMarkdown.html" class="tsd-signature-type tsd-kind-class">ZLinterMarkdown</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterSilent.html" class="tsd-signature-type tsd-kind-class">ZLinterSilent</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterSpelling.html" class="tsd-signature-type tsd-kind-class">ZLinterSpelling</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterStyle.html" class="tsd-signature-type tsd-kind-class">ZLinterStyle</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZLinter</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="_zthun_lint_janitor.IZLinter.html#lint.lint-1">lint</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">exclude</span><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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_lint_janitor.ZFileReportLint.html" class="tsd-signature-type tsd-kind-class">ZFileReportLint</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterEs.html" class="tsd-signature-type tsd-kind-class">ZLinterEs</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterFile.html" class="tsd-signature-type tsd-kind-class">ZLinterFile</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterMarkdown.html" class="tsd-signature-type tsd-kind-class">ZLinterMarkdown</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterSilent.html" class="tsd-signature-type tsd-kind-class">ZLinterSilent</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterSpelling.html" class="tsd-signature-type tsd-kind-class">ZLinterSpelling</a></li><li><a href="../classes/_zthun_lint_janitor.ZLinterStyle.html" class="tsd-signature-type tsd-kind-class">ZLinterStyle</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/linter/linter.mts#L4">linter/linter.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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.IZLinter.html#lint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>lint</span></a>
|
|
4
4
|
</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-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="lint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lint</span><a href="#lint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="lint.lint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">lint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">exclude</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#lint.lint-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lints all files matched by the specified glob pattern.</p>
|
|
5
5
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The glob patterns to match and lint.</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The optional config for the linter.</p>
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves to true if the
|
|
9
9
|
linting is ok, and false if the linting
|
|
10
10
|
fails.</p>
|
|
11
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
11
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/0ad35a67068dd6d625ff87294e48a7ecc8b0abf7/packages/lint-janitor/src/linter/linter.mts#L20">linter/linter.mts:20</a></li></ul></aside></li></ul></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#lint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>lint</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Janitor</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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,95 +2,120 @@
|
|
|
2
2
|
|
|
3
3
|
## Our Pledge
|
|
4
4
|
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
-
everyone, regardless of age, body
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socioeconomic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
|
10
|
+
orientation.
|
|
9
11
|
|
|
10
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
11
14
|
|
|
12
15
|
## Our Standards
|
|
13
16
|
|
|
14
|
-
Examples of behavior that contributes to a positive environment for our
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
15
19
|
|
|
16
20
|
- Demonstrating empathy and kindness toward other people
|
|
17
21
|
- Being respectful of differing opinions, viewpoints, and experiences
|
|
18
22
|
- Giving and gracefully accepting constructive feedback
|
|
19
|
-
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
20
|
-
|
|
23
|
+
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
- Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
21
27
|
|
|
22
28
|
Examples of unacceptable behavior include:
|
|
23
29
|
|
|
24
|
-
- The use of sexualized language or imagery, and sexual attention or advances of
|
|
30
|
+
- The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
25
32
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
26
33
|
- Public or private harassment
|
|
27
|
-
- Publishing others' private information, such as a physical or email address,
|
|
28
|
-
|
|
34
|
+
- Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
29
38
|
|
|
30
39
|
## Enforcement Responsibilities
|
|
31
40
|
|
|
32
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
33
|
-
appropriate and fair corrective action in
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
34
44
|
or harmful.
|
|
35
45
|
|
|
36
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
37
|
-
|
|
38
|
-
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
39
50
|
|
|
40
51
|
## Scope
|
|
41
52
|
|
|
42
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
43
|
-
|
|
44
|
-
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
45
58
|
|
|
46
59
|
## Enforcement
|
|
47
60
|
|
|
48
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
49
|
-
|
|
50
|
-
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
[admin@zthunworks.com](admin@zthunworks.com). All complaints will be reviewed
|
|
64
|
+
and investigated promptly and fairly.
|
|
51
65
|
|
|
52
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
53
68
|
|
|
54
69
|
## Enforcement Guidelines
|
|
55
70
|
|
|
56
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
57
|
-
in violation of this Code of Conduct:
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
58
73
|
|
|
59
74
|
### 1. Correction
|
|
60
75
|
|
|
61
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
62
|
-
community.
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
63
78
|
|
|
64
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
65
|
-
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
66
82
|
|
|
67
83
|
### 2. Warning
|
|
68
84
|
|
|
69
|
-
**Community Impact**: A violation through a single incident or series of
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
70
87
|
|
|
71
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
75
94
|
|
|
76
95
|
### 3. Temporary Ban
|
|
77
96
|
|
|
78
|
-
**Community Impact**: A serious violation of community standards, including
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
79
99
|
|
|
80
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
81
|
-
period of time. No public or
|
|
82
|
-
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
83
105
|
|
|
84
106
|
### 4. Permanent Ban
|
|
85
107
|
|
|
86
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
87
|
-
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
88
111
|
|
|
89
|
-
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
90
114
|
|
|
91
115
|
## Attribution
|
|
92
116
|
|
|
93
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
94
119
|
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html].
|
|
95
120
|
|
|
96
121
|
Community Impact Guidelines were inspired by
|
|
@@ -98,5 +123,6 @@ Community Impact Guidelines were inspired by
|
|
|
98
123
|
|
|
99
124
|
[homepage]: [https://www.contributor-covenant.org]
|
|
100
125
|
|
|
101
|
-
For answers to common questions about this code of conduct, see the FAQ at
|
|
102
|
-
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
[https://www.contributor-covenant.org/faq]. Translations are available at
|
|
128
|
+
[https://www.contributor-covenant.org/translations].
|
|
@@ -1,27 +1,33 @@
|
|
|
1
1
|
# Contributing
|
|
2
2
|
|
|
3
|
-
Thanks for taking the time to contribute! Generally, the big secret of this
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
Thanks for taking the time to contribute! Generally, the big secret of this
|
|
4
|
+
project is that it is mostly done as a hobby. There is no big intention to make
|
|
5
|
+
lint janitor the code cleanliness standard and anyone who uses it would just
|
|
6
|
+
have to find it useful. It is not marketed or advertised; a good product should
|
|
7
|
+
sell itself. However, at the minimum, people would need to know about it, so
|
|
8
|
+
unless you are looking to make code contributions, the minimum contribution that
|
|
9
|
+
ANYONE can make is to let their friends know about a tool that they found
|
|
10
|
+
helpful and provided value.
|
|
11
|
+
|
|
12
|
+
However, if you are looking to make code contributions to this repository, then
|
|
13
|
+
this document should get you set up.
|
|
10
14
|
|
|
11
15
|
## Deployment
|
|
12
16
|
|
|
13
|
-
The point of this repository is to deploy out NPM packages. Everything here is
|
|
14
|
-
[NPM](https://npmjs.org) repository.
|
|
17
|
+
The point of this repository is to deploy out NPM packages. Everything here is
|
|
18
|
+
deployed to the public [NPM](https://npmjs.org) repository.
|
|
15
19
|
|
|
16
|
-
The intention of this is to use these packages locally so other users will be
|
|
17
|
-
to their own repositories.
|
|
20
|
+
The intention of this is to use these packages locally so other users will be
|
|
21
|
+
doing npm installs of individual packages to their own repositories.
|
|
18
22
|
|
|
19
23
|
## Environment
|
|
20
24
|
|
|
21
|
-
In order to build the janitor repo, you are going to need
|
|
22
|
-
[Yarn](https://classic.yarnpkg.com/lang/en/),
|
|
23
|
-
|
|
24
|
-
|
|
25
|
+
In order to build the janitor repo, you are going to need
|
|
26
|
+
[Node](https://nodejs.org/en/), [Yarn](https://classic.yarnpkg.com/lang/en/),
|
|
27
|
+
and an IDE of your choice. We generally recommend
|
|
28
|
+
[VisualStudio Code](https://code.visualstudio.com/) as that one has the most
|
|
29
|
+
plugins and support to do everything you will need. There are a couple of
|
|
30
|
+
extensions that are highly recommended to install.
|
|
25
31
|
|
|
26
32
|
- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
|
|
27
33
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
@@ -40,9 +46,10 @@ yarn install
|
|
|
40
46
|
yarn make
|
|
41
47
|
```
|
|
42
48
|
|
|
43
|
-
If you want to step into the debugger for the lint janitor, this repository
|
|
44
|
-
launch.json configurations to start debugging.
|
|
45
|
-
|
|
49
|
+
If you want to step into the debugger for the lint janitor, this repository
|
|
50
|
+
comes with the appropriate vscode launch.json configurations to start debugging.
|
|
51
|
+
Simply hit the run button under Launch Lint Janitor, set your breakpoints and
|
|
52
|
+
away you go.
|
|
46
53
|
|
|
47
54
|
## Test
|
|
48
55
|
|
|
@@ -56,11 +63,14 @@ yarn test
|
|
|
56
63
|
|
|
57
64
|
## Versioning
|
|
58
65
|
|
|
59
|
-
This repository uses conventional commits to determine the next version to
|
|
60
|
-
|
|
66
|
+
This repository uses conventional commits to determine the next version to
|
|
67
|
+
publish. Make sure before you make any commits that you
|
|
68
|
+
[follow this standard](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
61
69
|
|
|
62
70
|
## Pull Request
|
|
63
71
|
|
|
64
|
-
Fork this repository, make any changes you need and then create a pull request
|
|
65
|
-
you'll want to change the git clone
|
|
66
|
-
|
|
72
|
+
Fork this repository, make any changes you need and then create a pull request
|
|
73
|
+
from your fork. From the above samples, you'll want to change the git clone
|
|
74
|
+
command to point to your local repository fork. See the
|
|
75
|
+
[pull request template](.github/pull_request_template.md) for more information
|
|
76
|
+
and checks to make.
|