Skip to content

Commit

Permalink
adjusted package contents
Browse files Browse the repository at this point in the history
  • Loading branch information
kael-shipman committed Dec 29, 2023
1 parent bb95af6 commit 900c5c9
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.eslint*
.prettier*
.github
.husky
dist-test
githooks
tests
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ optional sources and merges it all into a single, type-checked config object.

### Primary features

* Sources include at least one of the following:
* Sources include any or all of the following:
* environment variables
* defaults JSON file (version-controlled)
* "locals" JSON file (non-version-controlled),
* docker secrets directory
* docker secrets directory (e.g., `/secrets`)
* Sources are combined in the following order: `defaults file < locals file < env < secrets dir`
* Variable names can contain numeric suffixes (`__001`, `__1`, etc.) for "secrets versioning"
(necessary for some orchestrators, including docker swarm). Variables are sorted in ascending
Expand All @@ -28,7 +28,7 @@ optional sources and merges it all into a single, type-checked config object.
* Values can contain explicit casts to guarantee type (e.g., `<string>3` results in the string `"3"`
* Pass a runtype type-checker in for automatic runtime type checking and fast-fail on errors. (Pass
a dummy type-checker in to bypass.)
* Supports arbitrary namespacing (`APP_`, `APP_CONFIG_`, `MYCNF_`, whatever)
* Supports arbitrary namespacing of env vars (`APP_`, `APP_CONFIG_`, `MYCNF_`, whatever)
* Optional changing of delimiter (defaults to `_`, very rarely needs to be changed).


Expand Down
2 changes: 1 addition & 1 deletion docs/functions/config.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
for an alternative simpler config system.</em></p>
</blockquote>
<a id="md:primary-features" class="tsd-anchor"></a><h3><a href="#md:primary-features">Primary features</a></h3><ul>
<li>Sources include at least one of the following:<ul>
<li>Sources include any or all of the following:<ul>
<li>environment variables</li>
<li>defaults JSON file (version-controlled)</li>
<li>&quot;locals&quot; JSON file (non-version-controlled),</li>
<li>docker secrets directory</li>
<li>docker secrets directory (e.g., <code>/secrets</code>)</li>
</ul>
</li>
<li>Sources are combined in the following order: <code>defaults file &lt; locals file &lt; env &lt; secrets dir</code></li>
Expand All @@ -23,7 +23,7 @@
<li>Values can contain explicit casts to guarantee type (e.g., <code>&lt;string&gt;3</code> results in the string <code>&quot;3&quot;</code></li>
<li>Pass a runtype type-checker in for automatic runtime type checking and fast-fail on errors. (Pass
a dummy type-checker in to bypass.)</li>
<li>Supports arbitrary namespacing (<code>APP_</code>, <code>APP_CONFIG_</code>, <code>MYCNF_</code>, whatever)</li>
<li>Supports arbitrary namespacing of env vars (<code>APP_</code>, <code>APP_CONFIG_</code>, <code>MYCNF_</code>, whatever)</li>
<li>Optional changing of delimiter (defaults to <code>_</code>, very rarely needs to be changed).</li>
</ul>
<a id="md:examples" class="tsd-anchor"></a><h3><a href="#md:examples">Examples</a></h3><p><strong>Common Use:</strong> Store default variables in a version-controlled <code>config.json</code> file and selectively
Expand Down

0 comments on commit 900c5c9

Please sign in to comment.