@zthun/janitor-web 16.0.1 → 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 +69 -36
- 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
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
|
|
6
|
+
everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
|
|
7
|
+
and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion,
|
|
8
|
+
or sexual identity and orientation.
|
|
9
|
+
|
|
10
|
+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
|
11
|
+
|
|
12
|
+
## Our Standards
|
|
13
|
+
|
|
14
|
+
Examples of behavior that contributes to a positive environment for our community include:
|
|
15
|
+
|
|
16
|
+
- Demonstrating empathy and kindness toward other people
|
|
17
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
18
|
+
- Giving and gracefully accepting constructive feedback
|
|
19
|
+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
|
20
|
+
- Focusing on what is best not just for us as individuals, but for the overall community
|
|
21
|
+
|
|
22
|
+
Examples of unacceptable behavior include:
|
|
23
|
+
|
|
24
|
+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
|
25
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
26
|
+
- Public or private harassment
|
|
27
|
+
- Publishing others' private information, such as a physical or email address, without their explicit permission
|
|
28
|
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
29
|
+
|
|
30
|
+
## Enforcement Responsibilities
|
|
31
|
+
|
|
32
|
+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
|
|
33
|
+
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
|
|
34
|
+
or harmful.
|
|
35
|
+
|
|
36
|
+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
|
|
37
|
+
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
|
|
38
|
+
moderation decisions when appropriate.
|
|
39
|
+
|
|
40
|
+
## Scope
|
|
41
|
+
|
|
42
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
|
|
43
|
+
the community in public spaces. Examples of representing our community include using an official e-mail address, posting
|
|
44
|
+
via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
45
|
+
|
|
46
|
+
## Enforcement
|
|
47
|
+
|
|
48
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
|
|
49
|
+
for enforcement at [admin@zthunworks.com](admin@zthunworks.com). All complaints will be reviewed and investigated
|
|
50
|
+
promptly and fairly.
|
|
51
|
+
|
|
52
|
+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
53
|
+
|
|
54
|
+
## Enforcement Guidelines
|
|
55
|
+
|
|
56
|
+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
|
|
57
|
+
in violation of this Code of Conduct:
|
|
58
|
+
|
|
59
|
+
### 1. Correction
|
|
60
|
+
|
|
61
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the
|
|
62
|
+
community.
|
|
63
|
+
|
|
64
|
+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
|
|
65
|
+
and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
|
66
|
+
|
|
67
|
+
### 2. Warning
|
|
68
|
+
|
|
69
|
+
**Community Impact**: A violation through a single incident or series of actions.
|
|
70
|
+
|
|
71
|
+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
|
|
72
|
+
unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
|
|
73
|
+
interactions in community spaces as well as external channels like social media. Violating these terms may lead to a
|
|
74
|
+
temporary or permanent ban.
|
|
75
|
+
|
|
76
|
+
### 3. Temporary Ban
|
|
77
|
+
|
|
78
|
+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
|
79
|
+
|
|
80
|
+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
|
|
81
|
+
period of time. No public or private interaction with the people involved, including unsolicited interaction with those
|
|
82
|
+
enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
|
83
|
+
|
|
84
|
+
### 4. Permanent Ban
|
|
85
|
+
|
|
86
|
+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
|
|
87
|
+
behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
|
88
|
+
|
|
89
|
+
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
|
90
|
+
|
|
91
|
+
## Attribution
|
|
92
|
+
|
|
93
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
|
|
94
|
+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html].
|
|
95
|
+
|
|
96
|
+
Community Impact Guidelines were inspired by
|
|
97
|
+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
98
|
+
|
|
99
|
+
[homepage]: [https://www.contributor-covenant.org]
|
|
100
|
+
|
|
101
|
+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq].
|
|
102
|
+
Translations are available at [https://www.contributor-covenant.org/translations].
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for taking the time to contribute! Generally, the big secret of this project is that it is mostly done as a
|
|
4
|
+
hobby. There is no big intention to make lint janitor the code cleanliness standard and anyone who uses it would just
|
|
5
|
+
have to find it useful. It is not marketed or advertised; a good product should sell itself. However, at the minimum,
|
|
6
|
+
people would need to know about it, so unless you are looking to make code contributions, the minimum contribution that
|
|
7
|
+
ANYONE can make is to let their friends know about a tool that they found helpful and provided value.
|
|
8
|
+
|
|
9
|
+
However, if you are looking to make code contributions to this repository, then this document should get you set up.
|
|
10
|
+
|
|
11
|
+
## Deployment
|
|
12
|
+
|
|
13
|
+
The point of this repository is to deploy out NPM packages. Everything here is deployed to the public
|
|
14
|
+
[NPM](https://npmjs.org) repository.
|
|
15
|
+
|
|
16
|
+
The intention of this is to use these packages locally so other users will be doing npm installs of individual packages
|
|
17
|
+
to their own repositories.
|
|
18
|
+
|
|
19
|
+
## Environment
|
|
20
|
+
|
|
21
|
+
In order to build the janitor repo, you are going to need [Node](https://nodejs.org/en/),
|
|
22
|
+
[Yarn](https://classic.yarnpkg.com/lang/en/), and an IDE of your choice. We generally recommend
|
|
23
|
+
[VisualStudio Code](https://code.visualstudio.com/) as that one has the most plugins and support to do everything you
|
|
24
|
+
will need. There are a couple of extensions that are highly recommended to install.
|
|
25
|
+
|
|
26
|
+
- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
|
|
27
|
+
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
28
|
+
- [MarkdownLint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
|
29
|
+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
30
|
+
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)
|
|
31
|
+
- [ViTest](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer)
|
|
32
|
+
|
|
33
|
+
## Build and Debug
|
|
34
|
+
|
|
35
|
+
The following series of commands will check out and build all packages.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
git clone https://github.com/zthun/janitor
|
|
39
|
+
yarn install
|
|
40
|
+
yarn make
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
If you want to step into the debugger for the lint janitor, this repository comes with the appropriate vscode
|
|
44
|
+
launch.json configurations to start debugging. Simply hit the run button under Launch Lint Janitor, set your breakpoints
|
|
45
|
+
and away you go.
|
|
46
|
+
|
|
47
|
+
## Test
|
|
48
|
+
|
|
49
|
+
Unit testing is done using vitest.
|
|
50
|
+
|
|
51
|
+
To run the unit tests, use the following series of commands.
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
yarn test
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Versioning
|
|
58
|
+
|
|
59
|
+
This repository uses conventional commits to determine the next version to publish. Make sure before you make any
|
|
60
|
+
commits that you [follow this standard](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
61
|
+
|
|
62
|
+
## Pull Request
|
|
63
|
+
|
|
64
|
+
Fork this repository, make any changes you need and then create a pull request from your fork. From the above samples,
|
|
65
|
+
you'll want to change the git clone command to point to your local repository fork. See the
|
|
66
|
+
[pull request template](.github/pull_request_template.md) for more information and checks to make.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Anthony Bonta
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
6
|
+
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
7
|
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
8
|
+
persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
11
|
+
Software.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
14
|
+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
15
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
16
|
+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
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="_zthun_eslint_config.html">@zthun/eslint-config</a></li></ul><h1>Module @zthun/eslint-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:eslint-config" class="tsd-anchor"></a><h1
|
|
3
|
-
<a id="md:getting-started" class="tsd-anchor"></a><h2
|
|
4
|
-
</code><button>Copy</button></pre>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/eslint-config | 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="_zthun_eslint_config.html">@zthun/eslint-config</a></li></ul><h1>Module @zthun/eslint-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:eslint-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">ESLint Config<a href="#md:eslint-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared eslint configuration for zthun scoped projects.</p>
|
|
3
|
+
<a id="md:getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Getting Started<a href="#md:getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
4
|
+
</code><button type="button">Copy</button></pre>
|
|
5
|
+
|
|
5
6
|
<p>Make sure to install typescript and @typescript-eslint/eslint-plugin with all peer dependencies.</p>
|
|
6
|
-
<a id="md:usage" class="tsd-anchor"></a><h2
|
|
7
|
-
<pre><code class="
|
|
8
|
-
</code><button>Copy</button></pre>
|
|
9
|
-
|
|
10
|
-
|
|
7
|
+
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the .eslintrc file, add the following</p>
|
|
8
|
+
<pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">"extends"</span><span class="hl-2">: [</span><span class="hl-3">"@zthun/eslint-config"</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
|
|
9
|
+
</code><button type="button">Copy</button></pre>
|
|
10
|
+
|
|
11
|
+
<p>That's it. You now have the recommended rules for zthun scoped projects with typescript.</p>
|
|
12
|
+
</section></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"><a href="#md:eslint-config"><span>ESLint <wbr/>Config</span></a><ul><li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></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,9 +1,11 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
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="_zthun_eslint_react_config.html">@zthun/eslint-react-config</a></li></ul><h1>Module @zthun/eslint-react-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:eslint-react-config" class="tsd-anchor"></a><h1
|
|
3
|
-
<a id="md:getting-started" class="tsd-anchor"></a><h2
|
|
4
|
-
</code><button>Copy</button></pre>
|
|
5
|
-
|
|
6
|
-
<
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/eslint-react-config | 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="_zthun_eslint_react_config.html">@zthun/eslint-react-config</a></li></ul><h1>Module @zthun/eslint-react-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:eslint-react-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">ESLint React Config<a href="#md:eslint-react-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared eslint configuration for zthun scoped react based projects.</p>
|
|
3
|
+
<a id="md:getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Getting Started<a href="#md:getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-react-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/eslint-react-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
4
|
+
</code><button type="button">Copy</button></pre>
|
|
5
|
+
|
|
6
|
+
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the .eslintrc file, add the following</p>
|
|
7
|
+
<pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">"extends"</span><span class="hl-2">: [</span><span class="hl-3">"@zthun/eslint-react-config"</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
|
|
8
|
+
</code><button type="button">Copy</button></pre>
|
|
9
|
+
|
|
10
|
+
<p>That's it. You now have the recommended rules for zthun scoped react projects.</p>
|
|
11
|
+
</section></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"><a href="#md:eslint-react-config"><span>ESLint <wbr/>React <wbr/>Config</span></a><ul><li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></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,11 +1,13 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
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="_zthun_htmlhint_config.html">@zthun/htmlhint-config</a></li></ul><h1>Module @zthun/htmlhint-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:htmlhint-config" class="tsd-anchor"></a><h1
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/htmlhint-config | 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="_zthun_htmlhint_config.html">@zthun/htmlhint-config</a></li></ul><h1>Module @zthun/htmlhint-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:htmlhint-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">HTMLHint Config<a href="#md:htmlhint-config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This is the shared htmlhint configuration for zthun scoped projects. Note that currently, as of htmlhint 0.14.x,
|
|
3
3
|
extendable configs are not supported, but lint-janitor indirectly adds support for it.</p>
|
|
4
|
-
<a id="md:getting-started" class="tsd-anchor"></a><h2
|
|
5
|
-
</code><button>Copy</button></pre>
|
|
6
|
-
|
|
7
|
-
<
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
4
|
+
<a id="md:getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Getting Started<a href="#md:getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/htmlhint-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/htmlhint-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
5
|
+
</code><button type="button">Copy</button></pre>
|
|
6
|
+
|
|
7
|
+
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>In the htmlhint config file, add the following</p>
|
|
8
|
+
<pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-5">"extends"</span><span class="hl-2">: [</span><span class="hl-3">"@zthun/htmlhint-config"</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
|
|
9
|
+
</code><button type="button">Copy</button></pre>
|
|
10
|
+
|
|
11
|
+
<p>That's it. You now have the recommended rules for zthun scoped projects.</p>
|
|
12
|
+
<a id="md:htmlhint" class="tsd-anchor"></a><h2 class="tsd-anchor-link">HTMLHint<a href="#md:htmlhint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The actual HTMLHint application does NOT support the extends pattern without lint-janitor.</p>
|
|
13
|
+
</section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><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"><a href="#md:htmlhint-config"><span>HTMLHint <wbr/>Config</span></a><ul><li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:htmlhint"><span>HTMLHint</span></a></li></ul></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>
|