@temir.ra/create-ts-lib 0.2.4 → 0.2.6

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Version 0
 
+## 0.2.6
+
+1. Minor ToC and typo fixes in both README.md files (root and template).
+2. Revised the Publish section in both README.md files.
+
+## 0.2.5
+
+1. Minor README updates.
+2. Fixed `buildinfo.txt` in published package.
+3. Fixed `buildinfo.test.ts` regex to accept semver prerelease identifiers.
+
 ## 0.2.4
 
 1. Documented template caching in the Quick Start section with commands to pin the version or clear the cache.

package/README.md

@@ -23,9 +23,8 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
     8. [`src/dev.ts`](#srcdevts)
     9. [`CLAUDE.md` / `AGENTS.md`](#claudemd--agentsmd)
 3. [DevOps](#devops)
-    1. [Build](#build)
-    2. [Change Management](#change-management)
-    3. [Publish](#publish)
+    1. [Change Management](#change-management)
+    2. [Publish](#publish)
         1. [npmjs.org](#npmjsorg)
         2. [Custom registry](#custom-registry)
 
@@ -57,7 +56,7 @@ bun install
 
 # Documentation
 
-The following sections explain the configurations and conventions baked into the generated package. Useful when adapting the template to fit a specific library's needs.
+The following sections explain the configurations and conventions baked into the generated package. Useful when adapting the generated package to fit a specific library's needs.
 
 ## `tsconfig.json` and `tsconfig.build.json`
 
@@ -453,15 +452,25 @@ bun run dist/cli.bundle.js -- example
 4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
 5. Pull request the branch.
 6. After merge, run `bun run build`.
-7. Publish
+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`
 
-⚠️ Authenticate first: run `npm login` or configure `~/.npmrc` or `bunfig.toml` with an auth token.
+Publish to the public npm registry.
 
 ```powershell
+# authenticate
+npm login
+# publish
 bun publish --registry https://registry.npmjs.org/ --access public
 ```
 
@@ -474,14 +483,16 @@ bun publish --registry https://registry.npmjs.org/ --access public
     # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
 ```
 
-`bunfig.toml`:
+`~/.bunfig.toml` or `bunfig.toml`:
 
 ```toml
 [install.scopes]
-<SCOPE_WITHOUT_AT> = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
+"<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
 ```

package/buildinfo.txt

@@ -1 +1 @@
-0.2.3+0a2de3a
+0.2.6+2fc6757

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-ts-lib",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Typescript library template",
   "author": "temir.ra",
   "license": "MIT",

package/template/README.md

@@ -9,6 +9,8 @@
 3. [DevOps](#devops)
     1. [Change Management](#change-management)
     2. [Publish](#publish)
+        1. [npmjs.org](#npmjsorg)
+        2. [Custom registry](#custom-registry)
 
 # Quick Start
 
@@ -60,15 +62,25 @@ Copy `node_modules/@scope/lib-name/assets/` into your build output alongside the
 4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
 5. Pull request the branch.
 6. After merge, run `bun run build`.
-7. Publish
+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`
 
-⚠️ Authenticate first: run `npm login` or configure `~/.npmrc` or `bunfig.toml` with an auth token.
+Publish to the public npm registry.
 
 ```powershell
+# authenticate
+npm login
+# publish
 bun publish --registry https://registry.npmjs.org/ --access public
 ```
 
@@ -81,14 +93,16 @@ bun publish --registry https://registry.npmjs.org/ --access public
     # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
 ```
 
-`bunfig.toml`:
+`~/.bunfig.toml` or `bunfig.toml`:
 
 ```toml
 [install.scopes]
-<SCOPE_WITHOUT_AT> = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
+"<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
 ```

package/template/tests/buildinfo.test.ts

@@ -10,7 +10,7 @@ describe('buildInfo', () => {
     it('should follow semantic versioning format with optional commit hash', () => {
         const buildinfoPath = fileURLToPath(buildinfoUrl);
         const buildinfo = readFileSync(buildinfoPath, 'utf-8').trim();
-        expect(buildinfo).toMatch(/^\d+\.\d+\.\d+(\+[0-9a-f]+)?$/);
+        expect(buildinfo).toMatch(/^\d+\.\d+\.\d+(-[a-zA-Z0-9.-]+)?(\+[a-zA-Z0-9.-]+)?$/);
     });
 
     it('should not contain whitespace', () => {