@jml6m/skeletor 0.1.0-alpha.2 → 0.1.0-alpha.6

package/README.md

@@ -25,20 +25,20 @@ Each template includes a `template.json` manifest that declares `verifyCommands`
 
 We use `@clack/prompts` for a modern experience:
 - Beautiful template selector with descriptions/hints when you omit `--template`
-- Prompts for owner and description (when running interactively without `--yes`)
+- Prompts for owner and description (interactive mode only)
 - Confirmation step
 - Proper cancel handling and nice spinners/intro/outro
 
-`--yes` stays fully non-interactive for scripts/CI.
+`--auto` stays fully non-interactive for scripts (requires `--template`). Pass `--owner` / `--description` on the CLI when scaffolding non-interactively.
 
 ## Pushing to GitHub
 
 **Pushing is not automatic.** After every set of changes (new templates, CLI updates, tests, docs), you **must** explicitly:
 1. `git add -A`
 2. `git commit -m "..."` (good message)
-3. `git push origin main`
+3. `git push -u origin HEAD`
 
-See the root `AGENTS.md` for the standing instruction given to agents working on this repo. This ensures the GitHub repo (`https://github.com/jml6m/skeletor`) stays in sync with every request. There is no special Grok Build setting that auto-pushes; it must be done via shell commands in the agent loop (or documented in project instructions like AGENTS.md).
+See the root `AGENTS.md` for the standing instruction given to agents working on this repo. This ensures the GitHub repo (`https://github.com/jml6m/skeletor`) stays in sync with every request. There is no special Grok Build setting that auto-pushes; it must be done via explicit git commands in the agent loop (or documented in project instructions like AGENTS.md).
 
 ## Usage (alpha)
 
@@ -47,18 +47,17 @@ See the root `AGENTS.md` for the standing instruction given to agents working on
 node src/index.js new my-project
 
 # Or specify
-node src/index.js new my-api --template typescript --owner jml6m
+node src/index.js new my-api --template typescript
 
-# Non-interactive (CI / scripts)
-npx @jml6m/skeletor new my-service --yes --template go
+# Non-interactive (scripts)
+npx @jml6m/skeletor new my-service --auto --template go --owner jml6m --description "My service"
 ```
 
 Common flags:
 - `--template <id>` (javascript, typescript, python, go, rust, java, csharp, ...)
-- `--owner`
-- `--description`
-- `--yes` (skip all prompts)
-- `--no-git`
+- `--owner <user>` / `--description <text>` (for `--auto`, or as interactive defaults)
+- `--auto` (skip all prompts; requires `--template`)
+- `--no-git` (skip git init; git is on by default)
 
 After scaffolding, follow the `verifyCommands` from that template's `template.json` (shown in the success message). E.g. for most JS/TS: `npm install && npm run health:full` etc.
 
@@ -84,7 +83,7 @@ Run `skeletor` (or `node src/index.js`) with no args for current help and templa
 
 ```bash
 # From a clone of this repo
-node src/index.js new my-test-project --yes
+node src/index.js new my-test-project --auto --template javascript
 
 cd my-test-project
 npm install
@@ -124,6 +123,7 @@ The source of truth lives in `templates/<id>/` (each with its own `template.json
 
 - Edit files inside an existing template → next generation gets the change.
 - Add a whole new `templates/newlang/` with `template.json` + files → it appears in the picker, help, and tests automatically.
+- **Ecosystem manifest files** (e.g. `package.json`, `pyproject.toml`, `Cargo.toml`, `pom.xml`, `*.csproj`, `go.mod`) must be named with a `.tmpl` suffix inside the template (e.g. `package.json.tmpl`). The generator strips the suffix on output, so the generated project sees the conventional filename. This prevents GitHub's dependency graph from treating template dependencies as skeletor's own.
 
 Always run `npm test` after template work.
 
@@ -133,7 +133,7 @@ When happy, commit + push (see root `AGENTS.md` for the standing rule).
 
 Pushing is **explicit** (not automatic). After changes:
 - Run tests
-- `git add -A && git commit -m "..." && git push origin main`
+- `git add -A && git commit -m "..." && git push -u origin HEAD`
 
 See the root `AGENTS.md` (the instruction file for agents) for the exact rule.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jml6m/skeletor",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.6",
   "description": "Efficient scaffolding for custom development. Generates projects wired with personal lint/format/health/release/alias/AGENTS.md conventions.",
   "main": "src/index.js",
   "type": "module",
@@ -9,7 +9,25 @@
   },
   "scripts": {
     "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js",
-    "test:watch": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --watch"
+    "test:watch": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --watch",
+    "lint": "npm run lint:encoding",
+    "lint:encoding": "node scripts/check-encoding.mjs",
+    "audit:ci": "node scripts/audit-ci.mjs",
+    "npm:reinstall": "node scripts/reinstall.mjs",
+    "git:pull": "node scripts/git-pull-all.mjs",
+    "release:patch": "npm version patch && git push --follow-tags",
+    "release:minor": "npm version minor && git push --follow-tags",
+    "release:major": "npm version major && git push --follow-tags",
+    "release:alpha": "npm version prerelease --preid=alpha && git push --follow-tags",
+    "publish:dry": "npm publish --dry-run",
+    "prepublishOnly": "npm run lint && npm run audit:ci && npm test"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jml6m/skeletor.git"
   },
   "files": [
     "src",
@@ -26,7 +44,7 @@
     "knip"
   ],
   "dependencies": {
-    "@clack/prompts": "^0.9.0"
+    "@clack/prompts": "^1.5.1"
   },
   "devDependencies": {
     "jest": "^29.7.0"
@@ -35,8 +53,5 @@
   "license": "ISC",
   "engines": {
     "node": ">=20.19.0"
-  },
-  "dependencies": {
-    "@clack/prompts": "^1.5.1"
   }
 }

package/src/index.js

@@ -24,17 +24,19 @@ Usage:
   skeletor --help
 
 Options:
-  --template <name>     Template to use (e.g. javascript, typescript, python)
-                        Omit to choose interactively (or use --yes for default)
-  --owner <user>        GitHub owner/org for release scripts (default: jml6m)
-  --description <text>  Short project description
-  --yes                 Non-interactive, use defaults + first available template
-  --no-git              Skip git init
+  --template <name>     Stack to scaffold (javascript, typescript, python, go, …)
+                        Omit for an interactive language/stack picker (TTY required)
+  --owner <user>        GitHub owner/org (default: jml6m; used with --auto or as
+                        interactive defaults)
+  --description <text>  Project description (default: generic skeletor blurb)
+  --auto                Non-interactive; requires --template
+  --no-git              Skip git init (git is initialized by default)
 
 Examples:
+  skeletor new my-api                    # interactive: pick stack, owner, description
   skeletor new my-api --template typescript
-  skeletor new my-lib --yes
-  skeletor new my-tool
+  skeletor new my-lib --auto --template go --owner jml6m --description "My CLI tool"
+  skeletor new my-lib --auto --template go --no-git
 `;
 
 
@@ -47,9 +49,9 @@ function parseArgs(argv) {
     command: null,
     name: null,
     template: null, // resolved later, can be interactive
-    owner: 'jml6m',
-    description: 'A new project scaffolded with skeletor.',
-    yes: false,
+    owner: null,
+    description: null,
+    auto: false,
     git: true,
   };
 
@@ -64,9 +66,9 @@ function parseArgs(argv) {
     for (let i = 2; i < args.length; i++) {
       const a = args[i];
       if (a === '--template' || a === '-t') result.template = args[++i] || null;
-      else if (a === '--owner' || a === '-o') result.owner = args[++i] || 'jml6m';
-      else if (a === '--description' || a === '-d') result.description = args[++i] || result.description;
-      else if (a === '--yes' || a === '-y') result.yes = true;
+      else if (a === '--owner' || a === '-o') result.owner = args[++i] || null;
+      else if (a === '--description' || a === '-d') result.description = args[++i] || null;
+      else if (a === '--auto') result.auto = true;
       else if (a === '--no-git') result.git = false;
       else if (!a.startsWith('-') && !result.name) result.name = a;
     }
@@ -86,6 +88,29 @@ function render(content, vars) {
   return out;
 }
 
+/** Sanitize a segment for use in Java groupId / Go module paths. */
+function sanitizeIdentifierSegment(value) {
+  return String(value).replace(/[^a-zA-Z0-9]/g, '').toLowerCase() || 'example';
+}
+
+/** Build the full token map passed to copyAndRender. */
+function buildRenderVars({ name, owner, description }) {
+  const repoOwner = owner || 'jml6m';
+  const ownerSegment = sanitizeIdentifierSegment(repoOwner);
+  const namespace = String(name).replace(/-/g, '_');
+  return {
+    PROJECT_NAME: name,
+    REPO_OWNER: repoOwner,
+    REPO_NAME: name,
+    DESCRIPTION: description || 'A new project scaffolded with skeletor.',
+    YEAR: new Date().getFullYear(),
+    NAMESPACE: namespace,
+    GROUP_ID: `io.github.${ownerSegment}`,
+    GO_MODULE: `github.com/${repoOwner}/${name}`,
+    REPO_URL: `https://github.com/${repoOwner}/${name}`,
+  };
+}
+
 function ensureDir(dir) {
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir, { recursive: true });
@@ -97,9 +122,11 @@ function copyAndRender(src, dest, vars) {
   if (stat.isDirectory()) {
     ensureDir(dest);
     for (const entry of fs.readdirSync(src)) {
-      // never copy node_modules or .git inside templates
-      if (entry === 'node_modules' || entry === '.git') continue;
-      copyAndRender(path.join(src, entry), path.join(dest, entry), vars);
+      // never copy node_modules, .git, or skeletor manifest inside templates
+      if (entry === 'node_modules' || entry === '.git' || entry === 'template.json') continue;
+      // strip .tmpl suffix from output filename so e.g. package.json.tmpl → package.json
+      const outEntry = entry.endsWith('.tmpl') ? entry.slice(0, -'.tmpl'.length) : entry;
+      copyAndRender(path.join(src, entry), path.join(dest, outEntry), vars);
     }
     return;
   }
@@ -145,13 +172,9 @@ function getTemplatesWithManifests() {
   return ids.map((id) => loadTemplateManifest(id));
 }
 
-async function chooseTemplateInteractively(templates, isYes) {
-  if (isYes || templates.length === 0) {
-    return templates[0] ? templates[0].id : null;
-  }
-
-  if (!process.stdout.isTTY) {
-    return templates[0] ? templates[0].id : null;
+async function chooseTemplateInteractively(templates) {
+  if (templates.length === 0) {
+    return null;
   }
 
   p.intro('💀 Skeletor — pick your scaffolding');
@@ -163,7 +186,7 @@ async function chooseTemplateInteractively(templates, isYes) {
   }));
 
   const selected = await p.select({
-    message: 'Choose a template',
+    message: 'What language or stack are you building?',
     options,
   });
 
@@ -175,8 +198,11 @@ async function chooseTemplateInteractively(templates, isYes) {
   return selected;
 }
 
+const DEFAULT_OWNER = 'jml6m';
+const DEFAULT_DESCRIPTION = 'A new project scaffolded with skeletor.';
+
 async function runNew(opts) {
-  const { name, git, yes } = opts;
+  const { name, git, auto } = opts;
 
   if (!name || name === '.' || name === '..') {
     logError('❌ Please provide a valid project name (e.g. "my-api").');
@@ -190,13 +216,28 @@ async function runNew(opts) {
   }
 
   let chosenTemplateId = opts.template;
-  let finalOwner = opts.owner || 'jml6m';
-  let finalDesc = opts.description || 'A new project scaffolded with skeletor.';
+  let finalOwner = opts.owner || DEFAULT_OWNER;
+  let finalDesc = opts.description || DEFAULT_DESCRIPTION;
 
-  const isInteractive = !yes && process.stdout.isTTY;
+  const isInteractive = !auto && process.stdout.isTTY;
 
   if (!chosenTemplateId) {
-    chosenTemplateId = await chooseTemplateInteractively(allTemplates, yes);
+    if (auto) {
+      logError('❌ --auto requires --template <id>. Pick a stack interactively by omitting --auto.');
+      logError(`   Available: ${allTemplates.map((t) => t.id).join(', ')}`);
+      process.exit(1);
+    }
+    if (!process.stdout.isTTY) {
+      logError('❌ No --template provided and this is not an interactive terminal.');
+      logError('   Use --auto --template <id> for scripts and piped environments.');
+      logError(`   Available: ${allTemplates.map((t) => t.id).join(', ')}`);
+      process.exit(1);
+    }
+    chosenTemplateId = await chooseTemplateInteractively(allTemplates);
+  } else if (!process.stdout.isTTY && !auto) {
+    logError('❌ --template requires --auto when not running in an interactive terminal.');
+    logError(`   Example: skeletor new ${name} --auto --template ${chosenTemplateId}`);
+    process.exit(1);
   }
 
   const templateInfo = allTemplates.find((t) => t.id === chosenTemplateId);
@@ -206,7 +247,7 @@ async function runNew(opts) {
     process.exit(1);
   }
 
-  // Richer interactive prompts for missing details (only when not --yes)
+  // Owner, description, and confirm — interactive only (--auto uses defaults above)
   if (isInteractive) {
     const ownerInput = await p.text({
       message: 'GitHub owner / org',
@@ -240,14 +281,7 @@ async function runNew(opts) {
     process.exit(1);
   }
 
-  const repoName = name;
-  const vars = {
-    PROJECT_NAME: name,
-    REPO_OWNER: finalOwner,
-    REPO_NAME: repoName,
-    DESCRIPTION: finalDesc,
-    YEAR: new Date().getFullYear(),
-  };
+  const vars = buildRenderVars({ name, owner: finalOwner, description: finalDesc });
 
   p.log.info(`Creating "${name}" using ${templateInfo.name}...`);
 
@@ -266,12 +300,17 @@ async function runNew(opts) {
 
   p.outro('✅ Done!');
 
-  console.log(`   cd ${name}`);
-  const suggested = templateInfo.verifyCommands && templateInfo.verifyCommands.length
-    ? templateInfo.verifyCommands[0]
-    : 'Run your language-specific install + test commands';
-  console.log(`   ${suggested}`);
-  console.log('   Then run the other steps from the template manifest (lint, test, etc.)');
+  printPostScaffoldSteps(name, templateInfo.verifyCommands);
+}
+
+/** Print cd + full verifyCommands list after scaffolding. */
+function printPostScaffoldSteps(projectName, verifyCommands) {
+  console.log(`   cd ${projectName}`);
+  const steps = Array.isArray(verifyCommands) && verifyCommands.length
+    ? verifyCommands
+    : ['Run your language-specific install + test commands'];
+  console.log('   Next steps:');
+  steps.forEach((cmd) => console.log(`     ${cmd}`));
   console.log('\n   Edit AGENTS.md (or equivalent) to customize the AI contract.');
   console.log('   Happy scaffolding. Your rules, your choice of stack.\n');
 }
@@ -303,12 +342,15 @@ function main() {
 export {
   parseArgs,
   render,
+  buildRenderVars,
+  sanitizeIdentifierSegment,
   getAvailableTemplates,
   getTemplatesWithManifests,
   loadTemplateManifest,
   ensureDir,
   copyAndRender,
   runNew,
+  printPostScaffoldSteps,
   USAGE,
 };
 

package/templates/csharp/.gitignore.tmpl

@@ -0,0 +1,16 @@
+bin/
+obj/
+*.user
+*.suo
+*.userosscache
+*.sln.docstates
+
+# Env
+.env
+.env.*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/

package/templates/csharp/Program.cs

@@ -1,7 +1,7 @@
 // {{PROJECT_NAME}}
 // {{DESCRIPTION}}
 
-namespace {{PROJECT_NAME | replace('-', '_')}};
+namespace {{NAMESPACE}};
 
 class Program
 {

package/templates/csharp/ProgramTests.cs

@@ -1,6 +1,6 @@
 using Xunit;
 
-namespace {{PROJECT_NAME | replace('-', '_')}};
+namespace {{NAMESPACE}};
 
 public class ProgramTests
 {

package/templates/csharp/{{{PROJECT_NAME}}.csproj → Project.csproj.tmpl}

@@ -5,7 +5,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-    <RootNamespace>{{PROJECT_NAME | replace('-', '_')}}</RootNamespace>
+    <RootNamespace>{{NAMESPACE}}</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>

package/templates/go/.gitignore.tmpl

@@ -0,0 +1,24 @@
+# Binaries
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+{{PROJECT_NAME}}
+
+# Test binary
+*.test
+
+# Output
+bin/
+dist/
+
+# Env
+.env
+.env.*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/

package/templates/go/{go.mod → go.mod.tmpl}

@@ -1,4 +1,4 @@
-module {{PROJECT_NAME}}
+module {{GO_MODULE}}
 
 go 1.22
 

package/templates/java/.gitignore.tmpl

@@ -0,0 +1,16 @@
+target/
+*.class
+*.jar
+*.war
+*.ear
+hs_err_pid*
+
+# Env
+.env
+.env.*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/

package/templates/java/{pom.xml → pom.xml.tmpl}

@@ -3,7 +3,7 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>com.example</groupId>
+    <groupId>{{GROUP_ID}}</groupId>
     <artifactId>{{PROJECT_NAME}}</artifactId>
     <version>0.1.0</version>
     <packaging>jar</packaging>

package/templates/java/src/main/java/{com/example → app}/App.java

@@ -1,4 +1,4 @@
-package com.example;
+package app;
 
 /**
  * {{PROJECT_NAME}}
@@ -13,4 +13,4 @@ public class App {
     public static String hello(String name) {
         return String.format("Hello, %s from {{PROJECT_NAME}}!", name);
     }
-}
+}

package/templates/java/src/test/java/{com/example → app}/AppTest.java

@@ -1,4 +1,4 @@
-package com.example;
+package app;
 
 import org.junit.jupiter.api.Test;
 import static org.junit.jupiter.api.Assertions.*;
@@ -9,4 +9,4 @@ class AppTest {
     void helloReturnsGreeting() {
         assertEquals("Hello, tester from {{PROJECT_NAME}}!", App.hello("tester"));
     }
-}
+}

package/templates/javascript/.gitignore.tmpl

@@ -0,0 +1,31 @@
+# Dependencies
+node_modules/
+
+# Build / output
+dist/
+build/
+coverage/
+report/
+reports/
+
+# Env & secrets
+.env
+.env.*
+*.local
+
+# Logs
+*.log
+logs/
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+*.swp
+
+# Lockfiles that may be noisy in some flows (keep package-lock.json in real projects)
+# package-lock.json
+
+# Generated context for AI
+prompt.md

package/templates/javascript/.jscpd.json

@@ -0,0 +1,13 @@
+{
+  "threshold": 5,
+  "reporters": ["html", "console"],
+  "ignore": ["**/node_modules/**", "**/dist/**", "**/build/**", "**/*.spec.ts", "**/*.test.ts"],
+  "absolute": true,
+  "gitignore": true,
+  "minLines": 5,
+  "minTokens": 50,
+  "formatsExts": {
+    "javascript": ["js", "jsx"],
+    "typescript": ["ts", "tsx"]
+  }
+}

package/templates/python/.gitignore.tmpl

@@ -0,0 +1,27 @@
+# Bytecode / cache
+__pycache__/
+*.py[cod]
+*.pyo
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Build / packaging
+dist/
+build/
+*.egg-info/
+
+# Env & secrets
+.env
+.env.*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/

package/templates/python/{pyproject.toml → pyproject.toml.tmpl}

@@ -6,7 +6,7 @@ readme = "README.md"
 requires-python = ">=3.11"
 license = {text = "UNLICENSED"}
 authors = [
-  {name = "Your Name", email = "you@example.com"}
+  {name = "{{REPO_OWNER}}"}
 ]
 dependencies = []
 

package/templates/python/template.json

@@ -7,6 +7,7 @@
     "python -m pip install -e '.[dev]' --quiet",
     "python -m ruff format --check .",
     "python -m ruff check .",
-    "python -m pytest -q"
+    "python -m pytest -q",
+    "python -m mypy src"
   ]
 }

package/templates/rust/.gitignore.tmpl

@@ -0,0 +1,14 @@
+/target/
+**/*.rs.bk
+*.pdb
+Cargo.lock
+
+# Env
+.env
+.env.*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/

package/templates/rust/{Cargo.toml → Cargo.toml.tmpl}

@@ -3,6 +3,7 @@ name = "{{PROJECT_NAME}}"
 version = "0.1.0"
 edition = "2021"
 description = "{{DESCRIPTION}}"
+repository = "{{REPO_URL}}"
 
 [dependencies]
 

package/templates/typescript/.gitignore.tmpl

@@ -0,0 +1,31 @@
+# Dependencies
+node_modules/
+
+# Build / output
+dist/
+build/
+coverage/
+report/
+reports/
+
+# Env & secrets
+.env
+.env.*
+*.local
+
+# Logs
+*.log
+logs/
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+*.swp
+
+# Lockfiles that may be noisy in some flows (keep package-lock.json in real projects)
+# package-lock.json
+
+# Generated context for AI
+prompt.md

package/templates/typescript/.jscpd.json

@@ -0,0 +1,13 @@
+{
+  "threshold": 5,
+  "reporters": ["html", "console"],
+  "ignore": ["**/node_modules/**", "**/dist/**", "**/build/**", "**/*.spec.ts", "**/*.test.ts"],
+  "absolute": true,
+  "gitignore": true,
+  "minLines": 5,
+  "minTokens": 50,
+  "formatsExts": {
+    "javascript": ["js", "jsx"],
+    "typescript": ["ts", "tsx"]
+  }
+}