Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@typhonrt
typhonrt committed Mar 2, 2024
1 parent ae1da13 commit c001c9d
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<a href="https://typhonjs-node-build-test.github.io/esm-d-ts/"><img src="https://img.shields.io/badge/API%20Documentation-476ff0" alt="API Docs"></a>
<a href="https://typhonjs.io/discord/"><img src="https://img.shields.io/discord/737953117999726592?label=Discord%20-%20TyphonJS&amp;style=plastic" alt="Discord"></a>
<a href="https://www.twitch.tv/typhonrt"><img src="https://img.shields.io/twitch/status/typhonrt?style=social" alt="Twitch"></a></p>
<p>This is a beta test version of the next mainline release (<code>0.3.0-next.1</code>). There are many new features to describe
(updated README soon)!</p>
<p>Provides a modern battle tested near zero configuration tool for ESM / ES Module / Javascript developers to generate
bundled Typescript declarations from ESM source code utilizing typed <code>JSDoc</code>. This tooling can be employed to build
types for a primary export and one or more sub-path <a href="https://nodejs.org/api/packages.html#exports">exports</a> creating
Expand All @@ -15,16 +17,16 @@
<a href="https://nodejs.org/api/packages.html#imports">imports</a> / import conditions in a variety of flexible ways.</p>
<p><a href="https://typhonjs-node-build-test.github.io/esm-d-ts/">API documentation</a></p>
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation:</a></h2><p>It is recommended to install <code>esm-d-ts</code> as a developer dependency in <code>package.json</code> as follows:</p>
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-build-test/esm-d-ts"</span><span class="hl-0">: </span><span class="hl-2">"^0.3.0"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-build-test/esm-d-ts"</span><span class="hl-0">: </span><span class="hl-2">"^0.3.0-next.1"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
</code><button>Copy</button></pre>
<p>Presently the CLI and <code>esm-d-ts</code> can not be installed or used globally; this will be addressed in a future update.</p>
<a id="md:what39s-new" class="tsd-anchor"></a><h2><a href="#md:what39s-new">What's New:</a></h2><a id="md:030" class="tsd-anchor"></a><h3><a href="#md:030">(0.3.0):</a></h3><ul>
<li>Added plugin support for alternate file formats that support ES Modules. The first plugin available adds support for
ESM Svelte components (<code>.svelte</code> files). For more information on ESM Svelte component support please see:
<a href="https://www.npmjs.com/package/@typhonjs-build-test/esm-d-ts-plugin-svelte">@typhonjs-build-test/esm-d-ts-plugin-svelte</a>.
Eventually, the plugin system may be opened to 3rd party extensions along with additional 1st party support for
alternate file formats / frameworks that are ESM compatible. Presently, compatible 1st party plugins simply need to be
installed as additional developer dependencies and load automatically.</li>
<a id="md:what39s-new" class="tsd-anchor"></a><h2><a href="#md:what39s-new">What's New:</a></h2><a id="md:030-next1--partial-list" class="tsd-anchor"></a><h3><a href="#md:030-next1--partial-list">(0.3.0-next.1 / partial list):</a></h3><ul>
<li><p>Support for Typescript projects; easily generate bundled type declarations for TS projects including all file types
TS supports.</p>
</li>
<li><p>(soon) Added plugin support for alternate file formats that support ES Modules. The first plugin available adds support for
ESM Svelte components (<code>.svelte</code> files).</p>
</li>
</ul>
<a id="md:overview" class="tsd-anchor"></a><h2><a href="#md:overview">Overview:</a></h2><p>There is a lot to unpack regarding how to set up a modern ESM Node package for efficient distribution that includes
TS declarations. At this time I'll point to the Typescript <a href="https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html">JSDoc informational resources</a>
Expand Down Expand Up @@ -146,4 +148,4 @@
<li><a href="https://www.npmjs.com/package/rollup-plugin-dts">rollup-plugin-dts</a> - <a href="https://github.com/Swatinem">Arpad Borsos</a></li>
<li><a href="https://www.npmjs.com/package/resolve.exports">resolve.exports</a> - <a href="https://github.com/lukeed">Luke Edwards</a></li>
</ul>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><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-protected" name="protected" 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>Protected</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-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" tabindex="-1"><ul><li><ul><li><a href="#md:installation"><span>Installation:</span></a></li><li><ul><li><a href="#md:what39s-new"><span>What's <wbr>New:</span></a></li><li><ul><li><a href="#md:030"><span>(0.3.0):</span></a></li></ul></li><li><a href="#md:overview"><span>Overview:</span></a></li><li><a href="#md:example-use-cases"><span>Example use cases:</span></a></li><li><ul><li><a href="#md:cli"><span>CLI</span></a></li><li><a href="#md:programmatic-usage"><span>Programmatic <wbr>Usage</span></a></li><li><a href="#md:rollup-plugin"><span>Rollup <wbr>Plugin</span></a></li></ul></li><li><a href="#md:advanced-configuration"><span>Advanced <wbr>Configuration</span></a></li><li><a href="#md:caveats"><span>Caveats</span></a></li><li><a href="#md:synergies"><span>Synergies</span></a></li><li><a href="#md:roadmap"><span>Roadmap</span></a></li><li><a href="#md:appreciation"><span>Appreciation</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@typhonjs-build-test/esm-d-ts</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li><a href="modules/_typhonjs_build_test_esm_d_ts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_postprocess.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/postprocess</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_transformer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/transformer</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_util.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/util</a></li></ul></nav></div></div></div><div class="overlay"></div></body></html>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><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-protected" name="protected" 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>Protected</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-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" tabindex="-1"><ul><li><ul><li><a href="#md:installation"><span>Installation:</span></a></li><li><ul><li><a href="#md:what39s-new"><span>What's <wbr>New:</span></a></li><li><ul><li><a href="#md:030-next1--partial-list"><span>(0.3.0-<wbr>next.1 / partial list):</span></a></li></ul></li><li><a href="#md:overview"><span>Overview:</span></a></li><li><a href="#md:example-use-cases"><span>Example use cases:</span></a></li><li><ul><li><a href="#md:cli"><span>CLI</span></a></li><li><a href="#md:programmatic-usage"><span>Programmatic <wbr>Usage</span></a></li><li><a href="#md:rollup-plugin"><span>Rollup <wbr>Plugin</span></a></li></ul></li><li><a href="#md:advanced-configuration"><span>Advanced <wbr>Configuration</span></a></li><li><a href="#md:caveats"><span>Caveats</span></a></li><li><a href="#md:synergies"><span>Synergies</span></a></li><li><a href="#md:roadmap"><span>Roadmap</span></a></li><li><a href="#md:appreciation"><span>Appreciation</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@typhonjs-build-test/esm-d-ts</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li><a href="modules/_typhonjs_build_test_esm_d_ts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_postprocess.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/postprocess</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_transformer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/transformer</a></li><li><a href="modules/_typhonjs_build_test_esm_d_ts_util.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg>@typhonjs-build-test/esm-d-ts/util</a></li></ul></nav></div></div></div><div class="overlay"></div></body></html>

0 comments on commit c001c9d

Please sign in to comment.