@temir.ra/create-ts-lib 0.10.1 → 0.11.0-pre.8

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Version 0
 
+## 0.11.0-pre.6
+
+1. Synced template files with `workspace@0.7.0-pre.1` template.
+2. Added more constants exports.
+3. Refactored `buildinfo.test.ts`.
+4. Included `tests/` in the published files.
+5. Cleaned up minor `README.md` wording.
+6. Updated `README.md` to reflect recent changes and clarify documentation.
+7. Simplified the Publish section in the generated README, as the registry configuration steps are now covered in the `workspace` template README.
+
 ## 0.10.1
 
 1. Fixed missing build output files.

package/README.md

@@ -6,19 +6,6 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
 
 1. [Quick Start](#quick-start)
 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)
-    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)
-        2. [Bundled - absorbed into the consumer's output](#bundled---absorbed-into-the-consumers-output)
-        3. [Contract](#contract)
-            1. [Scoped assets directory convention](#scoped-assets-directory-convention)
-            2. [Accessing assets](#accessing-assets)
-            3. [README statement for library consumers](#readme-statement-for-library-consumers)
-            4. [When the library is bundled by the consumer](#when-the-library-is-bundled-by-the-consumer)
-    5. [`"bin"` field in `package.json`](#bin-field-in-packagejson)
 3. [DevOps](#devops)
     1. [Change Management](#change-management)
     2. [Publish](#publish)
@@ -27,13 +14,9 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
 
 ```bash
 # placeholder:
-    # <NEW_PACKAGE: <NEW_PACKAGE>
     # <TEMPLATE_PACKAGE_NAME: @temir.ra/create-ts-lib
     # <TEMPLATE_NAME: @temir.ra/ts-lib
 
-mkdir -p <NEW_PACKAGE>
-cd <NEW_PACKAGE>
-
 # print the latest version
 bun info "@temir.ra/create-ts-lib" version
 
@@ -52,7 +35,7 @@ The following sections explain the configurations and conventions baked into the
 The major addition compared to the [`workspace` template](https://www.npmjs.com/package/@temir.ra/create-workspace) is a build pipeline for distributing the library. Two build strategies are supported:
 
 - **Bundling** (`scripts/build-bundle.ts`) - bundles the library to ESM and IIFE formats using [`esbuild`](https://esbuild.github.io/).
-- **TSC compilation** (`tsconfig.build.json` + `build:tsc`) - compiles the library to declaration files and ESM JavaScript using [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
+- **TSC compilation** (`tsconfig.build.json` + `build:tsc`) - compiles the library to declaration files, and optionally ESM JavaScript, using [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
 
 Both strategies can be combined.
 
@@ -70,9 +53,25 @@ The following fields are specific to this template:
   // the package is anticipated to be published
   "private": false,
 
+  // ... ,
+
   // treats all .js files as ES modules; use .cjs extension for CommonJS files
   "type": "module",
 
+  // files to include in the published package
+  "files": [
+    "scripts/buildinfo.ts",
+    "scripts/build-bundle.ts",
+    "scripts/cdn-rewrite-map.json",
+    "CHANGELOG.md",
+    "buildinfo.txt",
+    "dist/",
+    "tests/"
+  ],
+
+  // CLI entry point
+  "bin": "./dist/cli.bundle.js",
+
   // package entry points
   // multiple entry points can be configured (".", "./module/", etc.)
   // 
@@ -92,27 +91,12 @@ The following fields are specific to this template:
     }
   },
 
-  // convenience alias for source-execution only - does NOT survive transpilation or bundling
-  // NOT for use in source files compiled by tsconfig.build.json
-  // the .js extension is required in import statements (nodenext compliance)
+  // convenience alias for source-execution only
+  // does NOT survive transpilation or bundling
   "imports": {
     "#src/*.js": "./src/*.ts"
   },
 
-  // CLI entry point
-  "bin": "./dist/cli.bundle.js",
-
-  // files to include in the published package
-  "files": [
-    "scripts/buildinfo.ts",
-    "scripts/build-bundle.ts",
-    "scripts/cdn-rewrite-map.json",
-    "CHANGELOG.md",
-    "buildinfo.txt",
-    "dist/",
-    "tests/"
-  ],
-
   "scripts": {
 
     // ... ,
@@ -121,22 +105,22 @@ The following fields are specific to this template:
     "clean:dist": "rm -rf dist/",
 
     // removes .tsbuildinfo files generated by TypeScript's incremental build feature
-    "clean:tsbuildinfo": "rm -f *.tsbuildinfo || true",
+    "clean:tsbuildinfo": "rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
 
     // convenience script to run the clean steps in sequence
-    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
+    "clean": "npm run clean:dist && npm run clean:tsbuildinfo",
 
     // discovers and runs test files
-    "tests": "bun test",
+    "tests": "node --import tsx --test tests/**/*.test.ts",
 
     // executed before build; generates buildinfo.txt
-    "prebuild": "bun run buildinfo",
+    "prebuild": "npm run buildinfo",
 
     // convenience script to run the build steps in sequence
-    "build": "bun run build:bundle && bun run build:tsc && bun run build:cli-bundle",
+    "build": "npm run build:bundle && npm run build:tsc && npm run build:cli-bundle",
 
     // bundles the library into ESM and IIFE formats for distribution
-    "build:bundle": "bun run scripts/build-bundle.ts",
+    "build:bundle": "npm run scripts/build-bundle.ts",
 
     // compiles the library to declaration files and ESM JavaScript in dist/
     "build:tsc": "tsc --project tsconfig.build.json",
@@ -147,19 +131,15 @@ The following fields are specific to this template:
   },
 
   "devDependencies": {
-    "@types/bun": "latest",
     "@types/node": "latest",
     "esbuild": "latest",
+    "tsx": "latest",
     "typescript": "^6.0.3"
   }
 
 }
 ```
 
-It is highly recommended to include `tests/` in the `files` field. Note, that `tests/` is not included by default in the generated `package.json`.
-
-`"@types/bun": "latest"` is required to run tests.
-
 ## Script `scripts/build-bundle.ts`
 
 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.
@@ -180,7 +160,7 @@ Maps import specifiers to CDN URLs. During bundling, matching specifiers in sour
 
 ## `tsconfig.build.json`
 
-`tsconfig.json` provided by [`workspace` template](https://www.npmjs.com/package/@temir.ra/create-workspace) is intended for development only. `tsconfig.build.json` extends it with settings for compiling the source files for distribution.
+`tsconfig.json` is intended for development only. `tsconfig.build.json` extends it with settings for compiling the source files for distribution.
 
 See [`workspace` template README](https://www.npmjs.com/package/@temir.ra/create-workspace#tsconfigjson) and [tsconfig.json](https://www.typescriptlang.org/tsconfig) for detailed explanations of all options.
 
@@ -348,20 +328,17 @@ const packageUrl = new URL('../', import.meta.url);
 const assetsUrl  = new URL('assets/<@SCOPE>/<LIB_NAME>/', packageUrl);
 
 // for `--target browser` and `--target node` (isomorphic)
+export { };
 const assetUrl = new URL('<ASSET>', assetsUrl);
 const asset = await fetch(assetUrl).then(response => response.body);
 
 // for `--target node` only
-import { readFile } from 'fs/promises';
-import { fileURLToPath } from 'url';
+import { readFile } from 'node:fs/promises';
 const assetUrl = new URL('<ASSET>', assetsUrl);
-const assetPath = fileURLToPath(assetUrl);
-const asset = await readFile(assetPath);
+const asset = await readFile(assetUrl, 'utf-8');
 ```
 
-The generated `./src/constants.ts` scaffolds the isomorphic approach and `./constants` is configured as an additional entry point in `package.json` for direct imports:
-
-⚠️ Beware that `import.meta.url` is replaced by `document.currentScript.src` during bundling in IIFE format since it is available only under ESM (research "import.meta vs document.currentScript.src").
+The generated `./src/constants.ts` scaffolds the isomorphic approach and `./constants` is configured as an additional entry point in `package.json` to preserve the `import.meta.url` usage in bundled scenarios:
 
 ```json
 {
@@ -379,6 +356,8 @@ The generated `./src/constants.ts` scaffolds the isomorphic approach and `./cons
 }
 ```
 
+⚠️ Beware that `import.meta.url` is replaced by `document.currentScript.src` during bundling in IIFE format since it is available only under ESM (research "import.meta.url vs document.currentScript.src").
+
 #### README statement for library consumers
 
 ```markdown
@@ -410,15 +389,16 @@ For CLI packages, add the following to `package.json`:
 {
   // ... ,
   "bin": "./dist/cli.bundle.js",
+  // ... ,
   "scripts": {
     // ... ,
-    "build": "... && bun run build:cli-bundle",
-    "build:cli-bundle": "bun build src/cli.ts --entry-naming \"[dir]/[name].bundle.[ext]\" --outdir dist --target node --format esm --minify --sourcemap=external"
+    "build": "... && npm run build:cli-bundle",
+    "build:cli-bundle": "esbuild src/cli.ts --outdir=dist --entry-names=[dir]/[name].bundle --platform=node --format=esm --bundle --minify --sourcemap=external"
   }
 }
 ```
 
-`src/cli.ts` must begin with a hashbang so the OS knows which interpreter to invoke when the binary is executed directly. Bun preserves it in the bundled output.
+`src/cli.ts` must begin with a hashbang so the OS knows which interpreter to invoke when the binary is executed directly.
 
 ```typescript
 #!/usr/bin/env node
@@ -429,16 +409,14 @@ If the package exports a CLI only and is not intended to be imported in other pa
 # DevOps
 
 ```bash
-bun update
-bun install
-
-bun run clean
-bun run build
-bun run tests
+npm update
+npm install
 
-bun run dist/cli.bundle.js -- example/
+npm run clean
+npm run build
+npm run tests
 
-# see publish section for publish instructions
+npmx tsx dist/cli.bundle.js -- example/
 ```
 
 ## Change Management
@@ -447,17 +425,15 @@ bun run dist/cli.bundle.js -- example/
 2. Make the changes and commit.
 3. Bump the version in [`package.json`](package.json).
 4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
-5. Pull request the branch.
+5. Pull-request the branch.
 6. Ensure package artifacts are current.
 7. Publish.
 
 ## Publish
 
-Publish to the public npm registry.
-
-```powershell
-# authenticate
+```bash
+# registry.npmjs.org/
 npm login
-# publish
-bun publish --registry https://registry.npmjs.org/ --access public
+
+npm publish --registry https://registry.npmjs.org/
 ```

package/buildinfo.txt

@@ -1 +1 @@
-0.10.1+3aaa006
+0.11.0-pre.8+3ebf4d9

package/dist/cli.bundle.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import{cpSync as a,readFileSync as g,renameSync as U,writeFileSync as d}from"node:fs";import{resolve as r}from"node:path";var n=new URL("../",import.meta.url),i=new URL("buildinfo.txt",n),u=new URL("dist/",n),l=new URL("template/",n),m=new URL("CHANGELOG.md",n),p=new URL("README.md",n);try{let t=process.argv[2];if(!t)throw new Error('First argument must be the package name (e.g. "my-package" or "@my-scope/my-package").');let o=t.replace(/\\/g,"/"),e=r(process.cwd(),o);a(l,e,{recursive:!0}),a(m,r(e,"CHANGELOG-template.md")),a(i,r(e,"buildinfo-template.txt")),a(p,r(e,"README-template.md"));let c=r(e,"package.json"),s=JSON.parse(g(c,"utf-8"));s.name=o,d(c,JSON.stringify(s,null,2)),U(r(e,"gitignore"),r(e,".gitignore")),console.log(`Template has been successfully instantiated at '${e}' with package name '${o}'.`)}catch(t){let o=t instanceof Error?t:new Error(String(t));console.error("Error:",o.message),process.exit(1)}
+import{cpSync as a,readFileSync as g,renameSync as U,writeFileSync as d}from"node:fs";import{resolve as r}from"node:path";var n=new URL("../",import.meta.url),i=new URL("README.md",n),l=new URL("CHANGELOG.md",n),m=new URL("buildinfo.txt",n),u=new URL("dist/",n),p=new URL("template/",n);try{let t=process.argv[2];if(!t)throw new Error('First argument must be the package name (e.g. "my-package" or "@my-scope/my-package").');let o=t.replace(/\\/g,"/"),e=r(process.cwd(),o);a(p,e,{recursive:!0}),a(l,r(e,"CHANGELOG-template.md")),a(m,r(e,"buildinfo-template.txt")),a(i,r(e,"README-template.md"));let c=r(e,"package.json"),s=JSON.parse(g(c,"utf-8"));s.name=o,d(c,JSON.stringify(s,null,2)),U(r(e,"gitignore"),r(e,".gitignore")),console.log(`Template has been successfully instantiated at '${e}' with package name '${o}'.`)}catch(t){let o=t instanceof Error?t:new Error(String(t));console.error("Error:",o.message),process.exit(1)}

package/dist/cli.bundle.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/cli.ts", "../src/constants.ts"],
-  "sourcesContent": ["#!/usr/bin/env node\r\n\r\nimport { cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';\r\nimport { resolve } from 'node:path';\r\nimport {\r\n    templateUrl,\r\n    changelogUrl,\r\n    buildinfoUrl,\r\n    readmeUrl\r\n} from './constants.js';\r\n\r\n\r\ntry {\r\n\r\n    const packageNameArgument = process.argv[2];\r\n    if (!packageNameArgument)\r\n        throw new Error('First argument must be the package name (e.g. \"my-package\" or \"@my-scope/my-package\").');\r\n    const packageName = packageNameArgument.replace(/\\\\/g, '/');\r\n\r\n    const destinationPath = resolve(process.cwd(), packageName);\r\n\r\n    cpSync(templateUrl, destinationPath, { recursive: true });\r\n    cpSync(changelogUrl, resolve(destinationPath, 'CHANGELOG-template.md'));\r\n    cpSync(buildinfoUrl, resolve(destinationPath, 'buildinfo-template.txt'));\r\n    cpSync(readmeUrl, resolve(destinationPath, 'README-template.md'));\r\n\r\n    const packageJsonPath = resolve(destinationPath, 'package.json');\r\n    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));\r\n    packageJson.name = packageName;\r\n    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));\r\n\r\n    renameSync(resolve(destinationPath, 'gitignore'), resolve(destinationPath, '.gitignore'));\r\n\r\n    console.log(`Template has been successfully instantiated at '${destinationPath}' with package name '${packageName}'.`);\r\n\r\n}\r\ncatch (error) {\r\n    const err = error instanceof Error ? error : new Error(String(error));\r\n    console.error('Error:', err.message);\r\n    process.exit(1);\r\n}\r\n", "export const packageUrl: URL = new URL('../', import.meta.url);\r\nexport const buildinfoUrl: URL = new URL('buildinfo.txt', packageUrl);\r\nexport const distUrl: URL = new URL('dist/', packageUrl);\r\n\r\nexport const templateUrl: URL = new URL('template/', packageUrl);\r\nexport const changelogUrl: URL = new URL('CHANGELOG.md', packageUrl);\r\nexport const readmeUrl: URL = new URL('README.md', packageUrl);\r\n"],
-  "mappings": ";AAEA,OAAS,UAAAA,EAAQ,gBAAAC,EAAc,cAAAC,EAAY,iBAAAC,MAAqB,UAChE,OAAS,WAAAC,MAAe,YCHjB,IAAMC,EAAkB,IAAI,IAAI,MAAO,YAAY,GAAG,EAChDC,EAAoB,IAAI,IAAI,gBAAiBD,CAAU,EACvDE,EAAe,IAAI,IAAI,QAASF,CAAU,EAE1CG,EAAmB,IAAI,IAAI,YAAaH,CAAU,EAClDI,EAAoB,IAAI,IAAI,eAAgBJ,CAAU,EACtDK,EAAiB,IAAI,IAAI,YAAaL,CAAU,EDM7D,GAAI,CAEA,IAAMM,EAAsB,QAAQ,KAAK,CAAC,EAC1C,GAAI,CAACA,EACD,MAAM,IAAI,MAAM,wFAAwF,EAC5G,IAAMC,EAAcD,EAAoB,QAAQ,MAAO,GAAG,EAEpDE,EAAkBC,EAAQ,QAAQ,IAAI,EAAGF,CAAW,EAE1DG,EAAOC,EAAaH,EAAiB,CAAE,UAAW,EAAK,CAAC,EACxDE,EAAOE,EAAcH,EAAQD,EAAiB,uBAAuB,CAAC,EACtEE,EAAOG,EAAcJ,EAAQD,EAAiB,wBAAwB,CAAC,EACvEE,EAAOI,EAAWL,EAAQD,EAAiB,oBAAoB,CAAC,EAEhE,IAAMO,EAAkBN,EAAQD,EAAiB,cAAc,EACzDQ,EAAc,KAAK,MAAMC,EAAaF,EAAiB,OAAO,CAAC,EACrEC,EAAY,KAAOT,EACnBW,EAAcH,EAAiB,KAAK,UAAUC,EAAa,KAAM,CAAC,CAAC,EAEnEG,EAAWV,EAAQD,EAAiB,WAAW,EAAGC,EAAQD,EAAiB,YAAY,CAAC,EAExF,QAAQ,IAAI,mDAAmDA,CAAe,wBAAwBD,CAAW,IAAI,CAEzH,OACOa,EAAO,CACV,IAAMC,EAAMD,aAAiB,MAAQA,EAAQ,IAAI,MAAM,OAAOA,CAAK,CAAC,EACpE,QAAQ,MAAM,SAAUC,EAAI,OAAO,EACnC,QAAQ,KAAK,CAAC,CAClB",
-  "names": ["cpSync", "readFileSync", "renameSync", "writeFileSync", "resolve", "packageUrl", "buildinfoUrl", "distUrl", "templateUrl", "changelogUrl", "readmeUrl", "packageNameArgument", "packageName", "destinationPath", "resolve", "cpSync", "templateUrl", "changelogUrl", "buildinfoUrl", "readmeUrl", "packageJsonPath", "packageJson", "readFileSync", "writeFileSync", "renameSync", "error", "err"]
+  "sourcesContent": ["#!/usr/bin/env node\r\n\r\nimport { cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';\r\nimport { resolve } from 'node:path';\r\nimport {\r\n    templateUrl,\r\n    changelogUrl,\r\n    buildinfoUrl,\r\n    readmeUrl\r\n} from './constants.js';\r\n\r\n\r\ntry {\r\n\r\n    const packageNameArgument = process.argv[2];\r\n    if (!packageNameArgument)\r\n        throw new Error('First argument must be the package name (e.g. \"my-package\" or \"@my-scope/my-package\").');\r\n    const packageName = packageNameArgument.replace(/\\\\/g, '/');\r\n\r\n    const destinationPath = resolve(process.cwd(), packageName);\r\n\r\n    cpSync(templateUrl, destinationPath, { recursive: true });\r\n    cpSync(changelogUrl, resolve(destinationPath, 'CHANGELOG-template.md'));\r\n    cpSync(buildinfoUrl, resolve(destinationPath, 'buildinfo-template.txt'));\r\n    cpSync(readmeUrl, resolve(destinationPath, 'README-template.md'));\r\n\r\n    const packageJsonPath = resolve(destinationPath, 'package.json');\r\n    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));\r\n    packageJson.name = packageName;\r\n    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));\r\n\r\n    renameSync(resolve(destinationPath, 'gitignore'), resolve(destinationPath, '.gitignore'));\r\n\r\n    console.log(`Template has been successfully instantiated at '${destinationPath}' with package name '${packageName}'.`);\r\n\r\n}\r\ncatch (error) {\r\n    const err = error instanceof Error ? error : new Error(String(error));\r\n    console.error('Error:', err.message);\r\n    process.exit(1);\r\n}\r\n", "export const packageUrl: URL = new URL('../', import.meta.url);\r\n\r\nexport const readmeUrl: URL = new URL('README.md', packageUrl);\r\nexport const changelogUrl: URL = new URL('CHANGELOG.md', packageUrl);\r\nexport const buildinfoUrl: URL = new URL('buildinfo.txt', packageUrl);\r\nexport const distUrl: URL = new URL('dist/', packageUrl);\r\n\r\nexport const templateUrl: URL = new URL('template/', packageUrl);\r\n"],
+  "mappings": ";AAEA,OAAS,UAAAA,EAAQ,gBAAAC,EAAc,cAAAC,EAAY,iBAAAC,MAAqB,UAChE,OAAS,WAAAC,MAAe,YCHjB,IAAMC,EAAkB,IAAI,IAAI,MAAO,YAAY,GAAG,EAEhDC,EAAiB,IAAI,IAAI,YAAaD,CAAU,EAChDE,EAAoB,IAAI,IAAI,eAAgBF,CAAU,EACtDG,EAAoB,IAAI,IAAI,gBAAiBH,CAAU,EACvDI,EAAe,IAAI,IAAI,QAASJ,CAAU,EAE1CK,EAAmB,IAAI,IAAI,YAAaL,CAAU,EDK/D,GAAI,CAEA,IAAMM,EAAsB,QAAQ,KAAK,CAAC,EAC1C,GAAI,CAACA,EACD,MAAM,IAAI,MAAM,wFAAwF,EAC5G,IAAMC,EAAcD,EAAoB,QAAQ,MAAO,GAAG,EAEpDE,EAAkBC,EAAQ,QAAQ,IAAI,EAAGF,CAAW,EAE1DG,EAAOC,EAAaH,EAAiB,CAAE,UAAW,EAAK,CAAC,EACxDE,EAAOE,EAAcH,EAAQD,EAAiB,uBAAuB,CAAC,EACtEE,EAAOG,EAAcJ,EAAQD,EAAiB,wBAAwB,CAAC,EACvEE,EAAOI,EAAWL,EAAQD,EAAiB,oBAAoB,CAAC,EAEhE,IAAMO,EAAkBN,EAAQD,EAAiB,cAAc,EACzDQ,EAAc,KAAK,MAAMC,EAAaF,EAAiB,OAAO,CAAC,EACrEC,EAAY,KAAOT,EACnBW,EAAcH,EAAiB,KAAK,UAAUC,EAAa,KAAM,CAAC,CAAC,EAEnEG,EAAWV,EAAQD,EAAiB,WAAW,EAAGC,EAAQD,EAAiB,YAAY,CAAC,EAExF,QAAQ,IAAI,mDAAmDA,CAAe,wBAAwBD,CAAW,IAAI,CAEzH,OACOa,EAAO,CACV,IAAMC,EAAMD,aAAiB,MAAQA,EAAQ,IAAI,MAAM,OAAOA,CAAK,CAAC,EACpE,QAAQ,MAAM,SAAUC,EAAI,OAAO,EACnC,QAAQ,KAAK,CAAC,CAClB",
+  "names": ["cpSync", "readFileSync", "renameSync", "writeFileSync", "resolve", "packageUrl", "readmeUrl", "changelogUrl", "buildinfoUrl", "distUrl", "templateUrl", "packageNameArgument", "packageName", "destinationPath", "resolve", "cpSync", "templateUrl", "changelogUrl", "buildinfoUrl", "readmeUrl", "packageJsonPath", "packageJson", "readFileSync", "writeFileSync", "renameSync", "error", "err"]
 }

package/package.json

@@ -1,48 +1,50 @@
-{
-  "name": "@temir.ra/create-ts-lib",
-  "version": "0.10.1",
-  "description": "A template for a distributable TypeScript library package.",
-  "author": "temir.ra",
-  "license": "MIT",
-  "keywords": [
-    "typescript",
-    "template",
-    "library"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://git.chimps.quest/trs/create-ts-lib.git"
-  },
-  "private": false,
-  "type": "module",
-  "imports": {
-    "#src/*.js": "./src/*.ts"
-  },
-  "bin": "./dist/cli.bundle.js",
-  "files": [
-    "scripts/buildinfo.ts",
-    "scripts/build-bundle.ts",
-    "scripts/cdn-rewrite-map.json",
-    "CHANGELOG.md",
-    "buildinfo.txt",
-    "dist/",
-    "template/"
-  ],
-  "scripts": {
-    "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",
-    "typecheck": "tsc --noEmit",
-    "buildinfo": "bun run scripts/buildinfo.ts",
-    "clean:dist": "rm -rf dist/",
-    "clean:tsbuildinfo": "rm -f *.tsbuildinfo || true",
-    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
-    "tests": "bun test",
-    "prebuild": "bun run buildinfo",
-    "build": "bun run build:cli-bundle",
-    "build:cli-bundle": "esbuild src/cli.ts --outdir=dist --entry-names=[dir]/[name].bundle --platform=node --format=esm --bundle --minify --sourcemap=external"
-  },
-  "devDependencies": {
-    "@types/node": "latest",
-    "esbuild": "latest",
-    "typescript": "^6.0.3"
-  }
+{
+  "name": "@temir.ra/create-ts-lib",
+  "version": "0.11.0-pre.8",
+  "description": "A template for a distributable TypeScript library package.",
+  "private": false,
+  "keywords": [
+    "typescript",
+    "template",
+    "library"
+  ],
+  "author": "temir.ra",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://git.chimps.quest/trs/create-ts-lib.git"
+  },
+  "type": "module",
+  "files": [
+    "scripts/buildinfo.ts",
+    "scripts/build-bundle.ts",
+    "scripts/cdn-rewrite-map.json",
+    "CHANGELOG.md",
+    "buildinfo.txt",
+    "dist/",
+    "tests/",
+    "template/"
+  ],
+  "bin": "./dist/cli.bundle.js",
+  "imports": {
+    "#src/*.js": "./src/*.ts"
+  },
+  "scripts": {
+    "reinstall": "shx rm -rf node_modules && shx rm -f package-lock.json bun.lock yarn.lock pnpm-lock.yaml && npm install",
+    "typecheck": "tsc --noEmit",
+    "buildinfo": "tsx scripts/buildinfo.ts",
+    "clean:dist": "shx rm -rf dist/",
+    "clean:tsbuildinfo": "shx rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
+    "clean": "npm run clean:dist && npm run clean:tsbuildinfo",
+    "tests": "node --import tsx --test tests/**/*.test.ts",
+    "prebuild": "npm run buildinfo",
+    "build": "npm run build:cli-bundle",
+    "build:cli-bundle": "esbuild src/cli.ts --outdir=dist --entry-names=[dir]/[name].bundle --platform=node --format=esm --bundle --minify --sourcemap=external"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "esbuild": "latest",
+    "tsx": "latest",
+    "typescript": "^6.0.3"
+  }
 }

package/template/README.md

@@ -9,8 +9,6 @@
 3. [DevOps](#devops)
     1. [Change Management](#change-management)
     2. [Publish](#publish)
-        1. [npmjs.org](#npmjsorg)
-        2. [Custom registry](#custom-registry)
 
 # Quick Start
 
@@ -23,16 +21,14 @@
 # DevOps
 
 ```bash
-bun update
-bun install
+npm update
+npm install
 
-bun run clean
-bun run build
-bun run tests
+npm run dev
 
-bun run --watch scripts/dev.ts
-
-# see publish section for publish instructions
+npm run clean
+npm run build
+npm run tests
 ```
 
 ## Change Management
@@ -41,51 +37,27 @@ bun run --watch scripts/dev.ts
 2. Make the changes and commit.
 3. Bump the version in [`package.json`](package.json).
 4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
-5. Pull request the branch.
+5. Pull-request the branch.
 6. Ensure package artifacts are current.
 7. Publish.
 
 ## Publish
 
-See the following sources to configure the target registry and authentication.
-
-- [Configuring npm - `npmrc`](https://docs.npmjs.com/cli/v10/configuring-npm/npmrc)
-- [Bun package manager - `install.registry`](https://bun.com/docs/runtime/bunfig#install-scopes)
-
-⚠️ Package Scope and the authentication for the target registry must be aligned.
-
-### `npmjs.org`
-
-Publish to the public npm registry.
-
-```powershell
-# authenticate
-npm login
-# publish
-bun publish --registry https://registry.npmjs.org/ --access public
-```
-
-### Custom registry
-
-Publish to a custom registry.
+Configure the scope registry as described in the [`workspace` template README](https://git.chimps.quest/trs/create-workspace#scope-registry).
 
 ```bash
 # placeholder:
-  # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-  # <REGISTRY_URL: <REGISTRY_URL>
-  # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
+  # <REGISTRY_AUTH_TOKEN_ENV_VAR: <REGISTRY_AUTH_TOKEN_ENV_VAR>
 ```
 
-`~/.bunfig.toml` or `bunfig.toml`:
+Authenticate with the registry:
 
-```toml
-[install.scopes]
-"<SCOPE_WITHOUT_AT>" = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
-```
-
-```powershell
-# authenticate
-$env:BUN_PUBLISH_AUTH_TOKEN = "<BUN_PUBLISH_AUTH_TOKEN>"
-# publish
-bun publish
+```bash
+# registry.npmjs.org/
+npm login
+# or custom registry
+export <REGISTRY_AUTH_TOKEN_ENV_VAR>=<AUTH_TOKEN>
+# or
+$env:<REGISTRY_AUTH_TOKEN_ENV_VAR> = "<AUTH_TOKEN>"
+npm publish
 ```

package/template/package.json

@@ -2,17 +2,26 @@
   "name": "",
   "version": "0.0.0",
   "description": "",
-  "author": "",
-  "license": "",
+  "private": false,
   "keywords": [
     "typescript"
   ],
+  "author": "",
+  "license": "",
   "repository": {
     "type": "git",
     "url": ""
   },
-  "private": false,
   "type": "module",
+  "files": [
+    "scripts/buildinfo.ts",
+    "scripts/build-bundle.ts",
+    "scripts/cdn-rewrite-map.json",
+    "CHANGELOG.md",
+    "buildinfo.txt",
+    "dist/",
+    "tests/"
+  ],
   "exports": {
     ".": {
       "entrypoint": "./src/index.ts",
@@ -30,30 +39,24 @@
   "imports": {
     "#src/*.js": "./src/*.ts"
   },
-  "files": [
-    "scripts/buildinfo.ts",
-    "scripts/build-bundle.ts",
-    "scripts/cdn-rewrite-map.json",
-    "CHANGELOG.md",
-    "buildinfo.txt",
-    "dist/"
-  ],
   "scripts": {
-    "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",
+    "reinstall": "rm -rf node_modules && rm -f package-lock.json bun.lock yarn.lock pnpm-lock.yaml && npm install",
     "typecheck": "tsc --noEmit",
-    "buildinfo": "bun run scripts/buildinfo.ts",
+    "buildinfo": "tsx scripts/buildinfo.ts",
+    "dev": "tsx --watch scripts/dev.ts",
     "clean:dist": "rm -rf dist/",
-    "clean:tsbuildinfo": "rm -f *.tsbuildinfo || true",
-    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
-    "tests": "bun test",
-    "prebuild": "bun run buildinfo",
-    "build": "bun run build:bundle && bun run build:tsc",
-    "build:bundle": "bun run scripts/build-bundle.ts",
+    "clean:tsbuildinfo": "rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
+    "clean": "npm run clean:dist && npm run clean:tsbuildinfo",
+    "tests": "node --import tsx --test tests/**/*.test.ts",
+    "prebuild": "npm run buildinfo",
+    "build": "npm run build:bundle && npm run build:tsc",
+    "build:bundle": "tsx scripts/build-bundle.ts",
     "build:tsc": "tsc --project tsconfig.build.json"
   },
   "devDependencies": {
     "@types/node": "latest",
     "esbuild": "latest",
+    "tsx": "latest",
     "typescript": "^6.0.3"
   }
 }

package/template/scripts/dev.ts

@@ -3,10 +3,10 @@ import { fileURLToPath } from 'node:url';
 
 const start: number = performance.now();
 
+
 const packageUrl = new URL('../', import.meta.url);
 console.log(`'packagePath':`, fileURLToPath(packageUrl));
 
-
 // dev scratchpad
 
 

package/template/src/constants.ts

@@ -1,3 +1,6 @@
 export const packageUrl: URL = new URL('../', import.meta.url);
+
+export const readmeUrl: URL = new URL('README.md', packageUrl);
+export const changelogUrl: URL = new URL('CHANGELOG.md', packageUrl);
 export const buildinfoUrl: URL = new URL('buildinfo.txt', packageUrl);
 export const distUrl: URL = new URL('dist/', packageUrl);

package/template/tests/buildinfo.test.ts

@@ -1,24 +1,26 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
-import { readFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
+import { existsSync, readFileSync } from 'node:fs';
+import { buildinfoUrl, packageUrl } from '#src/constants.js';
 
 
-const buildinfoUrl = new URL('../buildinfo.txt', import.meta.url);
-
 // https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
 // Captures: [1]=major, [2]=minor, [3]=patch, [4]=pre-release, [5]=build-metadata
 const SEMVER_REGEX =
     /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
 
-function readBuildinfo(): string {
-    return readFileSync(fileURLToPath(buildinfoUrl), 'utf-8').trim();
-}
 
 describe('buildinfo.txt', () => {
 
-    it('MUST contain a valid semver string', () => {
-        assert.match(readBuildinfo(), SEMVER_REGEX);
+    it('MUST exist at the specified location', async () => {
+        assert.ok(existsSync(buildinfoUrl));
+        assert.ok(!existsSync(new URL('wrong.txt', packageUrl)));
+    });
+
+    it('MUST contain a valid semver string', async () => {
+        const buildinfo = readFileSync(buildinfoUrl, 'utf-8');
+        assert.match(buildinfo, SEMVER_REGEX);
+        assert.doesNotMatch('version zwölf', SEMVER_REGEX);
     });
 
 });

package/template/tsconfig.json

@@ -3,8 +3,7 @@
     "target": "ESNext",
     "module": "ESNext",
     "lib": [
-      "ESNext",
-      "DOM"
+      "ESNext"
     ],
     "moduleResolution": "bundler",
     "strict": true,

package/tests/buildinfo.test.ts

@@ -0,0 +1,26 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+import { existsSync, readFileSync } from 'node:fs';
+import { buildinfoUrl, packageUrl } from '#src/constants.js';
+
+
+// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+// Captures: [1]=major, [2]=minor, [3]=patch, [4]=pre-release, [5]=build-metadata
+const SEMVER_REGEX =
+    /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+
+
+describe('buildinfo.txt', () => {
+
+    it('MUST exist at the specified location', async () => {
+        assert.ok(existsSync(buildinfoUrl));
+        assert.ok(!existsSync(new URL('wrong.txt', packageUrl)));
+    });
+
+    it('MUST contain a valid semver string', async () => {
+        const buildinfo = readFileSync(buildinfoUrl, 'utf-8');
+        assert.match(buildinfo, SEMVER_REGEX);
+        assert.doesNotMatch('version zwölf', SEMVER_REGEX);
+    });
+
+});