feat: vpcar CLI tool

Author: brenoepics

package.json

@@ -11,7 +11,8 @@
     "dev": "pnpm --filter vitepress-carbon-demo run dev",
     "demo-build": "vitepress build ./packages/demo",
     "lint": "prettier --check --write --parser typescript \"{__tests__,docs,packages,types}/**/*.ts\"",
-    "lint:fail": "prettier --check --parser typescript \"{__tests__,docs,packages,types}/**/*.ts\""
+    "lint:fail": "prettier --check --parser typescript \"{__tests__,docs,packages,types}/**/*.ts\"",
+    "release": "changelogen --release && pnpm --filter vpcar run release && pnpm --filter vitepress-carbon release && git push --follow-tags"
   },
   "author": "Breno A.",
   "license": "MIT",
@@ -26,6 +27,7 @@
   "dependencies": {
     "@algolia/client-search": "^5.7.0",
     "@types/node": "^22.7.4",
+    "changelogen": "^0.5.7",
     "mark.js": "^8.11.1",
     "search-insights": "^2.17.2",
     "vite": "^5.4.8",

packages/cli/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+
+## v0.0.2
+
+[compare changes](https://github.com/brenoepics/vitepress-carbon/compare/1.3.3...v0.0.2)
+
+### 🚀 Enhancements
+
+- Add templates package ([59dc6a6](https://github.com/brenoepics/vitepress-carbon/commit/59dc6a6))
+- Add cli package ([8dd5ce4](https://github.com/brenoepics/vitepress-carbon/commit/8dd5ce4))
+
+### 🩹 Fixes
+
+- Add demo config files ([6e28781](https://github.com/brenoepics/vitepress-carbon/commit/6e28781))
+- Add `vite` and extend searchForWorkspaceRoot ([4b5e287](https://github.com/brenoepics/vitepress-carbon/commit/4b5e287))
+- Add missing dependencies ([ebbe979](https://github.com/brenoepics/vitepress-carbon/commit/ebbe979))
+
+### 🏡 Chore
+
+- Bump vitepress dependency ([9de56f3](https://github.com/brenoepics/vitepress-carbon/commit/9de56f3))
+- **deps-dev:** Bump @types/node from 20.16.1 to 22.4.1 ([a67296c](https://github.com/brenoepics/vitepress-carbon/commit/a67296c))
+- Migrate to pnpm and monorepo structure ([63647d1](https://github.com/brenoepics/vitepress-carbon/commit/63647d1))
+- Migrate to pnpm and monorepo structure ([65026cc](https://github.com/brenoepics/vitepress-carbon/commit/65026cc))
+- Un-ignore `pnpm-lock.yml` ([92d9a5e](https://github.com/brenoepics/vitepress-carbon/commit/92d9a5e))
+- Un-ignore `pnpm-lock.yml` ([96f7787](https://github.com/brenoepics/vitepress-carbon/commit/96f7787))
+- Bump `pnpm-lock.yml` ([b6453eb](https://github.com/brenoepics/vitepress-carbon/commit/b6453eb))
+- Update README.md ([dbc2f63](https://github.com/brenoepics/vitepress-carbon/commit/dbc2f63))
+- Remove unused package detector ([66b7fd6](https://github.com/brenoepics/vitepress-carbon/commit/66b7fd6))
+
+### 🤖 CI
+
+- Update `actions/upload-pages-artifact` version ([5bc48cf](https://github.com/brenoepics/vitepress-carbon/commit/5bc48cf))
+- Fix demo build command ([922ab76](https://github.com/brenoepics/vitepress-carbon/commit/922ab76))
+
+### ❤️ Contributors
+
+- Breno A. ([@brenoepics](http://github.com/brenoepics))
+

packages/cli/README.md

@@ -0,0 +1,36 @@
+# vpcar
+
+vpcar is a CLI tool for initializing and managing VitePress Carbon projects. It simplifies the setup process and
+provides useful commands to streamline your development workflow.
+
+![NPM Version](https://img.shields.io/npm/v/vpcar)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brenoepics/vitepress-carbon/node.js.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=brenoepics_vitepress-carbon&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=brenoepics_vitepress-carbon)
+![GitHub Repo stars](https://img.shields.io/github/stars/brenoepics/vitepress-carbon)
+
+## Documentation
+
+Check out the [VitePress Carbon Docs](https://carbon.breno.tech) for detailed information on how to use VitePress
+Carbon.
+
+## Usage
+
+To create a new VitePress Carbon project, run:
+
+```sh
+npx vpcar init <project-name>
+```
+
+This will prompt you to select various options and set up your project accordingly.
+
+## Contributing
+
+If you encounter any issues or have suggestions for improvements, feel free
+to [open an issue](https://github.com/brenoepics/vitepress-carbon/issues)
+or [submit a pull request](https://github.com/brenoepics/vitepress-carbon/pulls). Your contributions and ⭐ are greatly
+appreciated!
+
+## Acknowledgements
+
+Special thanks to the Nuxi devs and other dependencies for their inspiration and base code that helped shape this CLI
+tool.

packages/cli/bin/vpcli.mjs packages/cli/bin/vpcar.mjs

@@ -1,5 +1,5 @@
 {
-  "name": "vpcli",
+  "name": "vpcar",
   "version": "0.0.1",
   "description": "VitePress Carbon CLI",
   "repository": {
@@ -11,12 +11,12 @@
   "type": "module",
   "exports": {
     ".": "./dist/index.mjs",
-    "./cli": "./bin/vpcli.mjs"
+    "./cli": "./bin/vpcar.mjs"
   },
   "types": "./dist/index.d.ts",
   "bin": {
-    "vpcli": "./bin/vpcli.mjs",
-    "vp-cli": "./bin/vpcli.mjs"
+    "vpcar": "./bin/vpcar.mjs",
+    "vp-car": "./bin/vpcar.mjs"
   },
   "files": [
     "bin",
@@ -26,16 +26,15 @@
     "dev:prepare": "unbuild --stub",
     "build": "unbuild",
     "build:stub": "unbuild --stub",
-    "cli": "node ./bin/vpcli.mjs",
-    "vpcli": "node ./bin/vpcli.mjs",
-    "vpcli-bun": "bun --bun ./bin/vpcli.mjs",
+    "cli": "node ./bin/vpcar.mjs",
+    "vpcar": "node ./bin/vpcar.mjs",
+    "vpcar-bun": "bun --bun ./bin/vpcar.mjs",
     "prepack": "unbuild",
-    "release": "changelogen --release && npm publish && git push --follow-tags"
+    "release": "npm publish"
   },
   "devDependencies": {
     "@types/node": "^20.16.10",
     "@types/semver": "^7.5.8",
-    "changelogen": "^0.5.7",
     "citty": "^0.1.6",
     "consola": "^3.2.3",
     "execa": "^9.4.0",

packages/cli/package.json

@@ -102,7 +102,7 @@ export default defineCommand({
         force: Boolean(ctx.args.force),
         offline: Boolean(ctx.args.offline),
         preferOffline: Boolean(ctx.args.preferOffline),
-        registry: process.env.vpcli_INIT_REGISTRY ?? DEFAULT_REGISTRY
+        registry: process.env.vpcar_INIT_REGISTRY ?? DEFAULT_REGISTRY
       })
     } catch (err) {
       if (process.env.DEBUG) {

packages/cli/src/commands/init.ts

@@ -1,13 +1,13 @@
 import { defineCommand } from 'citty'
-import vpcliPkg from '../package.json' assert { type: 'json' }
+import vpcarPkg from '../package.json' assert { type: 'json' }
 import { commands } from './commands'
 import { checkEngines } from './utils/engines'
 
 export const main = defineCommand({
   meta: {
-    name: vpcliPkg.name,
-    version: vpcliPkg.version,
-    description: vpcliPkg.description
+    name: vpcarPkg.name,
+    version: vpcarPkg.version,
+    description: vpcarPkg.description
   },
   subCommands: commands,
   async setup(ctx) {

packages/cli/src/main.ts

@@ -10,8 +10,8 @@ globalThis.__vp_cli__ = globalThis.__vp_cli__ || {
   entry: fileURLToPath(
     new URL(
       import.meta.url.endsWith('.ts')
-        ? '../bin/vpcli.mjs'
-        : '../../bin/vpcli.mjs',
+        ? '../bin/vpcar.mjs'
+        : '../../bin/vpcar.mjs',
       import.meta.url,
     ),
   ),

packages/cli/src/run.ts

@@ -30,7 +30,8 @@
   },
   "packageManager": "pnpm@9.9.0",
   "scripts": {
-    "preinstall": "npx only-allow pnpm"
+    "preinstall": "npx only-allow pnpm",
+    "release": "npm publish"
   },
   "dependencies": {
     "@clack/prompts": "^0.7.0",