@i-santos/create-package-starter 0.1.0

package/README.md

@@ -0,0 +1,34 @@
+# @i-santos/create-package-starter
+
+Scaffold new npm packages with a consistent release workflow.
+
+## Install / Run
+
+```bash
+npx @i-santos/create-package-starter --name hello-package
+npx @i-santos/create-package-starter --name @i-santos/swarm
+```
+
+## Options
+
+- `--name <name>` (required, supports `pkg` and `@scope/pkg`)
+- `--out <directory>` (default: current directory)
+- `--release-cli-pkg <package>` (default: `@i-santos/release-cli`)
+- `--release-cli-version <version>` (default: `^0.1.0`)
+
+## Output
+
+Generated package includes:
+
+- `release:beta`
+- `release:stable`
+- `release:publish`
+- `registry:start`
+
+plus a minimal README, CHANGELOG, `.gitignore`, and check script.
+
+## Notes
+
+- For scoped names, folder uses the short package name.
+  - Example: `@i-santos/swarm` creates `./swarm`.
+- Template follows `npm init -y` behavior by default (no `private` field).

package/bin/create-package-starter.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+const { run } = require('../lib/run');
+
+run(process.argv.slice(2)).catch((error) => {
+  console.error(error.message);
+  process.exit(1);
+});

package/lib/run.js

@@ -0,0 +1,154 @@
+const fs = require('fs');
+const path = require('path');
+
+const DEFAULT_RELEASE_CLI_PKG = '@i-santos/release-cli';
+const DEFAULT_RELEASE_CLI_VERSION = '^0.1.0';
+
+function usage() {
+  return [
+    'Uso:',
+    '  create-package-starter --name <nome> [--out <diretorio>] [--release-cli-pkg <pkg>] [--release-cli-version <versao>]',
+    '',
+    'Exemplo:',
+    '  create-package-starter --name hello-package',
+    '  create-package-starter --name @i-santos/swarm',
+    '  create-package-starter --name hello-package --out ./packages',
+    '  create-package-starter --name hello-package --release-cli-pkg @i-santos/release-cli --release-cli-version ^1.0.0'
+  ].join('\n');
+}
+
+function parseArgs(argv) {
+  const args = {
+    out: process.cwd(),
+    releaseCliPkg: DEFAULT_RELEASE_CLI_PKG,
+    releaseCliVersion: DEFAULT_RELEASE_CLI_VERSION
+  };
+
+  for (let i = 0; i < argv.length; i += 1) {
+    const token = argv[i];
+
+    if (token === '--name') {
+      args.name = argv[i + 1];
+      i += 1;
+      continue;
+    }
+
+    if (token === '--out') {
+      args.out = argv[i + 1];
+      i += 1;
+      continue;
+    }
+
+    if (token === '--release-cli-pkg') {
+      args.releaseCliPkg = argv[i + 1];
+      i += 1;
+      continue;
+    }
+
+    if (token === '--release-cli-version') {
+      args.releaseCliVersion = argv[i + 1];
+      i += 1;
+      continue;
+    }
+
+    if (token === '--help' || token === '-h') {
+      args.help = true;
+      continue;
+    }
+
+    throw new Error(`Argumento inválido: ${token}\n\n${usage()}`);
+  }
+
+  return args;
+}
+
+function validateName(name) {
+  if (typeof name !== 'string') {
+    return false;
+  }
+
+  const plain = /^[a-z0-9][a-z0-9._-]*$/;
+  const scoped = /^@[a-z0-9][a-z0-9._-]*\/[a-z0-9][a-z0-9._-]*$/;
+  return plain.test(name) || scoped.test(name);
+}
+
+function packageDirFromName(packageName) {
+  const parts = packageName.split('/');
+  return parts[parts.length - 1];
+}
+
+function copyDirRecursive(sourceDir, targetDir) {
+  fs.mkdirSync(targetDir, { recursive: true });
+  const entries = fs.readdirSync(sourceDir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(sourceDir, entry.name);
+    const destPath = path.join(targetDir, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDirRecursive(srcPath, destPath);
+      continue;
+    }
+
+    fs.copyFileSync(srcPath, destPath);
+  }
+}
+
+function renderTemplateFile(filePath, variables) {
+  const source = fs.readFileSync(filePath, 'utf8');
+  const output = source
+    .replace(/__PACKAGE_NAME__/g, variables.packageName)
+    .replace(/__RELEASE_CLI_PKG__/g, variables.releaseCliPkg)
+    .replace(/__RELEASE_CLI_VERSION__/g, variables.releaseCliVersion);
+
+  fs.writeFileSync(filePath, output);
+}
+
+async function run(argv) {
+  const args = parseArgs(argv);
+
+  if (args.help) {
+    console.log(usage());
+    return;
+  }
+
+  if (!validateName(args.name)) {
+    throw new Error('Erro: informe um nome válido com --name (ex: hello-package ou @i-santos/swarm).');
+  }
+
+  if (!args.releaseCliPkg || !args.releaseCliVersion) {
+    throw new Error('Erro: --release-cli-pkg e --release-cli-version devem ser informados corretamente.');
+  }
+
+  const packageRoot = path.resolve(__dirname, '..');
+  const templateDir = path.join(packageRoot, 'template');
+
+  if (!fs.existsSync(templateDir)) {
+    throw new Error(`Erro: template não encontrado em ${templateDir}`);
+  }
+
+  const outputDir = path.resolve(args.out);
+  const targetDir = path.join(outputDir, packageDirFromName(args.name));
+
+  if (fs.existsSync(targetDir)) {
+    throw new Error(`Erro: diretório já existe: ${targetDir}`);
+  }
+
+  copyDirRecursive(templateDir, targetDir);
+
+  renderTemplateFile(path.join(targetDir, 'package.json'), {
+    packageName: args.name,
+    releaseCliPkg: args.releaseCliPkg,
+    releaseCliVersion: args.releaseCliVersion
+  });
+
+  renderTemplateFile(path.join(targetDir, 'README.md'), {
+    packageName: args.name,
+    releaseCliPkg: args.releaseCliPkg,
+    releaseCliVersion: args.releaseCliVersion
+  });
+
+  console.log(`Pacote criado em ${targetDir}`);
+}
+
+module.exports = { run };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@i-santos/create-package-starter",
+  "version": "0.1.0",
+  "description": "Scaffold new npm packages with standardized release scripts",
+  "license": "MIT",
+  "author": "Igor Santos",
+  "homepage": "https://github.com/i-santos/package-starter#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/i-santos/package-starter.git",
+    "directory": "packages/create-package-starter"
+  },
+  "bugs": {
+    "url": "https://github.com/i-santos/package-starter/issues"
+  },
+  "keywords": [
+    "scaffold",
+    "npm",
+    "starter",
+    "cli",
+    "template"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "create-package-starter": "bin/create-package-starter.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "template",
+    "README.md"
+  ],
+  "scripts": {
+    "check": "node scripts/check.js"
+  }
+}

package/template/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Estrutura inicial do pacote.

package/template/README.md

@@ -0,0 +1,15 @@
+# __PACKAGE_NAME__
+
+Pacote criado pelo `@i-santos/create-package-starter`.
+
+## Comandos
+
+- `npm run check`
+- `npm run registry:start`
+- `npm run release:beta`
+- `npm run release:stable`
+- `npm run release:publish`
+
+## Dependência de release
+
+Este pacote foi gerado para usar `__RELEASE_CLI_PKG__@__RELEASE_CLI_VERSION__`.

package/template/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "__PACKAGE_NAME__",
+  "version": "0.1.0",
+  "description": "Pacote gerado pelo create-package-starter",
+  "scripts": {
+    "check": "node scripts/check.js",
+    "release:beta": "release-cli beta",
+    "release:stable": "release-cli stable",
+    "release:publish": "release-cli publish",
+    "registry:start": "release-cli registry http://127.0.0.1:4873"
+  },
+  "devDependencies": {
+    "__RELEASE_CLI_PKG__": "__RELEASE_CLI_VERSION__"
+  }
+}

package/template/scripts/check.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const packageJsonPath = path.join(process.cwd(), 'package.json');
+const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+const requiredScripts = ['release:beta', 'release:stable', 'release:publish', 'registry:start'];
+for (const scriptName of requiredScripts) {
+  if (!pkg.scripts || !pkg.scripts[scriptName]) {
+    console.error(`Script obrigatório ausente: ${scriptName}`);
+    process.exit(1);
+  }
+}
+
+console.log(`check ok para ${pkg.name}@${pkg.version}`);