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

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Version 0
 
-## 0.11.0-pre.6
+## 0.11.0
 
 1. Synced template files with `workspace@0.7.0-pre.1` template.
 2. Added more constants exports.
@@ -8,7 +8,8 @@
 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.
+7. Refactored the Publish section in the `README.md` to include documentation scaffolding.
+8. Updated from `template@0.4.0-pre.9` template.
 
 ## 0.10.1
 

package/README.md

@@ -6,6 +6,19 @@ 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)
@@ -18,14 +31,14 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
     # <TEMPLATE_NAME: @temir.ra/ts-lib
 
 # print the latest version
-bun info "@temir.ra/create-ts-lib" version
+npm info "@temir.ra/create-ts-lib" version
 
 # create/update a package from the template in the current directory
-bun create --no-install --no-git "@temir.ra/ts-lib@latest" .
+npm create --no-install --no-git "@temir.ra/ts-lib@latest" .
 
 # set metadata in package.json
 
-bun install
+npm install
 ```
 
 # Documentation
@@ -409,8 +422,8 @@ If the package exports a CLI only and is not intended to be imported in other pa
 # DevOps
 
 ```bash
-npm update
 npm install
+npm update
 
 npm run clean
 npm run build
@@ -431,9 +444,14 @@ npmx tsx dist/cli.bundle.js -- example/
 
 ## Publish
 
+`~/.npmrc` or `.npmrc`:
+
+```ini
+@temir.ra:registry=https://registry.npmjs.org/
+```
+
 ```bash
 # registry.npmjs.org/
 npm login
-
-npm publish --registry https://registry.npmjs.org/
+npm publish
 ```

package/buildinfo.txt

@@ -1 +1 @@
-0.11.0-pre.9+c4e82f7
+0.11.0+6625dc3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-ts-lib",
-  "version": "0.11.0-pre.9",
+  "version": "0.11.0",
   "description": "A template for a distributable TypeScript library package.",
   "private": false,
   "keywords": [
@@ -30,11 +30,11 @@
     "#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",
+    "reinstall": "rm -rf node_modules && 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:dist": "rm -rf dist/",
+    "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",

package/template/README.md

@@ -21,8 +21,8 @@
 # DevOps
 
 ```bash
-npm update
 npm install
+npm update
 
 npm run dev
 
@@ -43,7 +43,29 @@ npm run tests
 
 ## Publish
 
-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_ORIGIN_AND_PATH: <REGISTRY_ORIGIN_AND_PATH>
+    # e.g.
+      # registry.npmjs.org/
+      # forgejo.example.com/api/packages/<SCOPE_WITHOUT_AT>/npm/
+  # <REGISTRY_AUTH_TOKEN_ENV_VAR: <REGISTRY_AUTH_TOKEN_ENV_VAR>
+```
+
+`~/.npmrc` or `.npmrc`:
+
+```ini
+@<SCOPE_WITHOUT_AT>:registry=https://<REGISTRY_ORIGIN_AND_PATH>
+//<REGISTRY_ORIGIN_AND_PATH>:_authToken=${<REGISTRY_AUTH_TOKEN_ENV_VAR>}
+```
+
+`~/.bunfig.toml` or `bunfig.toml`:
+
+```toml
+[install.scopes]
+"<SCOPE_WITHOUT_AT>" = { url = "https://<REGISTRY_ORIGIN_AND_PATH>", token = "$<REGISTRY_AUTH_TOKEN_ENV_VAR>" }
+```
 
 ```bash
 # registry.npmjs.org/