@temir.ra/create-hono-spa 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Version 0
 
+## 0.2.1
+
+1. Updated files from `ts-lib@0.6.3` template.
+
 ## 0.2.0
 
 1. Updated documentation and configs to TypeScript 6.

package/README.md

@@ -5,18 +5,15 @@ A template for single-page applications distributed as Hono sub-app libraries. T
 ## Table of Contents
 
 1. [Quick Start](#quick-start)
-2. [AI Assistant Context](#ai-assistant-context)
-3. [Documentation](#documentation)
+2. [Documentation](#documentation)
     1. [`template/`](#template)
     2. [Architecture](#architecture)
     3. [`src/spa.ts`](#srcspa-ts)
     4. [`src/constants.ts`](#srcconstants-ts)
     5. [`assets/`](#assets)
-4. [DevOps](#devops)
+3. [DevOps](#devops)
     1. [Change Management](#change-management)
     2. [Publish](#publish)
-        1. [npmjs.org](#npmjsorg)
-        2. [Custom registry](#custom-registry)
 
 # Quick Start
 
@@ -44,24 +41,12 @@ cd <NEW_PACKAGE>
 bun install
 ```
 
-# AI Assistant Context
-
-To generate an AI coding assistant context file for this project:
-
-> Generate an AI coding assistant context file. Analyze the project structure and source files, using this README as the primary reference for architecture and conventions. Give particular attention to: the SPA-as-library abstraction and how assets are served via import.meta.url without any file copying on the consuming server, the `./spa` export condition and createSpa() as the library's public API, and the base href patching mechanism that enables client-side routing regardless of mount path.
-
 # Documentation
 
-The following sections explain the configurations and conventions baked into the generated package.
+The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.
 
 ## `template/`
 
-The files in `template/` were created from the [`@temir.ra/ts-lib@0.5.0`](https://www.npmjs.com/package/@temir.ra/create-ts-lib/v/0.5.0) template and then updated to fit the needs of a Hono SPA template.
-
-```powershell
-bun create --no-install --no-git --force "@temir.ra/ts-lib@0.5.0" "template/"
-```
-
 [Official documentation](https://hono.dev/docs/) provided by the Hono team is a great resource.
 
 ## Architecture
@@ -142,13 +127,13 @@ assets/
 # DevOps
 
 ```bash
-# remove dist/ and tsconfig.build.tsbuildinfo
+# remove dist/ and tsconfig.tsbuildinfo and tsconfig.build.tsbuildinfo
 bun run clean
 
 # remove dist/ only
 bun run clean:dist
 
-# remove tsconfig.build.tsbuildinfo only
+# remove tsconfig.tsbuildinfo and tsconfig.build.tsbuildinfo only
 bun run clean:tsbuildinfo
 
 # compile + bundle
@@ -158,8 +143,6 @@ bun run build
 bun run dist/cli.bundle.js -- example
 ```
 
-**Publish** - see [Publish](#publish).
-
 ## Change Management
 
 1. Create a new branch for the change.
@@ -172,15 +155,6 @@ bun run dist/cli.bundle.js -- example
 
 ## 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
@@ -189,26 +163,3 @@ npm login
 # publish
 bun publish --registry https://registry.npmjs.org/ --access public
 ```
-
-### Custom registry
-
-```bash
-# placeholder:
-    # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-    # <REGISTRY_URL: <REGISTRY_URL>
-    # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
-```
-
-`~/.bunfig.toml` or `bunfig.toml`:
-
-```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
-```

package/buildinfo.txt

@@ -1 +1 @@
-0.2.0+40f404b
+0.2.1+9a0a8a7

package/dist/cli.bundle.js.map

@@ -2,7 +2,7 @@
   "version": 3,
   "sources": ["..\\src\\cli.ts", "..\\src\\constants.ts"],
   "sourcesContent": [
-    "#!/usr/bin/env node\r\n\r\nimport { cpSync, readFileSync, renameSync, writeFileSync } from 'fs';\r\nimport { resolve, basename } from 'path';\r\nimport {\r\n    templatePath,\r\n    changelogPath,\r\n    buildinfoPath,\r\n    readmePath\r\n} from './constants.js';\r\n\r\n\r\ntry {\r\n\r\n    const packageNameArgument = process.argv[2];\r\n    if (!packageNameArgument) throw new Error('Package name argument is required. Usage: `create-hono-spa <package-name>`');\r\n    const packageName = packageNameArgument.replace(/\\\\/g, '/');\r\n\r\n    const destinationPath = resolve(process.cwd(), packageName);\r\n\r\n    cpSync(templatePath, destinationPath, { recursive: true });\r\n    cpSync(changelogPath, resolve(destinationPath, 'CHANGELOG-template.md'));\r\n    cpSync(buildinfoPath, resolve(destinationPath, 'buildinfo-template.txt'));\r\n    cpSync(readmePath, 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",
+    "#!/usr/bin/env node\r\n\r\nimport { cpSync, readFileSync, renameSync, writeFileSync } from 'fs';\r\nimport { resolve } from 'path';\r\nimport {\r\n    templatePath,\r\n    changelogPath,\r\n    buildinfoPath,\r\n    readmePath\r\n} from './constants.js';\r\n\r\n\r\ntry {\r\n\r\n    const packageNameArgument = process.argv[2];\r\n    if (!packageNameArgument) throw new Error('Package name argument is required. Usage: `create-hono-spa <package-name>`');\r\n    const packageName = packageNameArgument.replace(/\\\\/g, '/');\r\n\r\n    const destinationPath = resolve(process.cwd(), packageName);\r\n\r\n    cpSync(templatePath, destinationPath, { recursive: true });\r\n    cpSync(changelogPath, resolve(destinationPath, 'CHANGELOG-template.md'));\r\n    cpSync(buildinfoPath, resolve(destinationPath, 'buildinfo-template.txt'));\r\n    cpSync(readmePath, 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",
     "import { resolve } from 'path';\r\nimport { fileURLToPath } from 'url';\r\n\r\n\r\nexport const packageUrl: URL = new URL('../', import.meta.url);\r\nexport const packagePath: string = resolve(fileURLToPath(packageUrl));\r\n\r\nexport const templatePath: string = resolve(packagePath, 'template/');\r\n\r\nexport const changelogPath: string = resolve(packagePath, 'CHANGELOG.md');\r\nexport const buildinfoPath: string = resolve(packagePath, 'buildinfo.txt');\r\nexport const readmePath: string = resolve(packagePath, 'README.md');\r\n"
   ],
   "mappings": ";AAEA,iBAAS,kBAAQ,gBAAc,mBAAY,WAC3C,kBAAS,aCHT,kBAAS,aACT,wBAAS,YAGF,IAAM,EAAkB,IAAI,IAAI,MAAO,YAAY,GAAG,EAChD,EAAsB,EAAQ,EAAc,CAAU,CAAC,EAEvD,EAAuB,EAAQ,EAAa,WAAW,EAEvD,EAAwB,EAAQ,EAAa,cAAc,EAC3D,EAAwB,EAAQ,EAAa,eAAe,EAC5D,EAAqB,EAAQ,EAAa,WAAW,EDClE,GAAI,CAEA,IAAM,EAAsB,QAAQ,KAAK,GACzC,GAAI,CAAC,EAAqB,MAAU,MAAM,4EAA4E,EACtH,IAAM,EAAc,EAAoB,QAAQ,MAAO,GAAG,EAEpD,EAAkB,EAAQ,QAAQ,IAAI,EAAG,CAAW,EAE1D,EAAO,EAAc,EAAiB,CAAE,UAAW,EAAK,CAAC,EACzD,EAAO,EAAe,EAAQ,EAAiB,uBAAuB,CAAC,EACvE,EAAO,EAAe,EAAQ,EAAiB,wBAAwB,CAAC,EACxE,EAAO,EAAY,EAAQ,EAAiB,oBAAoB,CAAC,EAEjE,IAAM,EAAkB,EAAQ,EAAiB,cAAc,EACzD,EAAc,KAAK,MAAM,EAAa,EAAiB,OAAO,CAAC,EACrE,EAAY,KAAO,EACnB,EAAc,EAAiB,KAAK,UAAU,EAAa,KAAM,CAAC,CAAC,EAEnE,EAAW,EAAQ,EAAiB,WAAW,EAAG,EAAQ,EAAiB,YAAY,CAAC,EAExF,QAAQ,IAAI,mDAAmD,yBAAuC,KAAe,EAGzH,MAAO,EAAO,CACV,IAAM,EAAM,aAAiB,MAAQ,EAAY,MAAM,OAAO,CAAK,CAAC,EACpE,QAAQ,MAAM,SAAU,EAAI,OAAO,EACnC,QAAQ,KAAK,CAAC",

package/dist/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import { cpSync, readFileSync, renameSync, writeFileSync } from 'fs';
-import { resolve, basename } from 'path';
+import { resolve } from 'path';
 import { templatePath, changelogPath, buildinfoPath, readmePath } from './constants.js';
 try {
     const packageNameArgument = process.argv[2];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@temir.ra/create-hono-spa",
-  "version": "0.2.0",
-  "description": "SPA template with Hono server backend",
+  "version": "0.2.1",
+  "description": "SPA template for Hono server backend",
   "author": "temir.ra",
   "license": "MIT",
   "keywords": [
@@ -28,7 +28,7 @@
   ],
   "scripts": {
     "clean:dist": "rm -rf dist/",
-    "clean:tsbuildinfo": "rm -f tsconfig.build.tsbuildinfo",
+    "clean:tsbuildinfo": "rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
     "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
     "prebuild": "bun run scripts/buildinfo.ts",
     "tests": "bun test",

package/template/README.md

@@ -5,9 +5,8 @@
 ## Table of Contents
 
 1. [Quick Start](#quick-start)
-2. [AI Assistant Context](#ai-assistant-context)
-3. [Documentation](#documentation)
-4. [DevOps](#devops)
+2. [Documentation](#documentation)
+3. [DevOps](#devops)
     1. [Change Management](#change-management)
     2. [Publish](#publish)
         1. [npmjs.org](#npmjsorg)
@@ -16,13 +15,13 @@
 # Quick Start
 
 ```bash
-# remove dist/ and tsconfig.build.tsbuildinfo
+# remove dist/ and tsconfig.tsbuildinfo and tsconfig.build.tsbuildinfo
 bun run clean
 
 # remove dist/ only
 bun run clean:dist
 
-# remove tsconfig.build.tsbuildinfo only
+# remove tsconfig.tsbuildinfo and tsconfig.build.tsbuildinfo only
 bun run clean:tsbuildinfo
 
 # compile + bundle
@@ -35,30 +34,10 @@ bun run tests
 bun run dev
 ```
 
-**Publish** - see [Publish](#publish).
-
-# AI Assistant Context
-
-To generate an AI coding assistant context file for this project:
-
-> Generate an AI coding assistant context file. `README-template.md` is available now and documents the architectural conventions of this package — use it as your primary source. The generated context file must be self-contained: `README-template.md` will be deleted after context generation, so do not reference it in the output. Give particular attention to: the dual tsconfig setup and the import constraints it imposes, the `#src/*.js` alias and where it may and may not be used, the `./spa` export condition and createSpa() as the library's public API, the asset resolution via import.meta.url and why it is reliable when the package is loaded externalized, and the base href patching mechanism for client-side routing.
-
 # Documentation
 
 *<DOCUMENTATION>*
 
-## Asset Resolution
-
-*<!-- Remove this section if the library has no runtime assets. Replace `@scope/lib-name` throughout with the actual package name. -->*
-
-Assets are placed under `assets/@scope/lib-name/` (scoped to the package name to prevent collisions). They are resolved at runtime via `import.meta.url` and loaded with `fetch()` (browser) or `readFile` (Node). `assets/` must be listed in `files` in `package.json`.
-
-`import.meta.url` is reliable when the library is loaded as a discrete module (from CDN or `node_modules/`). When the consumer bundles the library, they must copy the assets - see below.
-
-### For consumers bundling this library
-
-Copy `node_modules/@scope/lib-name/assets/` into your build output alongside the bundle, preserving the relative path. No code configuration is required - only the file copy.
-
 # DevOps
 
 ## Change Management
@@ -95,9 +74,9 @@ bun publish --registry https://registry.npmjs.org/ --access public
 
 ```bash
 # placeholder:
-    # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-    # <REGISTRY_URL: <REGISTRY_URL>
-    # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
+  # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
+  # <REGISTRY_URL: <REGISTRY_URL>
+  # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
 ```
 
 `~/.bunfig.toml` or `bunfig.toml`:

package/template/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "",
-  "version": "0.0.0+FE",
-  "description": "",
-  "author": "",
-  "license": "",
-  "keywords": [
-    "typescript"
-  ],
-  "repository": {
-    "type": "git",
-    "url": ""
-  },
-  "type": "module",
-  "exports": {
-    ".": {
-      "entrypoint": "./src/index.ts",
-      "types": "./dist/index.d.ts",
-      "browser": "./dist/index.bundle.js",
-      "import": "./dist/index.js"
-    },
-    "./spa": {
-      "entrypoint": "./src/spa.ts",
-      "types": "./dist/spa.d.ts",
-      "browser": "./dist/spa.bundle.js",
-      "import": "./dist/spa.js"
-    }
-  },
-  "imports": {
-    "#src/*.js": "./src/*.ts"
-  },
-  "files": [
-    "dist",
-    "CHANGELOG.md",
-    "buildinfo.txt",
-    "assets"
-  ],
-  "scripts": {
-    "clean:dist": "rm -rf dist/",
-    "clean:tsbuildinfo": "rm -f tsconfig.build.tsbuildinfo",
-    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
-    "prebuild": "bun run scripts/buildinfo.ts",
-    "tests": "bun test",
-    "build": "bun run build:lib && bun run build:lib-bundle",
-    "build:lib": "tsc --project tsconfig.build.json",
-    "build:lib-bundle": "bun run scripts/build-lib-bundle.ts",
-    "typecheck": "tsc --noEmit",
-    "dev": "bun run --watch src/dev.ts"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "typescript": "^6.0.2",
-    "hono": "^4.12.5"
-  }
+{
+  "name": "",
+  "version": "0.0.0+FE",
+  "description": "",
+  "author": "",
+  "license": "",
+  "keywords": [
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "entrypoint": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "browser": "./dist/index.bundle.js",
+      "import": "./dist/index.js"
+    },
+    "./spa": {
+      "entrypoint": "./src/spa.ts",
+      "types": "./dist/spa.d.ts",
+      "browser": "./dist/spa.bundle.js",
+      "import": "./dist/spa.js"
+    }
+  },
+  "imports": {
+    "#src/*.js": "./src/*.ts"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "buildinfo.txt",
+    "assets"
+  ],
+  "scripts": {
+    "clean:dist": "rm -rf dist/",
+    "clean:tsbuildinfo": "rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
+    "clean": "bun run clean:dist && bun run clean:tsbuildinfo",
+    "prebuild": "bun run scripts/buildinfo.ts",
+    "tests": "bun test",
+    "build": "bun run build:lib && bun run build:lib-bundle",
+    "build:lib": "tsc --project tsconfig.build.json",
+    "build:lib-bundle": "bun run scripts/build-lib-bundle.ts",
+    "typecheck": "tsc --noEmit",
+    "dev": "bun run --watch src/dev.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^6.0.2",
+    "hono": "^4.12.5"
+  }
 }