@temir.ra/create-template 0.5.5 → 0.6.1

package/dist/template/README.md

@@ -1,166 +1,162 @@
-# Introduction
-
-This template scaffolds a ...
-
-## 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
-# placeholder:
-    # <TEMPLATE_PACKAGE_NAME: <TEMPLATE_PACKAGE_NAME>
-    # <TEMPLATE_NAME: <TEMPLATE_NAME>
-
-# print the latest version
-npm info "<TEMPLATE_PACKAGE_NAME>" version
-
-# create/update a package from the template in the current directory
-npm create --no-install --no-git "<TEMPLATE_NAME>@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
-
-```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`:
-
-```ini
-@<SCOPE_WITHOUT_AT>:registry=https://<REGISTRY_ORIGIN_AND_PATH>
-//<REGISTRY_ORIGIN_AND_PATH>:_authToken=${<REGISTRY_AUTH_TOKEN_ENV_VAR>}
-```
-
-`bunfig.toml`:
-
-```toml
-[install.scopes]
-"<SCOPE_WITHOUT_AT>" = { url = "https://<REGISTRY_ORIGIN_AND_PATH>", token = "$<REGISTRY_AUTH_TOKEN_ENV_VAR>" }
-```
-
-```bash
-# registry.npmjs.org/
-npm login
-# or custom registry
-export <REGISTRY_AUTH_TOKEN_ENV_VAR>=<AUTH_TOKEN>
-# or
-$env:<REGISTRY_AUTH_TOKEN_ENV_VAR> = "<AUTH_TOKEN>"
-npm publish
-```
-
-## CI/CD Workflows
-
-## Build and Publish to a custom registry
-
-⚠️ `.npmrc` configuring the custom registry and its authentication token must be present in the repository 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 custom registry.|
-
-```bash
-# placeholder:
-  # <REGISTRY_AUTH_TOKEN_ENV_VAR: <REGISTRY_AUTH_TOKEN_ENV_VAR>
-```
-
-`.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:
-          <REGISTRY_AUTH_TOKEN_ENV_VAR>: ${{ secrets.ACCESS_TOKEN }}
-        # run: npm ci
-        run: npm install
-
-      - name: Build
-        run: npm run build
-
-      - name: Test
-        run: npm run tests
-
-      - name: Publish
-        env:
-          <REGISTRY_AUTH_TOKEN_ENV_VAR>: ${{ 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
-```
+# Introduction
+
+This template scaffolds a ...
+
+## 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
+# placeholder:
+    # <TEMPLATE_PACKAGE_NAME: <TEMPLATE_PACKAGE_NAME>
+    # <TEMPLATE_NAME: <TEMPLATE_NAME>
+
+# print the latest version
+npm info "<TEMPLATE_PACKAGE_NAME>" version
+
+# create/update a package from the template in the current directory
+npm create --no-install --no-git "<TEMPLATE_NAME>@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
+
+```bash
+# placeholder:
+  # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
+  # <REGISTRY_ORIGIN_AND_PATH: <REGISTRY_ORIGIN_AND_PATH>
+    # registry.npmjs.org/
+    # forgejo.example.com/api/packages/<SCOPE_WITHOUT_AT>/npm/
+  # <REGISTRY_AUTH_TOKEN_ENV_VAR: <REGISTRY_AUTH_TOKEN_ENV_VAR>
+```
+
+`.npmrc`:
+
+```ini
+@<SCOPE_WITHOUT_AT>:registry=https://<REGISTRY_ORIGIN_AND_PATH>
+//<REGISTRY_ORIGIN_AND_PATH>:_authToken=${<REGISTRY_AUTH_TOKEN_ENV_VAR>}
+```
+
+or `bunfig.toml`:
+
+```toml
+[install.scopes]
+"<SCOPE_WITHOUT_AT>" = { url = "https://<REGISTRY_ORIGIN_AND_PATH>", token = "$<REGISTRY_AUTH_TOKEN_ENV_VAR>" }
+```
+
+```bash
+# <REGISTRY_ORIGIN_AND_PATH>
+export <REGISTRY_AUTH_TOKEN_ENV_VAR>=<AUTH_TOKEN>
+# or
+$env:<REGISTRY_AUTH_TOKEN_ENV_VAR> = "<AUTH_TOKEN>"
+npm publish
+```
+
+## CI/CD Workflows
+
+### NPM Build and Publish
+
+⚠️ `.npmrc` configuring the package registry and its authentication token is required for the workflow to work.
+
+|Parameter|Type|Description|
+|-----|-----|-----|
+|`NPM_RUNNER_LABEL`|Variable|The label of the runner to use for the workflow.|
+|`NPM_ACCESS_TOKEN`|Secret|The authentication token for the package registry.|
+
+```bash
+# placeholder:
+  # <REGISTRY_AUTH_TOKEN_ENV_VAR: <REGISTRY_AUTH_TOKEN_ENV_VAR>
+```
+
+`.github/workflows/npm-build-publish.yml`:
+
+```yaml
+name: NPM Build and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ${{ vars.NPM_RUNNER_LABEL }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install
+        env:
+          <REGISTRY_AUTH_TOKEN_ENV_VAR>: ${{ secrets.NPM_ACCESS_TOKEN }}
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm run tests
+
+      - name: Publish
+        env:
+          <REGISTRY_AUTH_TOKEN_ENV_VAR>: ${{ secrets.NPM_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/template/gitignore

@@ -1,8 +1,8 @@
-node_modules
-buildinfo.txt
-buildinfo-template.txt
-CHANGELOG-template.md
-README-template.md
-*.tsbuildinfo
-dist/
-example/
+node_modules
+buildinfo.txt
+buildinfo-template.txt
+CHANGELOG-template.md
+README-template.md
+*.tsbuildinfo
+dist/
+example/

package/dist/template/package.json

@@ -1,47 +1,52 @@
-{
-  "name": "",
-  "version": "0.0.0",
-  "description": "A template for ...",
-  "private": false,
-  "keywords": [
-    "typescript",
-    "template"
-  ],
-  "author": "",
-  "license": "",
-  "repository": {
-    "type": "git",
-    "url": ""
-  },
-  "type": "module",
-  "files": [
-    "dist/"
-  ],
-  "bin": "./dist/cli.bundle.js",
-  "exports": {
-    ".": {
-      "entrypoint": "./src/cli.ts"
-    }
-  },
-  "imports": {
-    "#src/*.js": "./src/*.ts"
-  },
-  "scripts": {
-    "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": "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",
-    "build": "npm run build:bundle",
-    "build:bundle": "tsx scripts/build-bundle.ts -- --omit-iife"
-  },
-  "devDependencies": {
-    "@types/node": "latest",
-    "esbuild": "latest",
-    "tsx": "latest",
-    "typescript": "^6.0.3"
-  }
+{
+  "name": "",
+  "version": "0.0.0",
+  "description": "A template for ...",
+  "private": false,
+  "keywords": [
+    "typescript",
+    "template"
+  ],
+  "author": "",
+  "license": "",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "type": "module",
+  "files": [
+    "dist/"
+  ],
+  "bin": {
+    "<BINARY_NAME>": "dist/cli.bundle.js"
+  },
+  "exports": {
+    ".": {
+      "entrypoint": "./src/cli.ts"
+    }
+  },
+  "imports": {
+    "#src/*.js": "./src/*.ts"
+  },
+  "scripts": {
+    "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": "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",
+    "build": "npm run build:bundle",
+    "build:bundle": "tsx scripts/build-bundle.ts -- --omit-iife"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "esbuild": "latest",
+    "tsx": "latest",
+    "typescript": "^6.0.3"
+  },
+  "allowScripts": {
+    "esbuild": true
+  }
 }