@temir.ra/create-ts-lib 0.11.0 → 0.12.0-pre.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Version 0
 
+## 0.12.0-pre.1
+
+1. Refactored `scripts/build-bundle.ts` to use an import map plugin instead of a CDN rewrite plugin.
+
+## 0.11.1
+
+1. Updated from `template@0.4.1` template.
+
 ## 0.11.0
 
 1. Synced template files with `workspace@0.7.0-pre.1` template.

package/README.md

@@ -8,7 +8,7 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
 2. [Documentation](#documentation)
     1. [`package.json`](#packagejson)
     2. [Script `scripts/build-bundle.ts`](#script-scriptsbuild-bundlets)
-        1. [CDN Map `scripts/cdn-rewrite-map.json`](#cdn-map-scriptscdn-rewrite-mapjson)
+        1. [Import Map `scripts/import-map.json`](#import-map-scriptsimport-mapjson)
     3. [`tsconfig.build.json`](#tsconfigbuildjson)
     4. [Asset Resolution](#asset-resolution)
         1. [Externalized - loaded from CDN or `node_modules/`](#externalized---loaded-from-cdn-or-node_modules)
@@ -38,7 +38,7 @@ npm create --no-install --no-git "@temir.ra/ts-lib@latest" .
 
 # set metadata in package.json
 
-npm install
+npm update
 ```
 
 # Documentation
@@ -75,7 +75,7 @@ The following fields are specific to this template:
   "files": [
     "scripts/buildinfo.ts",
     "scripts/build-bundle.ts",
-    "scripts/cdn-rewrite-map.json",
+    "scripts/import-map.json",
     "CHANGELOG.md",
     "buildinfo.txt",
     "dist/",
@@ -157,17 +157,22 @@ The following fields are specific to this template:
 
 Bundles the library to ESM and IIFE formats using `esbuild`. Entry points are resolved from the `entrypoint` condition in the `exports` field of `package.json`. Note, the `entrypoint` condition is a custom, non-standard export condition used solely for build tooling.
 
-Import specifiers can be rewritten to CDN URLs via `scripts/cdn-rewrite-map.json`.
+Import specifiers can be mapped to CDN URLs or marked as external via `scripts/import-map.json`.
+
+### Import Map `scripts/import-map.json`
 
-### CDN Map `scripts/cdn-rewrite-map.json`
+Maps import specifiers to CDN URLs or marks them as external without rewriting. During bundling, matching specifiers in source files are resolved according to the map.
 
-Maps import specifiers to CDN URLs. During bundling, matching specifiers in source files are rewritten to their CDN equivalents.
+- **Truthy value**: rewrites the import to the given URL and marks it external.
+- **Falsy value**: marks the import external without rewriting; the original specifier is preserved.
 
 `<VERSION>` in a URL is replaced with the version of the matching package from `package.json`.
 
 ```json
 {
-  "import-specifier": "https://cdn.jsdelivr.net/npm/package-name@<VERSION>/dist/index.bundle.js"
+  "rewrite-package": "https://cdn.jsdelivr.net/npm/rewrite-package@<VERSION>/dist/index.js",
+  "rewrite-package-without-version": "https://cdn.jsdelivr.net/npm/rewrite-package/dist/index.js",
+  "external-only-package": null
 }
 ```
 
@@ -450,6 +455,13 @@ npmx tsx dist/cli.bundle.js -- example/
 @temir.ra:registry=https://registry.npmjs.org/
 ```
 
+`~/.bunfig.toml` or `bunfig.toml`:
+
+```toml
+[install.scopes]
+"temir.ra" = { url = "https://registry.npmjs.org/" }
+```
+
 ```bash
 # registry.npmjs.org/
 npm login

package/buildinfo.txt

@@ -1 +1 @@
-0.11.0+6625dc3
+0.12.0-pre.1+78f65d1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-ts-lib",
-  "version": "0.11.0",
+  "version": "0.12.0-pre.1",
   "description": "A template for a distributable TypeScript library package.",
   "private": false,
   "keywords": [

package/template/README.md

@@ -24,11 +24,11 @@
 npm install
 npm update
 
-npm run dev
-
 npm run clean
 npm run build
 npm run tests
+
+npm run dev
 ```
 
 ## Change Management

package/template/package.json

@@ -16,7 +16,7 @@
   "files": [
     "scripts/buildinfo.ts",
     "scripts/build-bundle.ts",
-    "scripts/cdn-rewrite-map.json",
+    "scripts/import-map.json",
     "CHANGELOG.md",
     "buildinfo.txt",
     "dist/",

package/template/scripts/build-bundle.ts

@@ -11,7 +11,7 @@ import {
     type BuildResult
 } from 'esbuild';
 
-import CDN_REWRITE_MAP from './cdn-rewrite-map.json';
+import IMPORT_MAP from './import-map.json';
 
 
 interface ExportConditions {
@@ -122,20 +122,20 @@ const esbuildLog: EsbuildPlugin = {
         });
     }
 }
-const cdnRewrite: EsbuildPlugin = {
-    name: 'cdn-rewrite',
+const importMap: EsbuildPlugin = {
+    name: 'import-map',
     setup(build: PluginBuild) {
 
-        for (const [importSpecifier, urlTemplate] of Object.entries(CDN_REWRITE_MAP) as [string, string][]) {
+        for (const [importSpecifier, urlTemplate] of Object.entries(IMPORT_MAP) as [string, string | null][]) {
 
-            const url = resolveVersionInCdnUrl(importSpecifier, urlTemplate);
-            console.log(`[cdn-rewrite plugin] '${importSpecifier}' → '${url}'`);
+            const url = urlTemplate ? resolveVersionInCdnUrl(importSpecifier, urlTemplate) : null;
+            console.log(`[import-map plugin] '${importSpecifier}' → ${url ? `'${url}'` : 'external (no rewrite)'}`);
 
             const escapedSpecifier = importSpecifier.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
             build.onResolve(
                 { filter: new RegExp(`^${escapedSpecifier}$`) },
                 (args: OnResolveArgs): OnResolveResult | undefined => {
-                    return { path: url, external: true };
+                    return { path: url ?? args.path, external: true };
                 }
             );
 
@@ -157,7 +157,7 @@ const buildOptions: BuildOptions = {
     bundle: true,
     minify: true,
     sourcemap: 'external',
-    plugins: [esbuildLog, cdnRewrite],
+    plugins: [esbuildLog, importMap],
 
 };
 

package/template/scripts/import-map.json

@@ -0,0 +1 @@
+{}

package/template/scripts/cdn-rewrite-map.json

@@ -1 +0,0 @@
-{}