@temir.ra/create-ts-lib 0.7.2 → 0.7.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Version 0
 
+## 0.7.4
+
+1. Updated `keywords` in `template/package.json`.
+2. Restored docs for `build*` and `tests` `package.json` scripts in `README.md`.
+3. Reduced `scripts/dev.ts` section to a DevOps command.
+4. Added clarification on the `files` field recommendation for `tests/` in the README.
+5. Updated from `@temir.ra/template@0.1.5` template.
+
+## 0.7.3
+
+1. Updated from `@temir.ra/template@0.1.4` template.
+
 ## 0.7.2
 
 1. Cleaned up `*-template.*` files from the template directory.

package/README.md

@@ -8,14 +8,13 @@ A template for TypeScript libraries distributed via npm-compatible registries. P
 2. [Documentation](#documentation)
     1. [`package.json`](#packagejson)
     2. [`"bin"` field in `package.json`](#bin-field-in-packagejson)
-    3. [`scripts/dev.ts`](#scriptsdevts)
-    4. [`tsconfig.json`](#tsconfigjson)
-    5. [TSC Compilation](#tsc-compilation)
+    3. [`tsconfig.json`](#tsconfigjson)
+    4. [TSC Compilation](#tsc-compilation)
         1. [`tsconfig.build.json`](#tsconfigbuildjson)
         2. [`package.json`](#packagejson-1)
-    6. [Script `scripts/build-bundle.ts`](#script-scriptsbuild-bundlets)
+    5. [Script `scripts/build-bundle.ts`](#script-scriptsbuild-bundlets)
         1. [CDN Map `scripts/cdn-rewrite-map.json`](#cdn-map-scriptscdn-rewrite-mapjson)
-    7. [Asset Resolution](#asset-resolution)
+    6. [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)
@@ -118,15 +117,28 @@ The generated package is pre-configured with `build:bundle` only. See [TSC Compi
     "scripts/buildinfo.ts",
     "scripts/build-bundle.ts",
     "scripts/cdn-rewrite-map.json",
-    "dist",
     "CHANGELOG.md",
-    "buildinfo.txt"
+    "buildinfo.txt",
+    "dist/",
+    "tests/"
   ],
 
   "scripts": {
 
     // ... ,
 
+    // removes the dist/ directory generated by the build steps
+    "clean:dist": "rm -rf dist/",
+
+    // removes .tsbuildinfo files generated by TypeScript's incremental build feature
+    "clean:tsbuildinfo": "rm -f *.tsbuildinfo || true",
+
+    // convenience script to run the clean steps in sequence
+    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
+
+    // discovers and runs test files
+    "tests": "bun test",
+
     // executed before build; generates buildinfo.txt
     "prebuild": "bun run buildinfo",
 
@@ -147,6 +159,8 @@ The generated package is pre-configured with `build:bundle` only. See [TSC Compi
 }
 ```
 
+It is highly recommended to include `tests/` in the `files` field. Note, that `tests/` is not included by default in the generated `package.json`.
+
 ## `"bin"` field in `package.json`
 
 For CLI packages, add the following to `package.json`:
@@ -155,7 +169,6 @@ For CLI packages, add the following to `package.json`:
 {
   // ... ,
   "bin": "./dist/cli.bundle.js",
-  // ... ,
   "scripts": {
     // ... ,
     "build": "... && bun run build:cli-bundle",
@@ -173,10 +186,6 @@ For CLI packages, add the following to `package.json`:
 
 If the package exports a CLI only and is not intended to be imported in other packages, the `exports` field can be omitted.
 
-## `scripts/dev.ts`
-
-Development scratchpad. Execute it manually with `bun run --watch scripts/dev.ts`. Useful to test and explore library code during development.
-
 ## `tsconfig.json`
 
 Selected fields are documented in the [`create-workspace` README](https://www.npmjs.com/package/@temir.ra/create-workspace#tsconfigjson).
@@ -418,7 +427,7 @@ bun run clean
 bun run build
 bun run tests
 
-bun run dev
+bun run --watch scripts/dev.ts
 
 # see publish section for publish instructions
 ```

package/buildinfo.txt

@@ -1 +1 @@
-0.7.2+395717b
+0.7.4+443a662

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@temir.ra/create-ts-lib",
-  "version": "0.7.2",
-  "description": "Typescript library template",
+  "version": "0.7.4",
+  "description": "A template for a distributable TypeScript library package.",
   "author": "temir.ra",
   "license": "MIT",
   "keywords": [
     "typescript",
+    "bun",
     "template",
-    "library",
-    "bun"
+    "library"
   ],
   "repository": {
     "type": "git",
@@ -24,19 +24,19 @@
     "scripts/buildinfo.ts",
     "scripts/build-bundle.ts",
     "scripts/cdn-rewrite-map.json",
-    "dist",
     "CHANGELOG.md",
     "buildinfo.txt",
-    "template"
+    "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",
-    "buildinfo": "bun run scripts/buildinfo.ts",
     "tests": "bun test",
-    "typecheck": "tsc --noEmit",
-    "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",
     "prebuild": "bun run buildinfo",
     "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"

package/template/README.md

@@ -29,7 +29,7 @@ bun run clean
 bun run build
 bun run tests
 
-bun run dev
+bun run --watch scripts/dev.ts
 
 # see publish section for publish instructions
 ```

package/template/gitignore

@@ -4,4 +4,4 @@ buildinfo-template.txt
 CHANGELOG-template.md
 README-template.md
 *.tsbuildinfo
-dist
+dist/

package/template/package.json

@@ -5,7 +5,8 @@
   "author": "",
   "license": "",
   "keywords": [
-    "typescript"
+    "typescript",
+    "bun"
   ],
   "repository": {
     "type": "git",
@@ -30,7 +31,7 @@
     "scripts/cdn-rewrite-map.json",
     "CHANGELOG.md",
     "buildinfo.txt",
-    "dist"
+    "dist/"
   ],
   "scripts": {
     "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",