@zthun/janitor-web 16.1.0 → 16.1.1
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 → LICENSE.md} +1 -1
- package/dist/assets/icons.js +17 -14
- package/dist/assets/icons.svg +1 -1
- package/dist/assets/main.js +5 -4
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +67 -31
- package/dist/classes/_zthun_lint_janitor.ZConfigExtender.html +7 -11
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderCosmic.html +15 -15
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderNull.html +4 -4
- package/dist/classes/_zthun_lint_janitor.ZConfigReaderPrettier.html +5 -5
- package/dist/classes/_zthun_lint_janitor.ZContentLinterHtml.html +5 -6
- package/dist/classes/_zthun_lint_janitor.ZContentLinterJson.html +4 -4
- package/dist/classes/_zthun_lint_janitor.ZContentLinterPretty.html +5 -5
- package/dist/classes/_zthun_lint_janitor.ZContentLinterYaml.html +4 -4
- package/dist/classes/_zthun_lint_janitor.ZFileReportLint.html +7 -13
- package/dist/classes/_zthun_lint_janitor.ZLintJanitor.html +19 -21
- package/dist/classes/_zthun_lint_janitor.ZLinterEs.html +10 -12
- package/dist/classes/_zthun_lint_janitor.ZLinterFile.html +8 -20
- package/dist/classes/_zthun_lint_janitor.ZLinterMarkdown.html +5 -9
- package/dist/classes/_zthun_lint_janitor.ZLinterSilent.html +5 -7
- package/dist/classes/_zthun_lint_janitor.ZLinterSpelling.html +9 -11
- package/dist/classes/_zthun_lint_janitor.ZLinterStyle.html +7 -9
- package/dist/hierarchy.html +2 -2
- package/dist/index.html +5 -5
- package/dist/interfaces/_zthun_lint_janitor.IZConfigDiscovery.html +5 -5
- package/dist/interfaces/_zthun_lint_janitor.IZConfigExtender.html +4 -4
- package/dist/interfaces/_zthun_lint_janitor.IZConfigReader.html +4 -4
- package/dist/interfaces/_zthun_lint_janitor.IZContentLinter.html +4 -4
- package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorArgs.html +4 -4
- package/dist/interfaces/_zthun_lint_janitor.IZLintJanitorOptions.html +3 -3
- package/dist/interfaces/_zthun_lint_janitor.IZLinter.html +8 -8
- package/dist/media/CODE_OF_CONDUCT.md +102 -0
- package/dist/media/CONTRIBUTING.md +66 -0
- package/dist/media/LICENSE.md +16 -0
- package/dist/modules/_zthun_eslint_config.html +11 -9
- package/dist/modules/_zthun_eslint_react_config.html +11 -9
- package/dist/modules/_zthun_htmlhint_config.html +12 -10
- package/dist/modules/_zthun_lint_janitor.html +75 -62
- package/dist/modules/_zthun_lint_janitor_config.html +6 -5
- package/dist/modules/_zthun_markdownlint_config.html +14 -11
- package/dist/modules/_zthun_prettier_config.html +11 -9
- package/dist/modules/_zthun_stylelint_config.html +11 -9
- package/dist/modules/_zthun_stylelint_config_less.html +11 -9
- package/dist/modules/_zthun_stylelint_config_sass.html +11 -9
- package/package.json +7 -7
package/dist/assets/style.css
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
--light-color-text: #222;
|
|
11
11
|
--light-color-text-aside: #6e6e6e;
|
|
12
12
|
--light-color-link: #1f70c2;
|
|
13
|
+
--light-color-focus-outline: #3584e4;
|
|
13
14
|
|
|
14
15
|
--light-color-ts-keyword: #056bd6;
|
|
15
16
|
--light-color-ts-project: #b111c9;
|
|
@@ -35,6 +36,7 @@
|
|
|
35
36
|
--light-color-ts-set-signature: var(--light-color-ts-accessor);
|
|
36
37
|
--light-color-ts-type-alias: #d51270;
|
|
37
38
|
/* reference not included as links will be colored with the kind that it points to */
|
|
39
|
+
--light-color-document: #000000;
|
|
38
40
|
|
|
39
41
|
--light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
|
|
40
42
|
--light-color-scheme: light;
|
|
@@ -50,6 +52,7 @@
|
|
|
50
52
|
--dark-color-text: #f5f5f5;
|
|
51
53
|
--dark-color-text-aside: #dddddd;
|
|
52
54
|
--dark-color-link: #00aff4;
|
|
55
|
+
--dark-color-focus-outline: #4c97f2;
|
|
53
56
|
|
|
54
57
|
--dark-color-ts-keyword: #3399ff;
|
|
55
58
|
--dark-color-ts-project: #e358ff;
|
|
@@ -75,6 +78,7 @@
|
|
|
75
78
|
--dark-color-ts-set-signature: var(--dark-color-ts-accessor);
|
|
76
79
|
--dark-color-ts-type-alias: #ff6492;
|
|
77
80
|
/* reference not included as links will be colored with the kind that it points to */
|
|
81
|
+
--dark-color-document: #ffffff;
|
|
78
82
|
|
|
79
83
|
--dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
|
|
80
84
|
--dark-color-scheme: dark;
|
|
@@ -92,6 +96,7 @@
|
|
|
92
96
|
--color-text: var(--light-color-text);
|
|
93
97
|
--color-text-aside: var(--light-color-text-aside);
|
|
94
98
|
--color-link: var(--light-color-link);
|
|
99
|
+
--color-focus-outline: var(--light-color-focus-outline);
|
|
95
100
|
|
|
96
101
|
--color-ts-keyword: var(--light-color-ts-keyword);
|
|
97
102
|
--color-ts-module: var(--light-color-ts-module);
|
|
@@ -116,6 +121,7 @@
|
|
|
116
121
|
--color-ts-get-signature: var(--light-color-ts-get-signature);
|
|
117
122
|
--color-ts-set-signature: var(--light-color-ts-set-signature);
|
|
118
123
|
--color-ts-type-alias: var(--light-color-ts-type-alias);
|
|
124
|
+
--color-document: var(--light-color-document);
|
|
119
125
|
|
|
120
126
|
--external-icon: var(--light-external-icon);
|
|
121
127
|
--color-scheme: var(--light-color-scheme);
|
|
@@ -134,6 +140,7 @@
|
|
|
134
140
|
--color-text: var(--dark-color-text);
|
|
135
141
|
--color-text-aside: var(--dark-color-text-aside);
|
|
136
142
|
--color-link: var(--dark-color-link);
|
|
143
|
+
--color-focus-outline: var(--dark-color-focus-outline);
|
|
137
144
|
|
|
138
145
|
--color-ts-keyword: var(--dark-color-ts-keyword);
|
|
139
146
|
--color-ts-module: var(--dark-color-ts-module);
|
|
@@ -158,6 +165,7 @@
|
|
|
158
165
|
--color-ts-get-signature: var(--dark-color-ts-get-signature);
|
|
159
166
|
--color-ts-set-signature: var(--dark-color-ts-set-signature);
|
|
160
167
|
--color-ts-type-alias: var(--dark-color-ts-type-alias);
|
|
168
|
+
--color-document: var(--dark-color-document);
|
|
161
169
|
|
|
162
170
|
--external-icon: var(--dark-external-icon);
|
|
163
171
|
--color-scheme: var(--dark-color-scheme);
|
|
@@ -183,6 +191,7 @@ body {
|
|
|
183
191
|
--color-text: var(--light-color-text);
|
|
184
192
|
--color-text-aside: var(--light-color-text-aside);
|
|
185
193
|
--color-link: var(--light-color-link);
|
|
194
|
+
--color-focus-outline: var(--light-color-focus-outline);
|
|
186
195
|
|
|
187
196
|
--color-ts-keyword: var(--light-color-ts-keyword);
|
|
188
197
|
--color-ts-module: var(--light-color-ts-module);
|
|
@@ -207,6 +216,7 @@ body {
|
|
|
207
216
|
--color-ts-get-signature: var(--light-color-ts-get-signature);
|
|
208
217
|
--color-ts-set-signature: var(--light-color-ts-set-signature);
|
|
209
218
|
--color-ts-type-alias: var(--light-color-ts-type-alias);
|
|
219
|
+
--color-document: var(--light-color-document);
|
|
210
220
|
|
|
211
221
|
--external-icon: var(--light-external-icon);
|
|
212
222
|
--color-scheme: var(--light-color-scheme);
|
|
@@ -223,6 +233,7 @@ body {
|
|
|
223
233
|
--color-text: var(--dark-color-text);
|
|
224
234
|
--color-text-aside: var(--dark-color-text-aside);
|
|
225
235
|
--color-link: var(--dark-color-link);
|
|
236
|
+
--color-focus-outline: var(--dark-color-focus-outline);
|
|
226
237
|
|
|
227
238
|
--color-ts-keyword: var(--dark-color-ts-keyword);
|
|
228
239
|
--color-ts-module: var(--dark-color-ts-module);
|
|
@@ -247,11 +258,17 @@ body {
|
|
|
247
258
|
--color-ts-get-signature: var(--dark-color-ts-get-signature);
|
|
248
259
|
--color-ts-set-signature: var(--dark-color-ts-set-signature);
|
|
249
260
|
--color-ts-type-alias: var(--dark-color-ts-type-alias);
|
|
261
|
+
--color-document: var(--dark-color-document);
|
|
250
262
|
|
|
251
263
|
--external-icon: var(--dark-external-icon);
|
|
252
264
|
--color-scheme: var(--dark-color-scheme);
|
|
253
265
|
}
|
|
254
266
|
|
|
267
|
+
*:focus-visible,
|
|
268
|
+
.tsd-accordion-summary:focus-visible svg {
|
|
269
|
+
outline: 2px solid var(--color-focus-outline);
|
|
270
|
+
}
|
|
271
|
+
|
|
255
272
|
.always-visible,
|
|
256
273
|
.always-visible .tsd-signatures {
|
|
257
274
|
display: inherit !important;
|
|
@@ -266,16 +283,6 @@ h6 {
|
|
|
266
283
|
line-height: 1.2;
|
|
267
284
|
}
|
|
268
285
|
|
|
269
|
-
h1 > a:not(.link),
|
|
270
|
-
h2 > a:not(.link),
|
|
271
|
-
h3 > a:not(.link),
|
|
272
|
-
h4 > a:not(.link),
|
|
273
|
-
h5 > a:not(.link),
|
|
274
|
-
h6 > a:not(.link) {
|
|
275
|
-
text-decoration: none;
|
|
276
|
-
color: var(--color-text);
|
|
277
|
-
}
|
|
278
|
-
|
|
279
286
|
h1 {
|
|
280
287
|
font-size: 1.875rem;
|
|
281
288
|
margin: 0.67rem 0;
|
|
@@ -306,10 +313,6 @@ h6 {
|
|
|
306
313
|
margin: 2.33rem 0;
|
|
307
314
|
}
|
|
308
315
|
|
|
309
|
-
.uppercase {
|
|
310
|
-
text-transform: uppercase;
|
|
311
|
-
}
|
|
312
|
-
|
|
313
316
|
dl,
|
|
314
317
|
menu,
|
|
315
318
|
ol,
|
|
@@ -333,7 +336,7 @@ footer {
|
|
|
333
336
|
padding-bottom: 1rem;
|
|
334
337
|
max-height: 3.5rem;
|
|
335
338
|
}
|
|
336
|
-
|
|
339
|
+
footer > p {
|
|
337
340
|
margin: 0 1em;
|
|
338
341
|
}
|
|
339
342
|
|
|
@@ -421,6 +424,9 @@ a.external[target="_blank"] {
|
|
|
421
424
|
background-repeat: no-repeat;
|
|
422
425
|
padding-right: 13px;
|
|
423
426
|
}
|
|
427
|
+
a.tsd-anchor-link {
|
|
428
|
+
color: var(--color-text);
|
|
429
|
+
}
|
|
424
430
|
|
|
425
431
|
code,
|
|
426
432
|
pre {
|
|
@@ -580,13 +586,13 @@ dl.tsd-comment-tag-group p {
|
|
|
580
586
|
}
|
|
581
587
|
.tsd-filter-input {
|
|
582
588
|
display: flex;
|
|
583
|
-
width: fit-content;
|
|
584
589
|
width: -moz-fit-content;
|
|
590
|
+
width: fit-content;
|
|
585
591
|
align-items: center;
|
|
586
|
-
user-select: none;
|
|
587
592
|
-webkit-user-select: none;
|
|
588
593
|
-moz-user-select: none;
|
|
589
594
|
-ms-user-select: none;
|
|
595
|
+
user-select: none;
|
|
590
596
|
cursor: pointer;
|
|
591
597
|
}
|
|
592
598
|
.tsd-filter-input input[type="checkbox"] {
|
|
@@ -609,11 +615,8 @@ dl.tsd-comment-tag-group p {
|
|
|
609
615
|
Don't remove unless you know what you're doing. */
|
|
610
616
|
opacity: 0.99;
|
|
611
617
|
}
|
|
612
|
-
.tsd-filter-input input[type="checkbox"]:focus + svg {
|
|
613
|
-
|
|
614
|
-
}
|
|
615
|
-
.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg {
|
|
616
|
-
transform: scale(1);
|
|
618
|
+
.tsd-filter-input input[type="checkbox"]:focus-visible + svg {
|
|
619
|
+
outline: 2px solid var(--color-focus-outline);
|
|
617
620
|
}
|
|
618
621
|
.tsd-checkbox-background {
|
|
619
622
|
fill: var(--color-accent);
|
|
@@ -630,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
|
|
|
630
633
|
stroke: var(--color-accent);
|
|
631
634
|
}
|
|
632
635
|
|
|
633
|
-
.
|
|
634
|
-
|
|
636
|
+
.settings-label {
|
|
637
|
+
font-weight: bold;
|
|
638
|
+
text-transform: uppercase;
|
|
639
|
+
display: inline-block;
|
|
635
640
|
}
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
641
|
+
|
|
642
|
+
.tsd-filter-visibility .settings-label {
|
|
643
|
+
margin: 0.75rem 0 0.5rem 0;
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
.tsd-theme-toggle .settings-label {
|
|
647
|
+
margin: 0.75rem 0.75rem 0 0;
|
|
640
648
|
}
|
|
641
649
|
|
|
642
650
|
.tsd-hierarchy {
|
|
@@ -769,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
|
|
|
769
777
|
padding: 0;
|
|
770
778
|
max-width: 100%;
|
|
771
779
|
}
|
|
780
|
+
.tsd-navigation .tsd-nav-link {
|
|
781
|
+
display: none;
|
|
782
|
+
}
|
|
772
783
|
.tsd-nested-navigation {
|
|
773
784
|
margin-left: 3rem;
|
|
774
785
|
}
|
|
@@ -782,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
|
|
|
782
793
|
margin-left: -1.5rem;
|
|
783
794
|
}
|
|
784
795
|
|
|
796
|
+
.tsd-page-navigation-section {
|
|
797
|
+
margin-left: 10px;
|
|
798
|
+
}
|
|
799
|
+
.tsd-page-navigation-section > summary {
|
|
800
|
+
padding: 0.25rem;
|
|
801
|
+
}
|
|
802
|
+
.tsd-page-navigation-section > div {
|
|
803
|
+
margin-left: 20px;
|
|
804
|
+
}
|
|
785
805
|
.tsd-page-navigation ul {
|
|
786
806
|
padding-left: 1.75rem;
|
|
787
807
|
}
|
|
@@ -812,10 +832,10 @@ a.tsd-index-link {
|
|
|
812
832
|
}
|
|
813
833
|
.tsd-accordion-summary,
|
|
814
834
|
.tsd-accordion-summary a {
|
|
815
|
-
user-select: none;
|
|
816
835
|
-moz-user-select: none;
|
|
817
836
|
-webkit-user-select: none;
|
|
818
837
|
-ms-user-select: none;
|
|
838
|
+
user-select: none;
|
|
819
839
|
|
|
820
840
|
cursor: pointer;
|
|
821
841
|
}
|
|
@@ -828,8 +848,9 @@ a.tsd-index-link {
|
|
|
828
848
|
padding-top: 0;
|
|
829
849
|
padding-bottom: 0;
|
|
830
850
|
}
|
|
831
|
-
.tsd-
|
|
851
|
+
.tsd-accordion .tsd-accordion-summary > svg {
|
|
832
852
|
margin-left: 0.25rem;
|
|
853
|
+
vertical-align: text-top;
|
|
833
854
|
}
|
|
834
855
|
.tsd-index-content > :not(:first-child) {
|
|
835
856
|
margin-top: 0.75rem;
|
|
@@ -877,7 +898,7 @@ a.tsd-index-link {
|
|
|
877
898
|
}
|
|
878
899
|
|
|
879
900
|
.tsd-panel-group {
|
|
880
|
-
margin:
|
|
901
|
+
margin: 2rem 0;
|
|
881
902
|
}
|
|
882
903
|
.tsd-panel-group.tsd-index-group {
|
|
883
904
|
margin: 2rem 0;
|
|
@@ -885,6 +906,9 @@ a.tsd-index-link {
|
|
|
885
906
|
.tsd-panel-group.tsd-index-group details {
|
|
886
907
|
margin: 2rem 0;
|
|
887
908
|
}
|
|
909
|
+
.tsd-panel-group > .tsd-accordion-summary {
|
|
910
|
+
margin-bottom: 1rem;
|
|
911
|
+
}
|
|
888
912
|
|
|
889
913
|
#tsd-search {
|
|
890
914
|
transition: background-color 0.2s;
|
|
@@ -1034,6 +1058,12 @@ a.tsd-index-link {
|
|
|
1034
1058
|
border-width: 1px 0;
|
|
1035
1059
|
transition: background-color 0.1s;
|
|
1036
1060
|
}
|
|
1061
|
+
.tsd-signatures .tsd-index-signature:not(:last-child) {
|
|
1062
|
+
margin-bottom: 1em;
|
|
1063
|
+
}
|
|
1064
|
+
.tsd-signatures .tsd-index-signature .tsd-signature {
|
|
1065
|
+
border-width: 1px;
|
|
1066
|
+
}
|
|
1037
1067
|
.tsd-description .tsd-signatures .tsd-signature {
|
|
1038
1068
|
border-width: 1px;
|
|
1039
1069
|
}
|
|
@@ -1347,6 +1377,12 @@ img {
|
|
|
1347
1377
|
.has-menu .tsd-navigation {
|
|
1348
1378
|
max-height: 100%;
|
|
1349
1379
|
}
|
|
1380
|
+
#tsd-toolbar-links {
|
|
1381
|
+
display: none;
|
|
1382
|
+
}
|
|
1383
|
+
.tsd-navigation .tsd-nav-link {
|
|
1384
|
+
display: flex;
|
|
1385
|
+
}
|
|
1350
1386
|
}
|
|
1351
1387
|
|
|
1352
1388
|
/* one sidebar */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZConfigExtender | 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.ZConfigExtender.html">ZConfigExtender</a></li></ul><h1>Class ZConfigExtender</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the standard extender.</p>
|
|
3
3
|
<p>This extender works the same as how eslint extends their
|
|
4
4
|
configuration. You can pass a key that acts as the extends key which holds paths
|
|
@@ -8,21 +8,17 @@ configs when extending, and plugin based syntax is not recognized.</p>
|
|
|
8
8
|
<p>It is always better to just use the extension methods of the actual
|
|
9
9
|
applications if those are available, but this can be used as a fallback or an
|
|
10
10
|
extension of behavior for child linters that do not support extendable configs.</p>
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html" class="tsd-signature-type tsd-kind-interface">IZConfigExtender</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html" class="tsd-signature-type tsd-kind-interface">IZConfigExtender</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-extender.mts#L29">config/config-extender.mts:29</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">Constructors</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigExtender.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
12
12
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigExtender.html#key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a>
|
|
13
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigExtender.html#
|
|
14
|
-
|
|
15
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_ZConfigExtender" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZConfig<wbr/>Extender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_lint_janitor.ZConfigExtender.html" class="tsd-signature-type tsd-kind-class">ZConfigExtender</a><a href="#constructor.new_ZConfigExtender" 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>Initializes a new instance of this object.</p>
|
|
13
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigExtender.html#extend" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>extend</span></a>
|
|
14
|
+
</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-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_ZConfigExtender" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZConfig<wbr/>Extender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_lint_janitor.ZConfigExtender.html" class="tsd-signature-type tsd-kind-class">ZConfigExtender</a><a href="#constructor.new_ZConfigExtender" 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>Initializes a new instance of this object.</p>
|
|
16
15
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'extends'</span></span><div class="tsd-comment tsd-typography"><p>The key to extend.</p>
|
|
17
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_lint_janitor.ZConfigExtender.html" class="tsd-signature-type tsd-kind-class">ZConfigExtender</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
19
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">module</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The module to read.</p>
|
|
20
|
-
</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">any</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves the extended inner module.</p>
|
|
21
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/af4cb188cfc48bd7b578f6bfa3a18747839fef37/packages/lint-janitor/src/config/config-extender.mts#L76">config/config-extender.mts:76</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="extend" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extend</span><a href="#extend" 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="extend.extend-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">extend</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</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">any</span><span class="tsd-signature-symbol">></span><a href="#extend.extend-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>Extends the configuration value.</p>
|
|
16
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_lint_janitor.ZConfigExtender.html" class="tsd-signature-type tsd-kind-class">ZConfigExtender</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-extender.mts#L36">config/config-extender.mts:36</a></li></ul></aside></li></ul></section></section></details><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="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>key</span><a href="#key" 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">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'extends'</span></div><div class="tsd-comment tsd-typography"><p>The key to extend.</p>
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-extender.mts#L36">config/config-extender.mts:36</a></li></ul></aside></section></section></details><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="extend" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extend</span><a href="#extend" 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="extend.extend-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">extend</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</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">any</span><span class="tsd-signature-symbol">></span><a href="#extend.extend-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>Extends the configuration value.</p>
|
|
22
18
|
<p>This is similar to how eslint works. This will do an
|
|
23
19
|
asynchronous require on each configuration under the key in the
|
|
24
20
|
config. If the key in the config is falsy, then the config is returned.</p>
|
|
25
21
|
<p>The actual key in the config is deleted.</p>
|
|
26
22
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The config to extend.</p>
|
|
27
23
|
</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">any</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves the extended configuration.</p>
|
|
28
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html">IZConfigExtender</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html#extend">extend</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
24
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html">IZConfigExtender</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html#extend">extend</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-extender.mts#L53">config/config-extender.mts:53</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a></div></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="#extend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>extend</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,28 +1,28 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZConfigReaderCosmic | 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.ZConfigReaderCosmic.html">ZConfigReaderCosmic</a></li></ul><h1>Class ZConfigReaderCosmic</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a reader that uses the cosmiconfig standard for files.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html" class="tsd-signature-type tsd-kind-interface">IZConfigReader</a></li><li><a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html" class="tsd-signature-type tsd-kind-interface">IZConfigDiscovery</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><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html" class="tsd-signature-type tsd-kind-interface">IZConfigReader</a></li><li><a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html" class="tsd-signature-type tsd-kind-interface">IZConfigDiscovery</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L12">config/config-reader-cosmic.mts:12</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">Constructors</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#extender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extender</span></a>
|
|
5
5
|
<a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
6
6
|
<a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#paths" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a>
|
|
7
7
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#read" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read</span></a>
|
|
8
8
|
<a href="_zthun_lint_janitor.ZConfigReaderCosmic.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a>
|
|
9
|
-
</div></section></div></details></section></section><
|
|
9
|
+
</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-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_ZConfigReaderCosmic" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZConfig<wbr/>Reader<wbr/>Cosmic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">extender</span>, <span class="tsd-kind-parameter">paths</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_lint_janitor.ZConfigReaderCosmic.html" class="tsd-signature-type tsd-kind-class">ZConfigReaderCosmic</a><a href="#constructor.new_ZConfigReaderCosmic" 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>Initializes a new instance of this object.</p>
|
|
10
10
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the application to load.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">extender</span>: <a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html" class="tsd-signature-type tsd-kind-interface">IZConfigExtender</a></span><div class="tsd-comment tsd-typography"><p>The extender to expand upon the read configuration.</p>
|
|
12
12
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">paths</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The additional paths to read if cosmic config does not find a valid config. Remember that these
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_lint_janitor.ZConfigReaderCosmic.html" class="tsd-signature-type tsd-kind-class">ZConfigReaderCosmic</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
17
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
13
|
+
are paths, not modules in this case, so you can't load things from the node modules directory
|
|
14
|
+
using these values. These only affect the search for the config file, not the actual
|
|
15
|
+
read of the config.</p>
|
|
16
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_lint_janitor.ZConfigReaderCosmic.html" class="tsd-signature-type tsd-kind-class">ZConfigReaderCosmic</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L26">config/config-reader-cosmic.mts:26</a></li></ul></aside></li></ul></section></section></details><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="extender" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extender</span><a href="#extender" 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">extender</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_lint_janitor.IZConfigExtender.html" class="tsd-signature-type tsd-kind-interface">IZConfigExtender</a></div><div class="tsd-comment tsd-typography"><p>The extender to expand upon the read configuration.</p>
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L28">config/config-reader-cosmic.mts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the application to load.</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L27">config/config-reader-cosmic.mts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="paths" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paths</span><a href="#paths" 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">paths</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></div><div class="tsd-comment tsd-typography"><p>The additional paths to read if cosmic config does not find a valid config. Remember that these
|
|
19
|
+
are paths, not modules in this case, so you can't load things from the node modules directory
|
|
20
|
+
using these values. These only affect the search for the config file, not the actual
|
|
21
|
+
read of the config.</p>
|
|
22
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L29">config/config-reader-cosmic.mts:29</a></li></ul></aside></section></section></details><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="read" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>read</span><a href="#read" 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="read.read-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">read</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</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">any</span><span class="tsd-signature-symbol">></span><a href="#read.read-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>Reads the config file.</p>
|
|
23
23
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The optional configuration file. If this is null then the cosmiconfig path is searched on the name.</p>
|
|
24
24
|
</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">any</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves the json object that represents the config.</p>
|
|
25
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html">IZConfigReader</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html#read">read</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
25
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html">IZConfigReader</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigReader.html#read">read</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L74">config/config-reader-cosmic.mts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>search</span><a href="#search" 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="search.search-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search</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">any</span><span class="tsd-signature-symbol">></span><a href="#search.search-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>Runs a search for the appropriate configuration file.</p>
|
|
26
26
|
<p>The extension keyword is deleted from the config.</p>
|
|
27
27
|
</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">any</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the expanded configuration.</p>
|
|
28
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html">IZConfigDiscovery</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html#search">search</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/
|
|
28
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html">IZConfigDiscovery</a>.<a href="../interfaces/_zthun_lint_janitor.IZConfigDiscovery.html#search">search</a></p><ul><li>Defined in <a href="https://github.com/zthun/janitor/blob/eb67063732e5bf5c20b9f7b4471027d0305a8951/packages/lint-janitor/src/config/config-reader-cosmic.mts#L40">config/config-reader-cosmic.mts:40</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#extender" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extender</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#paths" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a></div></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="#read" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read</span></a><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</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>
|