create-rigorail 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ahmed Tolan
+
+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,3 +1,16 @@
-# Temporary Holding Version
+# create-rigorail
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Create a new [Rigorail](https://github.com/ahmedtolan2019/rigorail) project:
+vibe coding with engineered React frontends.
+
+```sh
+npm create rigorail@latest my-app
+cd my-app
+npm install
+npm run dev
+```
+
+Options (after `--`): `--ref <branch|tag>` picks a template version, `--install`
+runs `npm install`, `--no-git` skips the initial commit.
+
+MIT © Ahmed Tolan

package/index.mjs

@@ -0,0 +1,200 @@
+#!/usr/bin/env node
+// Creates a new project from the Rigorail template:
+//   npm create rigorail@latest my-app
+// Downloads the template from GitHub, renames the package, initializes git and
+// prints the next steps. No dependencies: Node 20+ with fetch and the system tar.
+import { spawnSync } from 'node:child_process'
+import {
+  existsSync,
+  mkdirSync,
+  readdirSync,
+  readFileSync,
+  rmSync,
+  writeFileSync,
+} from 'node:fs'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
+import { createInterface } from 'node:readline/promises'
+import { fileURLToPath } from 'node:url'
+
+export const REPOSITORY = 'ahmedtolan2019/rigorail'
+const HELP = `Usage: npm create rigorail@latest [directory] [-- options]
+
+Options:
+  --ref <branch|tag>  Template version to use (default: main)
+  --install           Run npm install after creating the project
+  --no-git            Do not initialize a git repository
+  -h, --help          Show this help`
+
+/** Parses CLI arguments into { directory, ref, install, git, help }. */
+export function parseArgs(argv) {
+  const options = {
+    directory: '',
+    ref: 'main',
+    install: false,
+    git: true,
+    help: false,
+  }
+  for (let index = 0; index < argv.length; index++) {
+    const arg = argv[index]
+    if (arg === '-h' || arg === '--help') options.help = true
+    else if (arg === '--install') options.install = true
+    else if (arg === '--no-git') options.git = false
+    else if (arg === '--ref') options.ref = argv[++index] ?? ''
+    else if (arg.startsWith('--ref=')) options.ref = arg.slice(6)
+    else if (arg.startsWith('-')) throw new Error(`Unknown option: ${arg}`)
+    else if (!options.directory) options.directory = arg
+    else throw new Error(`Unexpected argument: ${arg}`)
+  }
+  if (!options.ref) throw new Error('--ref needs a branch or tag name.')
+  return options
+}
+
+/** npm package names: lowercase, URL-safe, no leading dot or underscore. */
+export function toPackageName(directory) {
+  const name = path
+    .basename(path.resolve(directory))
+    .toLowerCase()
+    .replace(/[^a-z0-9._-]+/g, '-')
+    .replace(/^[._-]+|[-]+$/g, '')
+  return name || 'my-app'
+}
+
+/** Turns the template's package.json into the new project's own manifest. */
+export function personalizePackage(manifest, name) {
+  const next = { ...manifest, name, version: '0.1.0', private: true }
+  for (const key of [
+    'description',
+    'author',
+    'homepage',
+    'repository',
+    'bugs',
+    'keywords',
+  ])
+    delete next[key]
+  // The initializer is removed from new projects, so drop its test from the gate.
+  if (next.scripts)
+    next.scripts = Object.fromEntries(
+      Object.entries(next.scripts).map(([key, value]) => [
+        key,
+        value.replace(/\s+packages\/create-rigorail\/\S+/g, ''),
+      ]),
+    )
+  return next
+}
+
+/** Template-maintainer files that would point a new project at the Rigorail repo. */
+export const MAINTAINER_FILES = [
+  'packages/create-rigorail',
+  '.github/workflows/publish-create.yml',
+  '.github/FUNDING.yml',
+  '.github/ISSUE_TEMPLATE/config.yml',
+  'SECURITY.md',
+  'CODE_OF_CONDUCT.md',
+]
+
+async function askDirectory() {
+  const prompt = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  })
+  const answer = await prompt.question('Project directory (my-app): ')
+  prompt.close()
+  return answer.trim() || 'my-app'
+}
+
+function run(command, args, cwd) {
+  const result = spawnSync(command, args, {
+    cwd,
+    stdio: 'inherit',
+    shell: process.platform === 'win32',
+  })
+  return result.status === 0
+}
+
+async function main() {
+  const options = parseArgs(process.argv.slice(2))
+  if (options.help) {
+    console.log(HELP)
+    return
+  }
+  const directory = options.directory || (await askDirectory())
+  const target = path.resolve(directory)
+  if (existsSync(target) && readdirSync(target).length)
+    throw new Error(
+      `${directory} is not empty. Choose a new or empty directory.`,
+    )
+
+  // RIGORAIL_ARCHIVE points at a local .tar.gz (testing or offline mirrors).
+  const local = process.env.RIGORAIL_ARCHIVE
+  const archive = local ?? path.join(tmpdir(), `rigorail-${process.pid}.tar.gz`)
+  if (!local) {
+    const url = `https://codeload.github.com/${REPOSITORY}/tar.gz/${encodeURIComponent(options.ref)}`
+    console.log(`Downloading Rigorail (${options.ref})...`)
+    const response = await fetch(url)
+    if (!response.ok)
+      throw new Error(
+        `Download failed (${response.status}). Check --ref and your connection.`,
+      )
+    writeFileSync(archive, Buffer.from(await response.arrayBuffer()))
+  }
+  mkdirSync(target, { recursive: true })
+  try {
+    if (!run('tar', ['-xzf', archive, '-C', target, '--strip-components=1']))
+      throw new Error('Could not extract the template. Is tar available?')
+  } finally {
+    if (!local) rmSync(archive, { force: true })
+  }
+
+  // Maintainer-only files (initializer, sponsor button, publish workflow...) belong
+  // to the template, not to the new project.
+  for (const file of MAINTAINER_FILES)
+    rmSync(path.join(target, file), { recursive: true, force: true })
+  if (
+    existsSync(path.join(target, 'packages')) &&
+    !readdirSync(path.join(target, 'packages')).length
+  )
+    rmSync(path.join(target, 'packages'), { recursive: true, force: true })
+  const manifestPath = path.join(target, 'package.json')
+  const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'))
+  writeFileSync(
+    manifestPath,
+    JSON.stringify(
+      personalizePackage(manifest, toPackageName(directory)),
+      null,
+      2,
+    ) + '\n',
+  )
+
+  if (options.git && run('git', ['init', '-q'], target)) {
+    run('git', ['add', '-A'], target)
+    run(
+      'git',
+      ['commit', '-q', '-m', 'chore: start from the Rigorail template'],
+      target,
+    )
+  }
+  if (options.install) run('npm', ['install'], target)
+
+  const relative = path.relative(process.cwd(), target) || '.'
+  const cd = /\s/.test(relative) ? `"${relative}"` : relative
+  console.log(`
+Created ${relative}.
+
+Next steps:
+  cd ${cd}
+  ${options.install ? '' : 'npm install\n  '}npm run dev          # http://localhost:5173, demo data, no backend needed
+
+Then open it with your coding agent and start with:
+  "Read AGENTS.md, run npm run check, and summarize how this project is organized."
+Prompts for common tasks: README.md#prompts-for-your-agent`)
+}
+
+if (
+  process.argv[1] &&
+  path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)
+)
+  main().catch((error) => {
+    console.error(`\n${error instanceof Error ? error.message : error}`)
+    process.exitCode = 1
+  })

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "create-rigorail",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Create a Rigorail project: vibe coding with engineered React frontends for developers and AI coding agents.",
+  "type": "module",
+  "bin": {
+    "create-rigorail": "index.mjs"
+  },
+  "files": [
+    "index.mjs",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "rigorail",
+    "create-rigorail",
+    "react",
+    "typescript",
+    "vite",
+    "frontend-template",
+    "ai-agents",
+    "vibe-coding",
+    "enterprise",
+    "rtl"
+  ],
+  "author": "Ahmed Tolan",
+  "license": "MIT",
+  "homepage": "https://github.com/ahmedtolan2019/rigorail#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ahmedtolan2019/rigorail.git",
+    "directory": "packages/create-rigorail"
+  },
+  "bugs": {
+    "url": "https://github.com/ahmedtolan2019/rigorail/issues"
+  }
+}