@temir.ra/create-template 0.5.4 → 0.6.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Temir Ra
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2026 Temir Ra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,79 +1,144 @@
-# Introduction
-
-This template scaffolds a package that is itself a template for other packages.
-
-## Table of Contents
-
-1. [Quick Start](#quick-start)
-2. [Documentation](#documentation)
-3. [DevOps](#devops)
-    1. [Change Management](#change-management)
-    2. [Publish](#publish)
-
-# Quick Start
-
-```bash
-# placeholder:
-    # <TEMPLATE_PACKAGE_NAME: @temir.ra/create-template
-    # <TEMPLATE_NAME: @temir.ra/template
-
-# print the latest version
-npm info "@temir.ra/create-template" version
-
-# create/update a package from the template in the current directory
-npm create --no-install --no-git "@temir.ra/template@latest" .
-
-# set metadata in package.json
-
-npm update
-```
-
-# Documentation
-
-The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.
-
-*&lt;DOCUMENTATION&gt;*
-
-# DevOps
-
-```bash
-npm install
-npm update
-
-npm run clean
-npm run build
-npm run tests
-
-npx tsx dist/cli.bundle.js -- example/
-```
-
-## Change Management
-
-1. Create a new branch for the change.
-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.
-6. Ensure package artifacts are current.
-7. Publish.
-
-## Publish
-
-`~/.npmrc` or `.npmrc`:
-
-```ini
-@temir.ra:registry=https://registry.npmjs.org/
-```
-
-`~/.bunfig.toml` or `bunfig.toml`:
-
-```toml
-[install.scopes]
-"temir.ra" = { url = "https://registry.npmjs.org/" }
-```
-
-```bash
-# registry.npmjs.org/
-npm login
-npm publish
-```
+# Introduction
+
+This template scaffolds a package that is itself a template for other packages.
+
+## Table of Contents
+
+1. [Quick Start](#quick-start)
+2. [Documentation](#documentation)
+3. [DevOps](#devops)
+    1. [Change Management](#change-management)
+    2. [Registry](#registry)
+    3. [CI/CD Workflows](#cicd-workflows)
+
+# Quick Start
+
+```bash
+# print the latest version
+npm info "@temir.ra/create-template" version
+
+# create/update a package from the template in the current directory
+npm create --no-install --no-git "@temir.ra/template@latest" .
+
+# set metadata in package.json
+
+npm update
+```
+
+# Documentation
+
+The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.
+
+*&lt;DOCUMENTATION&gt;*
+
+# DevOps
+
+```bash
+npm install
+npm update
+
+npm run clean
+npm run build
+npm run tests
+
+npx tsx dist/cli.bundle.js -- example/
+```
+
+```bash
+git fetch upstream
+git fetch origin
+git fetch . upstream/main:origin/main
+git fetch . origin/main:main
+git push origin main
+git merge --ff-only main
+git push
+```
+
+## Change Management
+
+1. Create a new branch for the change.
+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.
+6. Ensure package artifacts are current.
+7. Publish.
+
+## Registry
+
+`.npmrc`:
+
+```ini
+@temir.ra:registry=https://registry.npmjs.org/
+//registry.npmjs.org/:_authToken=${NPMJSORG_REGISTRY_AUTH_TOKEN}
+```
+
+or `bunfig.toml`:
+
+```toml
+[install.scopes]
+"temir.ra" = { url = "https://registry.npmjs.org/", token = "$NPMJSORG_REGISTRY_AUTH_TOKEN" }
+```
+
+```bash
+# registry.npmjs.org/
+export NPMJSORG_REGISTRY_AUTH_TOKEN=<AUTH_TOKEN>
+# or
+$env:NPMJSORG_REGISTRY_AUTH_TOKEN = "<AUTH_TOKEN>"
+npm publish
+```
+
+## CI/CD Workflows
+
+### Build and Publish
+
+⚠️ `.npmrc` configuring the package registry and its authentication token is required for the workflow to work.
+
+|Parameter|Type|Description|
+|-----|-----|-----|
+|`RUNNER_LABEL`|Variable|The label of the runner to use for the workflow.|
+|`ACCESS_TOKEN`|Secret|The authentication token for the package registry.|
+
+`.github/workflows/build-publish.yml`:
+
+```yaml
+name: Build and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ${{ vars.RUNNER_LABEL }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install
+        env:
+          NPMJSORG_REGISTRY_AUTH_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm run tests
+
+      - name: Publish
+        env:
+          NPMJSORG_REGISTRY_AUTH_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        run: |
+          PKG_NAME=$(node -p "require('./package.json').name")
+          PKG_VERSION=$(node -p "require('./package.json').version")
+          NPM_TAG="latest"
+          if echo "$PKG_VERSION" | grep -q -- '-'; then
+            NPM_TAG="next"
+          fi
+          if npm view "$PKG_NAME@$PKG_VERSION" version >/dev/null 2>&1; then
+            echo "$PKG_NAME@$PKG_VERSION already published, skipping."
+          else
+            npm publish --tag "$NPM_TAG"
+          fi
+```

package/dist/CHANGELOG.md

@@ -1,106 +1,116 @@
-# Version 0
-
-## 0.5.4
-
-1. Minor fixes.
-
-## 0.5.0
-
-1. Moved `template/` from package root to `dist/`.
-
-## 0.4.4
-
-1. Synced template files with `ts-lib@0.13.0-pre.7` template.
-2. Synced files with `self` as template.
-
-## 0.4.3
-
-1. Fixed versioning issue.
-
-## 0.4.2
-
-1. Updated from `ts-lib@0.12.0-pre.1` template.
-
-## 0.4.1
-
-1. Minor updates in the README.
-
-## 0.4.0
-
-1. Synced template files with `ts-lob@0.11.0-pre.11` template.
-2. Replaced `bun run` with `npmx tsx` in DevOps commands.
-3. Cleaned up Quick Start section.
-4. Updated files from self as template.
-
-## 0.3.0
-
-1. Synced template files with `ts-lib@0.10.0-pre.1` template.
-2. Added `node:` prefix to imports.
-3. Updated files from `self`.
-
-## 0.2.1
-
-1. Updated Quick Start section.
-
-## 0.2.0
-
-1. Synced with `ts-lib@0.9.0` template.
-2. Switched to `esbuild` for bundling.
-3. Updated Quick Start section to reflect typical usage patterns.
-4. Updated files from self.
-
-## 0.1.11
-
-1. Synced with `ts-lib@0.8.4` template.
-
-## 0.1.10
-
-1. Synced with `ts-lib` template.
-
-## 0.1.9
-
-1. Fixed template assets paths.
-
-## 0.1.8
-
-1. Updated template files from `ts-lib@0.8.0` template.
-2. Updated files from self.
-
-## 0.1.7
-
-1. Updated `typescript` to `6.0.3`.
-2. Updated template files from `ts-lib` template.
-
-## 0.1.6
-
-1. Removed `bun run --watch scripts/dev.ts` from DevOps commands in `README.md` and `template/README.md`.
-
-## 0.1.5
-
-1. Updated metadata in `package.json` and `template/package.json`.
-2. Added `bun run --watch scripts/dev.ts` to DevOps commands in `README.md` and `template/README.md`.
-
-## 0.1.4
-
-1. Updated `template/` files from `@temir.ra/ts-lib@0.7.2` template.
-2. Updated the description in `package.json`.
-
-## 0.1.3
-
-1. Removed `scripts/dev.ts`.
-
-## 0.1.2
-
-1. Updated `package.json` from `create-ts-lib` template.
-
-## 0.1.1
-
-1. Added clarifications to `README.md`.
-
-## 0.1.0
-
-1. First published version.
-
-## 0.0.0
-
-1. Package created.
+# Version 0
+
+## 0.6.0
+
+1. Updated template files from `ts-lib@0.15.0-pre.4` template.
+2. Updated from `self` as template.
+3. Added Build and Publish Workflow.
+
+## 0.5.5
+
+1. Updated template files from `ts-lib@0.14.0-pre.3` template.
+
+## 0.5.4
+
+1. Minor fixes.
+
+## 0.5.0
+
+1. Moved `template/` from package root to `dist/`.
+
+## 0.4.4
+
+1. Synced template files with `ts-lib@0.13.0-pre.7` template.
+2. Synced files with `self` as template.
+
+## 0.4.3
+
+1. Fixed versioning issue.
+
+## 0.4.2
+
+1. Updated from `ts-lib@0.12.0-pre.1` template.
+
+## 0.4.1
+
+1. Minor updates in the README.
+
+## 0.4.0
+
+1. Synced template files with `ts-lob@0.11.0-pre.11` template.
+2. Replaced `bun run` with `npmx tsx` in DevOps commands.
+3. Cleaned up Quick Start section.
+4. Updated files from self as template.
+
+## 0.3.0
+
+1. Synced template files with `ts-lib@0.10.0-pre.1` template.
+2. Added `node:` prefix to imports.
+3. Updated files from `self`.
+
+## 0.2.1
+
+1. Updated Quick Start section.
+
+## 0.2.0
+
+1. Synced with `ts-lib@0.9.0` template.
+2. Switched to `esbuild` for bundling.
+3. Updated Quick Start section to reflect typical usage patterns.
+4. Updated files from self.
+
+## 0.1.11
+
+1. Synced with `ts-lib@0.8.4` template.
+
+## 0.1.10
+
+1. Synced with `ts-lib` template.
+
+## 0.1.9
+
+1. Fixed template assets paths.
+
+## 0.1.8
+
+1. Updated template files from `ts-lib@0.8.0` template.
+2. Updated files from self.
+
+## 0.1.7
+
+1. Updated `typescript` to `6.0.3`.
+2. Updated template files from `ts-lib` template.
+
+## 0.1.6
+
+1. Removed `bun run --watch scripts/dev.ts` from DevOps commands in `README.md` and `template/README.md`.
+
+## 0.1.5
+
+1. Updated metadata in `package.json` and `template/package.json`.
+2. Added `bun run --watch scripts/dev.ts` to DevOps commands in `README.md` and `template/README.md`.
+
+## 0.1.4
+
+1. Updated `template/` files from `@temir.ra/ts-lib@0.7.2` template.
+2. Updated the description in `package.json`.
+
+## 0.1.3
+
+1. Removed `scripts/dev.ts`.
+
+## 0.1.2
+
+1. Updated `package.json` from `create-ts-lib` template.
+
+## 0.1.1
+
+1. Added clarifications to `README.md`.
+
+## 0.1.0
+
+1. First published version.
+
+## 0.0.0
+
+1. Package created.

package/dist/buildinfo.txt

@@ -1 +1 @@
-0.5.4+cdce337
+0.6.0+35a0356

package/dist/cli.bundle.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/cli.ts", "../src/package-urls.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 './package-urls.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 distUrl: URL = new URL('dist/', packageUrl);\r\nexport const buildinfoUrl: URL = new URL('buildinfo.txt', distUrl);\r\nexport const changelogUrl: URL = new URL('CHANGELOG.md', distUrl);\r\nexport const readmeUrl: URL = new URL('README.md', packageUrl);\r\n\r\nexport const templateUrl: URL = new URL('template/', distUrl);\r\n"],
+  "sourcesContent": ["#!/usr/bin/env node\n\nimport { cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';\nimport { resolve } from 'node:path';\nimport {\n    templateUrl,\n    changelogUrl,\n    buildinfoUrl,\n    readmeUrl\n} from './package-urls.js';\n\n\ntry {\n\n    const packageNameArgument = process.argv[2];\n    if (!packageNameArgument)\n        throw new Error('First argument must be the package name (e.g. \"my-package\" or \"@my-scope/my-package\").');\n    const packageName = packageNameArgument.replace(/\\\\/g, '/');\n\n    const destinationPath = resolve(process.cwd(), packageName);\n\n    cpSync(templateUrl, destinationPath, { recursive: true });\n    cpSync(changelogUrl, resolve(destinationPath, 'CHANGELOG-template.md'));\n    cpSync(buildinfoUrl, resolve(destinationPath, 'buildinfo-template.txt'));\n    cpSync(readmeUrl, resolve(destinationPath, 'README-template.md'));\n\n    const packageJsonPath = resolve(destinationPath, 'package.json');\n    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));\n    packageJson.name = packageName;\n    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));\n\n    renameSync(resolve(destinationPath, 'gitignore'), resolve(destinationPath, '.gitignore'));\n\n    console.log(`Template has been successfully instantiated at '${destinationPath}' with package name '${packageName}'.`);\n\n}\ncatch (error) {\n    const err = error instanceof Error ? error : new Error(String(error));\n    console.error('Error:', err.message);\n    process.exit(1);\n}\n", "export const packageUrl: URL = new URL('../', import.meta.url);\n\nexport const distUrl: URL = new URL('dist/', packageUrl);\nexport const buildinfoUrl: URL = new URL('buildinfo.txt', distUrl);\nexport const changelogUrl: URL = new URL('CHANGELOG.md', distUrl);\nexport const readmeUrl: URL = new URL('README.md', packageUrl);\n\nexport const templateUrl: URL = new URL('template/', distUrl);\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,EAAe,IAAI,IAAI,QAASD,CAAU,EAC1CE,EAAoB,IAAI,IAAI,gBAAiBD,CAAO,EACpDE,EAAoB,IAAI,IAAI,eAAgBF,CAAO,EACnDG,EAAiB,IAAI,IAAI,YAAaJ,CAAU,EAEhDK,EAAmB,IAAI,IAAI,YAAaJ,CAAO,EDK5D,GAAI,CAEA,IAAMK,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", "distUrl", "buildinfoUrl", "changelogUrl", "readmeUrl", "templateUrl", "packageNameArgument", "packageName", "destinationPath", "resolve", "cpSync", "templateUrl", "changelogUrl", "buildinfoUrl", "readmeUrl", "packageJsonPath", "packageJson", "readFileSync", "writeFileSync", "renameSync", "error", "err"]
 }

package/dist/template/CHANGELOG.md

@@ -1,5 +1,5 @@
-# Version 0
-
-## 0.0.0
-
-1. Package created.
+# Version 0
+
+## 0.0.0
+
+1. Package created.