updated docs

cptpiepmatz · Jun 24, 2022 · 9fce1ce · 9fce1ce
1 parent 4e7306b
commit 9fce1ce
Show file tree

Hide file tree

Showing 34 changed files with 186 additions and 145 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -13,7 +13,7 @@
     --dark-hl-5: #569CD6;
     --light-hl-6: #795E26;
     --dark-hl-6: #DCDCAA;
-    --light-code-background: #FFFFFF;
+    --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
 

diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -152,6 +152,15 @@ body.dark {
     --external-icon: var(--dark-external-icon);
 }
 
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+    line-height: 1.2;
+}
+
 h1 {
     font-size: 2em;
     margin: 0.67em 0;
@@ -757,12 +766,13 @@ footer .tsd-legend {
 
 .tsd-flag {
     display: inline-block;
-    padding: 1px 5px;
+    padding: 0.25em 0.4em;
     border-radius: 4px;
     color: var(--color-comment-tag-text);
     background-color: var(--color-comment-tag);
     text-indent: 0;
-    font-size: 14px;
+    font-size: 75%;
+    line-height: 1;
     font-weight: normal;
 }
 
@@ -1386,3 +1396,19 @@ input[type="checkbox"]:checked + .tsd-widget:before {
 img {
     max-width: 100%;
 }
+
+.tsd-anchor-icon {
+    margin-left: 10px;
+    vertical-align: middle;
+    color: var(--color-text);
+}
+
+.tsd-anchor-icon svg {
+    width: 1em;
+    height: 1em;
+    visibility: hidden;
+}
+
+.tsd-anchor-link:hover > .tsd-anchor-icon svg {
+    visibility: visible;
+}
diff --git a/docs/classes/FileManager.html b/docs/classes/FileManager.html
diff --git a/docs/classes/Import.html b/docs/classes/Import.html
diff --git a/docs/classes/ImportIntegrator.html b/docs/classes/ImportIntegrator.html
diff --git a/docs/classes/ImportSeparator.html b/docs/classes/ImportSeparator.html
diff --git a/docs/classes/ImportSorter.html b/docs/classes/ImportSorter.html
diff --git a/docs/classes/config.ConfigHandler.html b/docs/classes/config.ConfigHandler.html
diff --git a/docs/classes/config.OnDemandTranspiler.html b/docs/classes/config.OnDemandTranspiler.html
diff --git a/docs/classes/error.CLIOptionsError.html b/docs/classes/error.CLIOptionsError.html
diff --git a/docs/classes/error.IntegrationError.html b/docs/classes/error.IntegrationError.html
diff --git a/docs/classes/error.InvalidConfigError.html b/docs/classes/error.InvalidConfigError.html
diff --git a/docs/classes/error.MissingFileError.html b/docs/classes/error.MissingFileError.html
diff --git a/docs/classes/error.OnDemandTranspileError.html b/docs/classes/error.OnDemandTranspileError.html
diff --git a/docs/classes/error.UnsupportedFileFormatError.html b/docs/classes/error.UnsupportedFileFormatError.html
diff --git a/docs/enums/config.SupportedConfigFormat.html b/docs/enums/config.SupportedConfigFormat.html
diff --git a/docs/index.html b/docs/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>pretty-ts-imports (a.k.a. primp)</title><meta name="description" content="Documentation for pretty-ts-imports (a.k.a. primp)"/><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 async src="assets/search.js" id="search-script"></script>	<link rel="icon" href="primp.favicon.png" />
-</head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">pretty-ts-imports (a.k.a. primp)</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>pretty-ts-imports (a.k.a. primp)</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p align="center">
+</head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">pretty-ts-imports (a.k.a. primp)</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>pretty-ts-imports (a.k.a. primp) </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p align="center">
   <picture>
     <source srcset="media/primp.svg">
     <source srcset="./icon/primp.svg">

diff --git a/docs/interfaces/FormattingOptions.html b/docs/interfaces/FormattingOptions.html
diff --git a/docs/interfaces/ImportCompareFunction.html b/docs/interfaces/ImportCompareFunction.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImportCompareFunction | pretty-ts-imports (a.k.a. primp)</title><meta name="description" content="Documentation for pretty-ts-imports (a.k.a. primp)"/><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 async src="../assets/search.js" id="search-script"></script>	<link rel="icon" href="../primp.favicon.png" />
-</head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">pretty-ts-imports (a.k.a. primp)</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">pretty-ts-imports (a.k.a. primp)</a></li><li><a href="ImportCompareFunction.html">ImportCompareFunction</a></li></ul><h1>Interface ImportCompareFunction</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ImportCompareFunction</span></li></ul></section><section class="tsd-panel"><h3 class="tsd-before-signature">Callable</h3><ul class="tsd-signatures tsd-kind-interface"><li class="tsd-signature tsd-kind-icon">Import<wbr/>Compare<wbr/>Function<span class="tsd-signature-symbol">(</span>importA<span class="tsd-signature-symbol">: </span><a href="../classes/Import.html" class="tsd-signature-type" data-tsd-kind="Class">Import</a>, importB<span class="tsd-signature-symbol">: </span><a href="../classes/Import.html" class="tsd-signature-type" data-tsd-kind="Class">Import</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/cptpiepmatz/pretty-ts-imports/blob/19aab2b/src/sort_rules/ImportCompareFunction.ts#L16">src/sort_rules/ImportCompareFunction.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">pretty-ts-imports (a.k.a. primp)</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">pretty-ts-imports (a.k.a. primp)</a></li><li><a href="ImportCompareFunction.html">ImportCompareFunction</a></li></ul><h1>Interface ImportCompareFunction </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ImportCompareFunction</span></li></ul></section><section class="tsd-panel"><h3 class="tsd-before-signature">Callable</h3><ul class="tsd-signatures tsd-kind-interface"><li class="tsd-signature tsd-kind-icon">Import<wbr/>Compare<wbr/>Function<span class="tsd-signature-symbol">(</span>importA<span class="tsd-signature-symbol">: </span><a href="../classes/Import.html" class="tsd-signature-type" data-tsd-kind="Class">Import</a>, importB<span class="tsd-signature-symbol">: </span><a href="../classes/Import.html" class="tsd-signature-type" data-tsd-kind="Class">Import</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/cptpiepmatz/pretty-ts-imports/blob/4e7306b/src/sort_rules/ImportCompareFunction.ts#L16">src/sort_rules/ImportCompareFunction.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Compare function.
 Takes two Import objects and compares them.
 The return value 0 may also be that the compare function can&#39;t decide.</p>