@tsmodule/tsmodule 40.0.6 → 40.0.9

package/README.md

@@ -11,20 +11,21 @@ modules** that target any platform.
 <!-- toc -->
 
 - [Installation](#installation)
-    + [Requirements](#requirements)
-    + [Existing projects](#existing-projects)
-    + [New projects](#new-projects)
+  * [Requirements (global)](#requirements-global)
+  * [Existing projects](#existing-projects)
+  * [New projects](#new-projects)
 - [Purpose](#purpose)
   * [Create ESM packages using TypeScript](#create-esm-packages-using-typescript)
   * [Develop projects in real-time](#develop-projects-in-real-time)
   * [Build to optimized ES modules](#build-to-optimized-es-modules)
-    + [Optimizing NPM dependencies with `-b, --bundle`](#optimizing-npm-dependencies-with--b---bundle)
+  * [Optimize NPM dependencies with `-b, --bundle`](#optimize-npm-dependencies-with--b---bundle)
   * [Run TypeScript directly](#run-typescript-directly)
 - [Use Cases](#use-cases)
   * [Generic TypeScript library](#generic-typescript-library)
   * [React component library (using Next.js)](#react-component-library-using-nextjs)
 - [Footnotes](#footnotes)
   * [Module configuration](#module-configuration)
+    + [Index exports](#index-exports)
     + [Package.json export](#packagejson-export)
 - [License](#license)
 
@@ -77,8 +78,8 @@ Ready out of the box:
 
 Build in dev mode and watch for changes:
 
-```shell
-$ tsmodule dev
+```
+tsmodule dev
 ```
 
 ### Build to optimized ES modules
@@ -86,8 +87,8 @@ $ tsmodule dev
 Production builds are minified ESM, with support for `my-package/a/b/c` path
 resolution (see [Module configuration](#module-configuration) below).
 
-```shell
-$ tsmodule build [--bundle]
+```
+tsmodule build [--bundle]
 ```
 
 **All projects:**
@@ -116,8 +117,8 @@ is more appropriate.</sub>
 
 ### Run TypeScript directly
 
-```shell
-$ tsmodule file.ts
+```
+tsmodule file.ts
 ```
 
   - Uses Node module loader to resolve TS at runtime
@@ -200,23 +201,32 @@ type-check and declaration emit:
 }
 ```
 
-And conditional exports in package.json will be configured like so, such that
-"index modules" at e.g. `src/test/index.ts` will be available at
-`my-package/test`:
+#### Index exports
+
+Conditional exports in package.json are configured such that "index
+exports" are available at a subpath. For example:
 
-```json
-{
-  "files": ["dist/"],
-  "exports": {
-    "./package.json": "./package.json",
-    "./": "./dist/index.js",
-    "./*": "./dist/*/index.js"
-  },
-}
 ```
+src/a/b/c/index.ts
+```
+
+Will be available downstream via:
+
+```ts
+import { c } from "your-package/a/b/c"
+```
+
+**Notes:**
+
+- Index exports are the only entry points available for import, are ones located
+at `src/**/index.ts(x?)`.<sup>1</sup>
+
+- The default package entry point for `your-package` is `src/index.ts`.
 
-This has no restriction on internal imports between files, only the default
-configuration for how downstream consumers can import from module subpaths.
+<sub><sup>1</sup> This has no restriction on internal imports between files,
+which can import from each other freely, including at runtime.
+However, consumers of your package will only be able to import from index
+exports as shown.<sub>
 
 #### Package.json export
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsmodule/tsmodule",
   "platform": "node",
   "type": "module",
-  "version": "40.0.6",
+  "version": "40.0.9",
   "repository": "tsmodule/tsmodule",
   "description": "TypeScript Module loader and compiler",
   "license": "MIT",