@temir.ra/create-oci-compose 0.1.0-pre.2

package/LICENSE

@@ -0,0 +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
+SOFTWARE.

package/README.md

@@ -0,0 +1,148 @@
+# 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: @temir.ra/create-oci-compose
+    # <TEMPLATE_NAME: @temir.ra/oci-compose
+
+# print the latest version
+npm info "@temir.ra/create-oci-compose" version
+
+# create/update a package from the template in the current directory
+npm create --no-install --no-git "@temir.ra/oci-compose@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

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

package/dist/buildinfo-template.txt

@@ -0,0 +1 @@
+0.6.0+35a0356

package/dist/buildinfo.txt

@@ -0,0 +1 @@
+0.1.0-pre.2+81de98f

package/dist/cli.bundle.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import{cpSync as n,readFileSync as U,renameSync as d,writeFileSync as u}from"node:fs";import{resolve as r}from"node:path";var i=new URL("../",import.meta.url),a=new URL("dist/",i),l=new URL("buildinfo.txt",a),m=new URL("CHANGELOG.md",a),p=new URL("README.md",i),g=new URL("template/",a);try{let t=process.argv[2];if(!t)throw new Error('First argument must be the package name (e.g. "my-package" or "@my-scope/my-package").');let o=t.replace(/\\/g,"/"),e=r(process.cwd(),o);n(g,e,{recursive:!0}),n(m,r(e,"CHANGELOG-template.md")),n(l,r(e,"buildinfo-template.txt")),n(p,r(e,"README-template.md"));let c=r(e,"package.json"),s=JSON.parse(U(c,"utf-8"));s.name=o,u(c,JSON.stringify(s,null,2)),d(r(e,"gitignore"),r(e,".gitignore")),console.log(`Template has been successfully instantiated at '${e}' with package name '${o}'.`)}catch(t){let o=t instanceof Error?t:new Error(String(t));console.error("Error:",o.message),process.exit(1)}

package/dist/cli.bundle.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/cli.ts", "../src/package-urls.ts"],
+  "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/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@temir.ra/create-oci-compose",
+  "version": "0.1.0-pre.2",
+  "description": "A template for an OCI Compose package.",
+  "private": false,
+  "keywords": [
+    "typescript",
+    "template",
+    "oci",
+    "compose"
+  ],
+  "author": "temir.ra",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://git.chimps.quest/trs/create-oci-compose.git"
+  },
+  "type": "module",
+  "files": [
+    "dist/"
+  ],
+  "bin": {
+    "create-oci-compose": "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
+  }
+}