npm - @zthun/janitor-web - Versions diffs - 16.1.1 → 17.0.0 - Mend

@zthun/janitor-web 16.1.1 → 17.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

package/dist/modules/_zthun_lint_janitor.html CHANGED Viewed

@@ -1,29 +1,41 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/lint-janitor | 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" />
-</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_lint_janitor.html">@zthun/lint-janitor</a></li></ul><h1>Module @zthun/lint-janitor</h1></div><section class="tsd-panel tsd-typography"><a id="md:lint-janitor" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Lint Janitor<a href="#md:lint-janitor" 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>Code gets messy. You will find that most places you work at will always have a big long list of tech debt tasks that
-need to be taken care of and this becomes a maintenance nightmare as it becomes very expensive to fix. Companies rarely
-want to let developers fix these issues because they tend to only look at the short term ROI, which isn't high for this
-kind of task. What then happens is that more functional, but messy, code gets introduced and the software begins to rot.</p>
-<p>One way to fix something like this is to start with linters. Linters will scour through your code base and notify you
-that you have various issues. In a good development pipeline, they will prevent developers from generating a messy room
-and will force them to write clean consistent code with the rest of the development team. They aren't a silver bullet,
-and messy solutions can still crop up, but linters take care of most of the inconsistent and formatting errors that can
-develop in a code base. Good developers love them - it keeps the entire team consistent in their code structure.</p>
-<p>Of course, linters are not without their issues as well. There's an outrageous amount of them out there and you have to
-be well versed in each one of them in order to set each one of them up and run them in your pipeline to verify all of
-the different code files you have. There's linters for code, applications, spelling, and formatting; it's easy to get
-overwhelmed.</p>
-<p><strong>Lint Janitor</strong> was created under the guise that there is beauty in simplicity. Having a single application that takes
-care of ones needs leads to greater happiness then having to piece meal together tons of tools, each with individual
-needs and maintainability issues. Just let <strong>Lint Janitor</strong> do the heavy lifting for you.</p>
+</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_lint_janitor.html">@zthun/lint-janitor</a></li></ul><h1>Module @zthun/lint-janitor</h1></div><section class="tsd-panel tsd-typography"><a id="md:lint-janitor" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Lint Janitor<a href="#md:lint-janitor" 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>Code gets messy. You will find that most places you work at will always have a
+big long list of tech debt tasks that need to be taken care of and this becomes
+a maintenance nightmare as it becomes very expensive to fix. Companies rarely
+want to let developers fix these issues because they tend to only look at the
+short term ROI, which isn't high for this kind of task. What then happens is
+that more functional, but messy, code gets introduced and the software begins to
+rot.</p>
+<p>One way to fix something like this is to start with linters. Linters will scour
+through your code base and notify you that you have various issues. In a good
+development pipeline, they will prevent developers from generating a messy room
+and will force them to write clean consistent code with the rest of the
+development team. They aren't a silver bullet, and messy solutions can still
+crop up, but linters take care of most of the inconsistent and formatting errors
+that can develop in a code base. Good developers love them - it keeps the entire
+team consistent in their code structure.</p>
+<p>Of course, linters are not without their issues as well. There's an outrageous
+amount of them out there and you have to be well versed in each one of them in
+order to set each one of them up and run them in your pipeline to verify all of
+the different code files you have. There's linters for code, applications,
+spelling, and formatting; it's easy to get overwhelmed.</p>
+<p><strong>Lint Janitor</strong> was created under the guise that there is beauty in simplicity.
+Having a single application that takes care of ones needs leads to greater
+happiness then having to piece meal together tons of tools, each with individual
+needs and maintainability issues. Just let <strong>Lint Janitor</strong> do the heavy lifting
+for you.</p>
 <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/lint-janitor</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
 </code><button type="button">Copy</button></pre>
-<a id="md:configuration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Configuration<a href="#md:configuration" 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>Lint Janitor uses an opt-in approach to linting, meaning that it will not lint any files that you do not tell it to
-lint. You will need to add a configuration file that describes the list of files to lint and the sub configurations of
-each internal linter. Each linter is described in further detail. In the end, the expectation is that you will provide
-you're own collection of shared configurations that you can reuse in all your projects.</p>
-<p>Lint Janitor uses the <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard for loading its configuration.
-In short, it will search the current working directory for the following files:</p>
+<a id="md:configuration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Configuration<a href="#md:configuration" 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>Lint Janitor uses an opt-in approach to linting, meaning that it will not lint
+any files that you do not tell it to lint. You will need to add a configuration
+file that describes the list of files to lint and the sub configurations of each
+internal linter. Each linter is described in further detail. In the end, the
+expectation is that you will provide you're own collection of shared
+configurations that you can reuse in all your projects.</p>
+<p>Lint Janitor uses the <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a>
+standard for loading its configuration. In short, it will search the current
+working directory for the following files:</p>
 <ol>
 <li>A property in your package.json named <strong>lint-janitor</strong>.</li>
 <li>A json file or yaml file named <strong>lint-janitorrc</strong>.</li>
@@ -32,8 +44,9 @@ In short, it will search the current working directory for the following files:<
 <li>A javascript file named <strong>lint-janitorrc.js</strong>, <strong>lint-janitor.config.js</strong>.</li>
 </ol>
 <blockquote>
-<p>It is highly recommended to use a config.js convention for these types of configurations. The main reason is that
-config.js offers the most flexible way to configure an application and also naturally allows you to use the module
+<p>It is highly recommended to use a config.js convention for these types of
+configurations. The main reason is that config.js offers the most flexible way
+to configure an application and also naturally allows you to use the module
 syntax to import other configurations.</p>
 </blockquote>
 <p>The configuration file uses the following schema.</p>
@@ -52,31 +65,41 @@ syntax to import other configurations.</p>
 <pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">run</span><span class="hl-2"> </span><span class="hl-3">lint</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">lint</span><br/><span class="hl-0"># NPX</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">lint-janitor</span>
 </code><button type="button">Copy</button></pre>
-<a id="md:command-line" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Command Line<a href="#md:command-line" 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>You can always run lint-janitor on the command line using npx or if it is installed globally, which is not recommended.
-There are very few command line options, as lint-janitor intends to be fully driven by the config file.</p>
+<a id="md:command-line" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Command Line<a href="#md:command-line" 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>You can always run lint-janitor on the command line using npx or if it is
+installed globally, which is not recommended. There are very few command line
+options, as lint-janitor intends to be fully driven by the config file.</p>
 <p><strong>lint-janitor</strong> [options]</p>
 <pre><code class="json"><span class="hl-2">[</span><br/><span class="hl-2">  { </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--version&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Show version number&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;boolean&quot;</span><span class="hl-2"> }</span><br/><span class="hl-2">  { </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--config&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;alias&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;-c&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Optional config file to use&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;string&quot;</span><span class="hl-2"> },</span><br/><span class="hl-2">  { </span><span class="hl-5">&quot;option&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;--help&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;description&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;Show help&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;type&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;boolean&quot;</span><span class="hl-2"> }</span><br/><span class="hl-2">]</span>
 </code><button type="button">Copy</button></pre>
-<a id="md:linters" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Linters<a href="#md:linters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:shared-configurations" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Shared Configurations<a href="#md:shared-configurations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>While you can always recreate individual configurations for each linter, it is <strong>HIGHLY</strong> recommended to create a set of
-shared configurations for your organization. Most linters supported by Lint Janitor have some form of support for
-extending configurations and sharing them so you don't need to reinvent the wheel. In the place that such extensions are
-missing, Lint Janitor attempts to bridge this gap but it will not add support for IDE based tooling and extensions.
-You'll have to decide what's best for your project and your organization.</p>
-<p>One note is that the housing repository for lint-janitor contains multiple shared configurations used by zthun scoped
-projects. You can use them, but it is recommended for your organization to create it's own set of configurations that
+<a id="md:linters" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Linters<a href="#md:linters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:shared-configurations" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Shared Configurations<a href="#md:shared-configurations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>While you can always recreate individual configurations for each linter, it is
+<strong>HIGHLY</strong> recommended to create a set of shared configurations for your
+organization. Most linters supported by Lint Janitor have some form of support
+for extending configurations and sharing them so you don't need to reinvent the
+wheel. In the place that such extensions are missing, Lint Janitor attempts to
+bridge this gap but it will not add support for IDE based tooling and
+extensions. You'll have to decide what's best for your project and your
+organization.</p>
+<p>One note is that the housing repository for lint-janitor contains multiple
+shared configurations used by zthun scoped projects. You can use them, but it is
+recommended for your organization to create it's own set of configurations that
 meets its needs.</p>
-<a id="md:json-and-yaml" class="tsd-anchor"></a><h3 class="tsd-anchor-link">JSON and YAML<a href="#md:json-and-yaml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>JSON does not use an external tool. It's impossible to have lint errors in JSON as if there are, it wouldn't be valid
-JSON and you won't be able to parse it. Thus, when we talk about linting JSON, it's really just a parse check to make
+<a id="md:json-and-yaml" class="tsd-anchor"></a><h3 class="tsd-anchor-link">JSON and YAML<a href="#md:json-and-yaml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>JSON does not use an external tool. It's impossible to have lint errors in JSON
+as if there are, it wouldn't be valid JSON and you won't be able to parse it.
+Thus, when we talk about linting JSON, it's really just a parse check to make
 sure you're JSON is valid.</p>
-<p>For YAML, the same rule applies. It's just a parse check, but since YAML isn't supported in JavaScript out of the box,
-it uses <a href="https://www.npmjs.com/package/js-yaml">js-yaml</a> under the hood to parse and check your files.</p>
+<p>For YAML, the same rule applies. It's just a parse check, but since YAML isn't
+supported in JavaScript out of the box, it uses
+<a href="https://www.npmjs.com/package/js-yaml">js-yaml</a> under the hood to parse and
+check your files.</p>
 <p>Neither of these checks verify schemas so be warned about that.</p>
-<a id="md:ecmascript" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ECMAScript<a href="#md:ecmascript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The linter of choice for ECMAScript, is <a href="https://eslint.org/">ESLint</a>. ESLint has a very large eco system with support
-for shared configurations and plugins. It supports both TypeScript and JavaScript so it covers the entire feature
+<a id="md:ecmascript" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ECMAScript<a href="#md:ecmascript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The linter of choice for ECMAScript, is <a href="https://eslint.org/">ESLint</a>. ESLint
+has a very large eco system with support for shared configurations and plugins.
+It supports both TypeScript and JavaScript so it covers the entire feature
 spectrum. The configuration file for ESLint uses something similar to a
-<a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard but it's more restrictive. Instead, it looks for the
-following files in the current working directory.</p>
+<a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard but it's more
+restrictive. Instead, it looks for the following files in the current working
+directory.</p>
 <ol>
 <li>.eslintrc.js</li>
 <li>.eslintrc.cjs</li>
@@ -85,13 +108,15 @@ following files in the current working directory.</p>
 <li>.eslintrc.json</li>
 <li>package.json</li>
 </ol>
-<p>There is also a <a href="https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint">VisualStudio Code plugin</a>
-that will give you highlighting for any linting errors while you type. This makes ESLint the go to linter for web based
-ECMAScript code.</p>
-<p>For the configuration schema, you can find it <a href="https://eslint.org/docs/user-guide/configuring/">here</a>. If you create a
-shared configuration, as recommended, you can simply add that to the extends key in the ESLint configuration file to
-share configuration throughout your organization.</p>
-<pre><code class="js"><span class="hl-0">// .eslintrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;@zthun/eslint-config&#39;</span><span class="hl-2">);</span>
+<p>There is also a
+<a href="https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint">VisualStudio Code plugin</a>
+that will give you highlighting for any linting errors while you type. This
+makes ESLint the go to linter for web based ECMAScript code.</p>
+<p>For the configuration schema, you can find it
+<a href="https://eslint.org/docs/user-guide/configuring/">here</a>. If you create a shared
+configuration, as recommended, you can simply add that to the extends key in the
+ESLint configuration file to share configuration throughout your organization.</p>
+<pre><code class="js"><span class="hl-0">// .eslintrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/eslint-config&quot;</span><span class="hl-2">);</span>
 </code><button type="button">Copy</button></pre>
 <a id="md:styles-css-less-sass" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Styles (CSS, Less, SASS)<a href="#md:styles-css-less-sass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>There are several linters for style based files.</p>
@@ -100,112 +125,143 @@ share configuration throughout your organization.</p>
 <li><a href="https://github.com/sasstools/sass-lint">SassLint</a></li>
 <li><a href="https://stylelint.io/">StyleLint</a></li>
 </ol>
-<p>CSSLint and SassLint are no longer actively maintained. Thus, for linting style based files, Lint Janitor uses StyleLint
-under the hood.</p>
-<p>StyleLint is similar to <a href="https://eslint.org/">ESLint</a>. It too, has a nice ecosystem of plugins and it supports shared
-configurations. Stylelint, unlike ESLint, does support the <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a>
-standard, but it is recommended to use .stylelintrc.json convention. The main reason is that the actual
-<a href="https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint">VisualStudio Code plugin</a> specifically
-looks for this file so you can get lint errors directly in your IDE.</p>
-<p>You can find the configuration schema <a href="https://stylelint.io/user-guide/configure">here</a> and you can use the extends key
-in the configuration to load a shared configuration.</p>
-<pre><code class="jsonc"><span class="hl-0">// .stylelintrc.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/stylelint-config&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
+<p>CSSLint and SassLint are no longer actively maintained. Thus, for linting style
+based files, Lint Janitor uses StyleLint under the hood.</p>
+<p>StyleLint is similar to <a href="https://eslint.org/">ESLint</a>. It too, has a nice
+ecosystem of plugins and it supports shared configurations. Stylelint, unlike
+ESLint, does support the
+<a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard, but it is
+recommended to use .stylelintrc.json convention. The main reason is that the
+actual
+<a href="https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint">VisualStudio Code plugin</a>
+specifically looks for this file so you can get lint errors directly in your
+IDE.</p>
+<p>You can find the configuration schema
+<a href="https://stylelint.io/user-guide/configure">here</a> and you can use the extends
+key in the configuration to load a shared configuration.</p>
+<pre><code class="jsonc"><span class="hl-0">// .stylelintrc.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/stylelint-config&quot;</span><span class="hl-2">],</span><br/><span class="hl-2">}</span>
 </code><button type="button">Copy</button></pre>
-<p>As usual, the list of html rules are <a href="https://htmlhint.com/docs/user-guide/list-rules">here</a>.</p>
-<a id="md:html" class="tsd-anchor"></a><h3 class="tsd-anchor-link">HTML<a href="#md:html" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>There is not a lot of support for HTML linters. There is only really one that is used and it is somewhat old and doesn't
-have a lot of support. A promise of a 1.0.0 release has been made, but we will have to wait and see what happens. That
+<p>As usual, the list of html rules are
+<a href="https://htmlhint.com/docs/user-guide/list-rules">here</a>.</p>
+<a id="md:html" class="tsd-anchor"></a><h3 class="tsd-anchor-link">HTML<a href="#md:html" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>There is not a lot of support for HTML linters. There is only really one that is
+used and it is somewhat old and doesn't have a lot of support. A promise of a
+1.0.0 release has been made, but we will have to wait and see what happens. That
 application is <a href="https://github.com/htmlhint/HTMLHint">HTMLHint</a>.</p>
 <p>HTMLHint does NOT support shared configurations at all. To do that,
-<a href="https://github.com/htmlhint/HTMLHint/issues/621">this issue</a> would need to be approved and supported. In the meantime,
-Lint Janitor bridges this gap by sending just the content to HTMLHint instead of the file list. This allows Lint Janitor
-to implement a <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a> standard for loading and extending the
-configuration to support shared configs. It will be up to you if you want to do this because the
-<a href="https://marketplace.visualstudio.com/items?itemName=mkaufman.HTMLHint">VisualStudio Code plugin</a> does not support this
-and expects the standard json file to be at the root of your project.</p>
-<p>If you do choose to use a shared configuration, you can just use a htmlhint.config.js file at the root of your
-repository.</p>
-<pre><code class="js"><span class="hl-0">//htmlhint.config.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;@zthun/htmlhint-config&#39;</span><span class="hl-2">);</span>
+<a href="https://github.com/htmlhint/HTMLHint/issues/621">this issue</a> would need to be
+approved and supported. In the meantime, Lint Janitor bridges this gap by
+sending just the content to HTMLHint instead of the file list. This allows Lint
+Janitor to implement a <a href="https://www.npmjs.com/package/cosmiconfig">cosmiconfig</a>
+standard for loading and extending the configuration to support shared configs.
+It will be up to you if you want to do this because the
+<a href="https://marketplace.visualstudio.com/items?itemName=mkaufman.HTMLHint">VisualStudio Code plugin</a>
+does not support this and expects the standard json file to be at the root of
+your project.</p>
+<p>If you do choose to use a shared configuration, you can just use a
+htmlhint.config.js file at the root of your repository.</p>
+<pre><code class="js"><span class="hl-0">//htmlhint.config.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/htmlhint-config&quot;</span><span class="hl-2">);</span>
 </code><button type="button">Copy</button></pre>
 <a id="md:markdown" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Markdown<a href="#md:markdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Good old markdown has a couple of linters available, but considering that
 <a href="https://github.com/DavidAnson/markdownlint">MarkdownLint</a> has a working
-<a href="https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint">VisualStudio Code plugin</a>, that's
-the one that Lint Janitor uses.</p>
-<p>MarkdownLint searches for the following configuration files at the root of your repository.</p>
+<a href="https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint">VisualStudio Code plugin</a>,
+that's the one that Lint Janitor uses.</p>
+<p>MarkdownLint searches for the following configuration files at the root of your
+repository.</p>
 <ol>
 <li>.markdownlint.json</li>
 <li>.markdownlint.yaml or .markdownlint.yml</li>
 <li>.markdownlintrc</li>
 </ol>
-<p>Strangely enough, if you are using the vscode plugin, then it is recommended to just use the .markdownlint.json name
-because that seems to be the only one that the plugin will respect. There's not a lot of rules to markdown. You can find
-the list of rules <a href="https://github.com/DavidAnson/markdownlint">here</a>. While it's not documented, MarkdownLint does have
-support for shared configurations, but there is a gotcha with it. The actual shared configuration MUST be in a json
-format. If you are creating a shared configuration for markdown, you will want to export a module of it and also have an
-actual json formatted file that comes along with it.</p>
+<p>Strangely enough, if you are using the vscode plugin, then it is recommended to
+just use the .markdownlint.json name because that seems to be the only one that
+the plugin will respect. There's not a lot of rules to markdown. You can find
+the list of rules <a href="https://github.com/DavidAnson/markdownlint">here</a>. While it's
+not documented, MarkdownLint does have support for shared configurations, but
+there is a gotcha with it. The actual shared configuration MUST be in a json
+format. If you are creating a shared configuration for markdown, you will want
+to export a module of it and also have an actual json formatted file that comes
+along with it.</p>
 <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;@zthun/markdownlint-config/as-json&quot;</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">// node_modules/@zthun/markdownlint-config/as-json.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;line-length&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;no-inline-html&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;no-duplicate-heading&quot;</span><span class="hl-2">: </span><span class="hl-4">false</span><br/><span class="hl-2">}</span>
 </code><button type="button">Copy</button></pre>
 <p>You can still export a node module that has your shared configuration.</p>
-<pre><code class="js"><span class="hl-0">// index.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;./as-json.json&#39;</span><span class="hl-2">);</span>
+<pre><code class="js"><span class="hl-0">// index.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;./as-json.json&quot;</span><span class="hl-2">);</span>
 </code><button type="button">Copy</button></pre>
-<a id="md:spelling" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Spelling<a href="#md:spelling" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This one is pretty optional, but it's useful in that it keeps you honest. With spelling, you won't use a shared
-configuration as this is truly unique across all projects. It is not possible to have a be all end all language that
-knows every word in existence so this will look for the <a href="https://www.npmjs.com/package/cspell">CSpell</a> configuration at
-the root of the repository. If you combine this with the
+<a id="md:spelling" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Spelling<a href="#md:spelling" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This one is pretty optional, but it's useful in that it keeps you honest. With
+spelling, you won't use a shared configuration as this is truly unique across
+all projects. It is not possible to have a be all end all language that knows
+every word in existence so this will look for the
+<a href="https://www.npmjs.com/package/cspell">CSpell</a> configuration at the root of the
+repository. If you combine this with the
 <a href="https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker">VisualStudio Code plugin</a>,
-it's pretty powerful and lets you add words as the repository vocabulary grows. When using spelling here, you'll need to
-decide if there are words you want to support, what dictionaries your repository is going to support, and what are your
-forbidden words and phrases. There are no rules here, just lists of allowed words and dictionaries.</p>
-<p>You may want to consider having a shared dictionary for your organizations custom lingo. You can do this through the
-dictionaryDefinitions key, but you'll have to export a txt file for reuse.</p>
+it's pretty powerful and lets you add words as the repository vocabulary grows.
+When using spelling here, you'll need to decide if there are words you want to
+support, what dictionaries your repository is going to support, and what are
+your forbidden words and phrases. There are no rules here, just lists of allowed
+words and dictionaries.</p>
+<p>You may want to consider having a shared dictionary for your organizations
+custom lingo. You can do this through the dictionaryDefinitions key, but you'll
+have to export a txt file for reuse.</p>
 <pre><code class="json"><span class="hl-0">// cspell.json</span><br/><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;version&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;0.1&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;$schema&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;language&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;en&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;words&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;errored&quot;</span><span class="hl-2">],</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;dictionaries&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;typescript&quot;</span><span class="hl-2">, </span><span class="hl-3">&quot;en_US&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
 </code><button type="button">Copy</button></pre>
-<a id="md:formatting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Formatting<a href="#md:formatting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Finally, and possibly most importantly, is code formatting consistency. There are generally two tools that are used for
-this.</p>
+<a id="md:formatting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Formatting<a href="#md:formatting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Finally, and possibly most importantly, is code formatting consistency. There
+are generally two tools that are used for this.</p>
 <ol>
 <li><a href="https://editorconfig.org/">EditorConfig</a></li>
 <li><a href="https://prettier.io/">Prettier</a></li>
 </ol>
-<p>For code formatting, Lint Janitor went with Prettier since it supports all the features of EditorConfig and a bunch of
-others. Prettier also supports shared configurations and is highly recommended to use them because the
-<a href="https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode">VisualStudio Code plugin</a> has support to
-auto format your files when you save them, making sure that your teams formatting is completely consistent.</p>
-<p>It's file lookup is similar to that of ESLint, but we recommended using .prettierrc.js to enable support for shared
-configurations.</p>
-<pre><code class="js"><span class="hl-0">//.prettierrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;@zthun/prettier-config&#39;</span><span class="hl-2">);</span>
+<p>For code formatting, Lint Janitor went with Prettier since it supports all the
+features of EditorConfig and a bunch of others. Prettier also supports shared
+configurations and is highly recommended to use them because the
+<a href="https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode">VisualStudio Code plugin</a>
+has support to auto format your files when you save them, making sure that your
+teams formatting is completely consistent.</p>
+<p>It's file lookup is similar to that of ESLint, but we recommended using
+.prettierrc.js to enable support for shared configurations.</p>
+<pre><code class="js"><span class="hl-0">//.prettierrc.js</span><br/><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/prettier-config&quot;</span><span class="hl-2">);</span>
 </code><button type="button">Copy</button></pre>
-<p>Options are <a href="https://prettier.io/docs/en/options.html">here</a>, and there's not a lot of them. See
-<a href="https://prettier.io/docs/en/option-philosophy.html">why</a>, as there's a good reason for this.</p>
-<p>When doing formatting linting, only the formatting is checked and you are notified if the files are formatted or
-unformatted. The best way to prevent these issues all together is to just use the Prettier IDE extension and auto format
-as you type.</p>
+<p>Options are <a href="https://prettier.io/docs/en/options.html">here</a>, and there's not a
+lot of them. See <a href="https://prettier.io/docs/en/option-philosophy.html">why</a>, as
+there's a good reason for this.</p>
+<p>When doing formatting linting, only the formatting is checked and you are
+notified if the files are formatted or unformatted. The best way to prevent
+these issues all together is to just use the Prettier IDE extension and auto
+format as you type.</p>
 <a id="md:faq" class="tsd-anchor"></a><h3 class="tsd-anchor-link">FAQ<a href="#md:faq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Q. Can this support my other favorite linter?</p>
-<p>A. Possibly, but whether or not Lint Janitor will bother at the moment depends on a few factors:</p>
+<p>A. Possibly, but whether or not Lint Janitor will bother at the moment depends
+on a few factors:</p>
 <ol>
-<li>Is there an IDE plugin that makes it so you can validate, lint, and cleanup while you go along so you're not left
-with a lot of surprises at the end?</li>
-<li>Does the linter support shared configuration to not reinvent the wheel everywhere? Does Lint Janitor have to bridge
-that gap?</li>
-<li>Is the linter in question a node linter that has its API exported and can be integrated into a node application?
-<strong>Important!</strong></li>
+<li>Is there an IDE plugin that makes it so you can validate, lint, and cleanup
+while you go along so you're not left with a lot of surprises at the end?</li>
+<li>Does the linter support shared configuration to not reinvent the wheel
+everywhere? Does Lint Janitor have to bridge that gap?</li>
+<li>Is the linter in question a node linter that has its API exported and can be
+integrated into a node application? <strong>Important!</strong></li>
 </ol>
-<p>If you answered No to the last question, then the answer is No. Lint Janitor does not invoke external command lines of
-linters and instead calls into their node API directly. This is how Lint Janitor succeeds in not having you worry about
-what tools to install and what versions to use; it uses transitive dependencies.</p>
-<p>If the last question is a Yes, then it becomes a question of, is it worth it? That'll need to be prioritized. For the
-most part, using <a href="https://prettier.io/">Prettier</a> takes care of almost all linting issues so you may not need more than
-what is available here. If you need the mother of all linters, there is the heavy
-<a href="https://github.com/nvuillam/mega-linter">Mega Linter</a> which aggregates every linter in existence. Very cool, but a bit
-overkill for the solution we are trying to solve with Lint Janitor.</p>
+<p>If you answered No to the last question, then the answer is No. Lint Janitor
+does not invoke external command lines of linters and instead calls into their
+node API directly. This is how Lint Janitor succeeds in not having you worry
+about what tools to install and what versions to use; it uses transitive
+dependencies.</p>
+<p>If the last question is a Yes, then it becomes a question of, is it worth it?
+That'll need to be prioritized. For the most part, using
+<a href="https://prettier.io/">Prettier</a> takes care of almost all linting issues so you
+may not need more than what is available here. If you need the mother of all
+linters, there is the heavy
+<a href="https://github.com/nvuillam/mega-linter">Mega Linter</a> which aggregates every
+linter in existence. Very cool, but a bit overkill for the solution we are
+trying to solve with Lint Janitor.</p>
 <p>Q. Is there an IDE plugin for Lint Janitor?</p>
-<p>A. Not yet. That would solve the issue of wanting an IDE plugin for each individual linter and would allow you to just
-have a single lint-janitor.config.js file at the root of your repository that would handle all linting needs. There is
-one planned, but it still need to be researched and scoped out.</p>
+<p>A. Not yet. That would solve the issue of wanting an IDE plugin for each
+individual linter and would allow you to just have a single
+lint-janitor.config.js file at the root of your repository that would handle all
+linting needs. There is one planned, but it still need to be researched and
+scoped out.</p>
 </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_lint_janitor.ZConfigExtender.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZConfig<wbr/>Extender</span></a>
 <a href="../classes/_zthun_lint_janitor.ZConfigReaderCosmic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZConfig<wbr/>Reader<wbr/>Cosmic</span></a>
 <a href="../classes/_zthun_lint_janitor.ZConfigReaderNull.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZConfig<wbr/>Reader<wbr/>Null</span></a>

package/dist/modules/_zthun_lint_janitor_config.html CHANGED Viewed

@@ -1,5 +1,6 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/lint-janitor-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" />
-</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_lint_janitor_config.html">@zthun/lint-janitor-config</a></li></ul><h1>Module @zthun/lint-janitor-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:lint-janitor-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Lint Janitor Config<a href="#md:lint-janitor-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 a shared configuration for lint-janitor that contains all of the zthun scoped shared configurations.</p>
+</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_lint_janitor_config.html">@zthun/lint-janitor-config</a></li></ul><h1>Module @zthun/lint-janitor-config</h1></div><section class="tsd-panel tsd-typography"><a id="md:lint-janitor-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Lint Janitor Config<a href="#md:lint-janitor-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 a shared configuration for lint-janitor that contains all of the zthun
+scoped shared configurations.</p>
 <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/lint-janitor</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor-config</span><span class="hl-2"> </span><span class="hl-4">--save-dev</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor</span><span class="hl-2"> </span><span class="hl-3">@zthun/lint-janitor-config</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
 </code><button type="button">Copy</button></pre>

package/dist/modules/_zthun_markdownlint_config.html CHANGED Viewed

@@ -7,9 +7,10 @@
 <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: [</span><span class="hl-3">&quot;@zthun/markdownlint-config&quot;</span><span class="hl-2">]</span><br/><span class="hl-2">}</span>
 </code><button type="button">Copy</button></pre>
-<p>That's it. You now have the recommended rules for zthun scoped projects when using lint-janitor.</p>
-<p>If you are using the Atom or VSCode plugin, it may not recognize the imported js configuration style. Instead, you can
-use the provided as-json.json file.</p>
+<p>That's it. You now have the recommended rules for zthun scoped projects when
+using lint-janitor.</p>
+<p>If you are using the Atom or VSCode plugin, it may not recognize the imported js
+configuration style. Instead, you can use the provided as-json.json file.</p>
 <pre><code class="json"><span class="hl-2">{</span><br/><span class="hl-2">  </span><span class="hl-5">&quot;extends&quot;</span><span class="hl-2">: </span><span class="hl-3">&quot;@zthun/markdownlint-config/as-json.json&quot;</span><br/><span class="hl-2">}</span>
 </code><button type="button">Copy</button></pre>

package/dist/modules/_zthun_prettier_config.html CHANGED Viewed

@@ -4,7 +4,7 @@
 </code><button type="button">Copy</button></pre>
 <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>Use the prettier shared config convention.</p>
-<pre><code class="js"><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;@zthun/prettier-config&#39;</span><span class="hl-2">);</span>
+<pre><code class="js"><span class="hl-7">module</span><span class="hl-2">.</span><span class="hl-7">exports</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;@zthun/prettier-config&quot;</span><span class="hl-2">);</span>
 </code><button type="button">Copy</button></pre>
 <p>That's it.</p>

package/dist/modules/_zthun_stylelint_config_less.html CHANGED Viewed

@@ -1,5 +1,6 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/stylelint-config-less | 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" />
-</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_stylelint_config_less.html">@zthun/stylelint-config-less</a></li></ul><h1>Module @zthun/stylelint-config-less</h1></div><section class="tsd-panel tsd-typography"><a id="md:stylelint-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">StyleLint Config<a href="#md:stylelint-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 stylelint configuration for zthun scoped projects using sass instead of raw css.</p>
+</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_stylelint_config_less.html">@zthun/stylelint-config-less</a></li></ul><h1>Module @zthun/stylelint-config-less</h1></div><section class="tsd-panel tsd-typography"><a id="md:stylelint-config" class="tsd-anchor"></a><h1 class="tsd-anchor-link">StyleLint Config<a href="#md:stylelint-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 stylelint configuration for zthun scoped projects using sass
+instead of raw css.</p>
 <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/stylelint-config-sass</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/stylelint-config-sass</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
 </code><button type="button">Copy</button></pre>