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

package/README.md

@@ -1,6 +1,6 @@
 # @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
 
@@ -13,17 +13,11 @@ npx @i-santos/create-package-starter --name @i-santos/swarm
 
 - `--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`
 - `changeset`
 - `version-packages`
 - `release`

package/lib/run.js

@@ -1,27 +1,21 @@
 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>]',
     '',
     '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 hello-package --out ./packages'
   ].join('\n');
 }
 
 function parseArgs(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 +33,6 @@ function parseArgs(argv) {
       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;
@@ -96,10 +78,7 @@ 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);
 }
@@ -116,10 +95,6 @@ async function run(argv) {
     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');
 
@@ -137,15 +112,11 @@ 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}`);

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.0.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'