@i-santos/create-package-starter 0.1.2 → 1.1.0

package/README.md

@@ -1,29 +1,32 @@
 # @i-santos/create-package-starter
 
-Scaffold new npm packages with a consistent release workflow.
+Scaffold new npm packages with a standardized Changesets release workflow.
 
 ## Install / Run
 
 ```bash
 npx @i-santos/create-package-starter --name hello-package
 npx @i-santos/create-package-starter --name @i-santos/swarm
+npx @i-santos/create-package-starter init --dir ./existing-package
 ```
 
 ## Options
 
+Create new package:
+
 - `--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`)
+
+Bootstrap existing package:
+
+- `init`
+- `--dir <directory>` (default: current directory)
+- `--force` (overwrite managed files/scripts/dependency keys)
 
 ## Output
 
 Generated package includes:
 
-- `release:beta`
-- `release:stable`
-- `release:publish`
-- `registry:start`
 - `changeset`
 - `version-packages`
 - `release`
@@ -32,6 +35,15 @@ Generated package includes:
 
 plus a minimal README, CHANGELOG, `.gitignore`, and check script.
 
+## Existing Project Bootstrap
+
+`init` configures an existing npm package directory in-place:
+
+- ensures scripts `changeset`, `version-packages`, `release`
+- ensures `@changesets/cli` in `devDependencies`
+- creates (or preserves) `.changeset/config.json`, `.changeset/README.md`, and `.github/workflows/release.yml`
+- default mode is safe-merge; use `--force` to overwrite managed files/keys
+
 ## Notes
 
 - For scoped names, folder uses the short package name.

package/lib/run.js

@@ -1,27 +1,23 @@
 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>]',
+    '  create-package-starter --name <nome> [--out <diretorio>]',
+    '  create-package-starter init [--dir <diretorio>] [--force]',
     '',
     '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'
+    '  create-package-starter --name @i-santos/swarm --out ./packages',
+    '  create-package-starter init --dir ./meu-pacote',
+    '  create-package-starter init --force'
   ].join('\n');
 }
 
-function parseArgs(argv) {
+function parseCreateArgs(argv) {
   const args = {
-    out: process.cwd(),
-    releaseCliPkg: DEFAULT_RELEASE_CLI_PKG,
-    releaseCliVersion: DEFAULT_RELEASE_CLI_VERSION
+    out: process.cwd()
   };
 
   for (let i = 0; i < argv.length; i += 1) {
@@ -39,18 +35,37 @@ function parseArgs(argv) {
       continue;
     }
 
-    if (token === '--release-cli-pkg') {
-      args.releaseCliPkg = argv[i + 1];
-      i += 1;
+    if (token === '--help' || token === '-h') {
+      args.help = true;
       continue;
     }
 
-    if (token === '--release-cli-version') {
-      args.releaseCliVersion = argv[i + 1];
+    throw new Error(`Argumento inválido: ${token}\n\n${usage()}`);
+  }
+
+  return args;
+}
+
+function parseInitArgs(argv) {
+  const args = {
+    dir: process.cwd(),
+    force: false
+  };
+
+  for (let i = 0; i < argv.length; i += 1) {
+    const token = argv[i];
+
+    if (token === '--dir') {
+      args.dir = argv[i + 1];
       i += 1;
       continue;
     }
 
+    if (token === '--force') {
+      args.force = true;
+      continue;
+    }
+
     if (token === '--help' || token === '-h') {
       args.help = true;
       continue;
@@ -62,6 +77,20 @@ function parseArgs(argv) {
   return args;
 }
 
+function parseArgs(argv) {
+  if (argv[0] === 'init') {
+    return {
+      mode: 'init',
+      args: parseInitArgs(argv.slice(1))
+    };
+  }
+
+  return {
+    mode: 'create',
+    args: parseCreateArgs(argv)
+  };
+}
+
 function validateName(name) {
   if (typeof name !== 'string') {
     return false;
@@ -96,28 +125,154 @@ function copyDirRecursive(sourceDir, targetDir) {
 
 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);
+  const output = source.replace(/__PACKAGE_NAME__/g, variables.packageName);
 
   fs.writeFileSync(filePath, output);
 }
 
-async function run(argv) {
-  const args = parseArgs(argv);
+function readJsonFile(filePath) {
+  let raw;
 
-  if (args.help) {
-    console.log(usage());
-    return;
+  try {
+    raw = fs.readFileSync(filePath, 'utf8');
+  } catch (error) {
+    throw new Error(`Erro ao ler ${filePath}: ${error.message}`);
   }
 
-  if (!validateName(args.name)) {
-    throw new Error('Erro: informe um nome válido com --name (ex: hello-package ou @i-santos/swarm).');
+  try {
+    return JSON.parse(raw);
+  } catch (error) {
+    throw new Error(`Erro ao parsear JSON em ${filePath}: ${error.message}`);
+  }
+}
+
+function writeJsonFile(filePath, value) {
+  fs.writeFileSync(filePath, `${JSON.stringify(value, null, 2)}\n`);
+}
+
+function ensureFileFromTemplate(targetPath, templatePath, options) {
+  if (!fs.existsSync(templatePath)) {
+    throw new Error(`Erro: template não encontrado em ${templatePath}`);
+  }
+
+  const exists = fs.existsSync(targetPath);
+
+  if (exists && !options.force) {
+    return 'skipped';
+  }
+
+  fs.mkdirSync(path.dirname(targetPath), { recursive: true });
+  fs.copyFileSync(templatePath, targetPath);
+
+  if (exists) {
+    return 'overwritten';
+  }
+
+  return 'created';
+}
+
+function configureExistingPackage(packageDir, templateDir, force) {
+  if (!fs.existsSync(packageDir)) {
+    throw new Error(`Erro: diretório não encontrado: ${packageDir}`);
   }
 
-  if (!args.releaseCliPkg || !args.releaseCliVersion) {
-    throw new Error('Erro: --release-cli-pkg e --release-cli-version devem ser informados corretamente.');
+  const packageJsonPath = path.join(packageDir, 'package.json');
+  if (!fs.existsSync(packageJsonPath)) {
+    throw new Error(`Erro: package.json não encontrado em ${packageDir}.`);
+  }
+
+  const packageJson = readJsonFile(packageJsonPath);
+  packageJson.scripts = packageJson.scripts || {};
+  packageJson.devDependencies = packageJson.devDependencies || {};
+
+  const desiredScripts = {
+    changeset: 'changeset',
+    'version-packages': 'changeset version',
+    release: 'npm run check && changeset publish'
+  };
+
+  const summary = {
+    createdFiles: [],
+    overwrittenFiles: [],
+    skippedFiles: [],
+    updatedScriptKeys: [],
+    skippedScriptKeys: [],
+    updatedDependencyKeys: [],
+    skippedDependencyKeys: []
+  };
+
+  let packageJsonChanged = false;
+
+  for (const [key, value] of Object.entries(desiredScripts)) {
+    const exists = Object.prototype.hasOwnProperty.call(packageJson.scripts, key);
+
+    if (!exists || force) {
+      if (!exists || packageJson.scripts[key] !== value) {
+        packageJson.scripts[key] = value;
+        packageJsonChanged = true;
+      }
+      summary.updatedScriptKeys.push(key);
+      continue;
+    }
+
+    summary.skippedScriptKeys.push(key);
+  }
+
+  const dependencyKey = '@changesets/cli';
+  const dependencyValue = '^2.29.7';
+  const depExists = Object.prototype.hasOwnProperty.call(packageJson.devDependencies, dependencyKey);
+
+  if (!depExists || force) {
+    if (!depExists || packageJson.devDependencies[dependencyKey] !== dependencyValue) {
+      packageJson.devDependencies[dependencyKey] = dependencyValue;
+      packageJsonChanged = true;
+    }
+    summary.updatedDependencyKeys.push(dependencyKey);
+  } else {
+    summary.skippedDependencyKeys.push(dependencyKey);
+  }
+
+  if (packageJsonChanged) {
+    writeJsonFile(packageJsonPath, packageJson);
+  }
+
+  const fileSpecs = [
+    ['.changeset/config.json', '.changeset/config.json'],
+    ['.changeset/README.md', '.changeset/README.md'],
+    ['.github/workflows/release.yml', '.github/workflows/release.yml']
+  ];
+
+  for (const [targetRelativePath, templateRelativePath] of fileSpecs) {
+    const targetPath = path.join(packageDir, targetRelativePath);
+    const templatePath = path.join(templateDir, templateRelativePath);
+    const result = ensureFileFromTemplate(targetPath, templatePath, { force });
+
+    if (result === 'created') {
+      summary.createdFiles.push(targetRelativePath);
+    } else if (result === 'overwritten') {
+      summary.overwrittenFiles.push(targetRelativePath);
+    } else {
+      summary.skippedFiles.push(targetRelativePath);
+    }
+  }
+
+  if (!packageJson.scripts.check) {
+    console.warn('Aviso: script "check" não encontrado. O script "release" executa "npm run check".');
+  }
+
+  console.log(`Projeto inicializado em ${packageDir}`);
+  console.log(`Arquivos criados: ${summary.createdFiles.length ? summary.createdFiles.join(', ') : 'nenhum'}`);
+  console.log(`Arquivos sobrescritos: ${summary.overwrittenFiles.length ? summary.overwrittenFiles.join(', ') : 'nenhum'}`);
+  console.log(`Arquivos ignorados: ${summary.skippedFiles.length ? summary.skippedFiles.join(', ') : 'nenhum'}`);
+  console.log(`Scripts atualizados: ${summary.updatedScriptKeys.length ? summary.updatedScriptKeys.join(', ') : 'nenhum'}`);
+  console.log(`Scripts preservados: ${summary.skippedScriptKeys.length ? summary.skippedScriptKeys.join(', ') : 'nenhum'}`);
+  console.log(`Dependências atualizadas: ${summary.updatedDependencyKeys.length ? summary.updatedDependencyKeys.join(', ') : 'nenhum'}`);
+  console.log(`Dependências preservadas: ${summary.skippedDependencyKeys.length ? summary.skippedDependencyKeys.join(', ') : 'nenhum'}`);
+}
+
+function createNewPackage(args) {
+  if (!validateName(args.name)) {
+    throw new Error('Erro: informe um nome válido com --name (ex: hello-package ou @i-santos/swarm).');
   }
 
   const packageRoot = path.resolve(__dirname, '..');
@@ -137,18 +292,38 @@ async function run(argv) {
   copyDirRecursive(templateDir, targetDir);
 
   renderTemplateFile(path.join(targetDir, 'package.json'), {
-    packageName: args.name,
-    releaseCliPkg: args.releaseCliPkg,
-    releaseCliVersion: args.releaseCliVersion
+    packageName: args.name
   });
 
   renderTemplateFile(path.join(targetDir, 'README.md'), {
-    packageName: args.name,
-    releaseCliPkg: args.releaseCliPkg,
-    releaseCliVersion: args.releaseCliVersion
+    packageName: args.name
   });
 
   console.log(`Pacote criado em ${targetDir}`);
 }
 
+function initExistingPackage(args) {
+  const packageRoot = path.resolve(__dirname, '..');
+  const templateDir = path.join(packageRoot, 'template');
+  const targetDir = path.resolve(args.dir);
+
+  configureExistingPackage(targetDir, templateDir, args.force);
+}
+
+async function run(argv) {
+  const parsed = parseArgs(argv);
+
+  if (parsed.args.help) {
+    console.log(usage());
+    return;
+  }
+
+  if (parsed.mode === 'init') {
+    initExistingPackage(parsed.args);
+    return;
+  }
+
+  createNewPackage(parsed.args);
+}
+
 module.exports = { run };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@i-santos/create-package-starter",
-  "version": "0.1.2",
-  "description": "Scaffold new npm packages with standardized release scripts",
+  "version": "1.1.0",
+  "description": "Scaffold new npm packages with a standardized Changesets release workflow",
   "license": "MIT",
   "author": "Igor Santos",
   "homepage": "https://github.com/i-santos/package-starter#readme",

package/template/README.md

@@ -5,19 +5,13 @@ 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`
 - `npm run changeset`
 - `npm run version-packages`
 - `npm run release`
 
-## Dependência de release
+## Fluxo de release
 
-Este pacote foi gerado para usar `__RELEASE_CLI_PKG__@__RELEASE_CLI_VERSION__`.
-
-## CI/CD release
-
-- Workflow pronto em `.github/workflows/release.yml`.
-- Configuração de changesets em `.changeset/config.json`.
+1. Crie um changeset na PR: `npm run changeset`.
+2. Faça merge na `main`.
+3. O workflow `.github/workflows/release.yml` cria/atualiza a PR de release.
+4. Ao merge da PR de release, o publish é executado no npm.

package/template/package.json

@@ -4,16 +4,11 @@
   "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",
     "changeset": "changeset",
     "version-packages": "changeset version",
-    "release": "npm run check && npm run release:publish"
+    "release": "npm run check && changeset publish"
   },
   "devDependencies": {
-    "__RELEASE_CLI_PKG__": "__RELEASE_CLI_VERSION__",
     "@changesets/cli": "^2.29.7"
   }
 }

package/template/scripts/check.js

@@ -7,10 +7,6 @@ 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',
   'changeset',
   'version-packages',
   'release'