vue-feat-cli 26.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 João Pedro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,286 @@
+# vue-feat-cli
+
+An opinionated CLI for scaffolding feature-based Vue 3 projects. Generates consistent, typed code following a layered architecture: service → composable → store → view.
+
+## Install
+
+```bash
+npm install -g vue-feat-cli
+```
+
+Or use directly with npx:
+
+```bash
+npx vue-feat-cli init
+```
+
+## Quick start
+
+```bash
+# 1. Initialize — detects your stack and creates vf.config.json
+vf init
+
+# 2. Generate your first feature
+vf g:feat Product
+
+# Get help at any time
+vf help
+vf help generate:feat
+```
+
+## Commands
+
+### `help`
+
+Shows an overview of all commands and their descriptions. Pass a command name (or its alias) to get detailed docs with options, examples, and related commands.
+
+```bash
+vf help                    # overview interativo de todos os comandos
+vf help generate:feat      # docs detalhados de generate:feat
+vf help g:feat             # aliases também funcionam
+```
+
+---
+
+### `init`
+
+Detects the project's installed dependencies (Pinia, Vue Router, Axios) and the TypeScript path alias, then saves `vf.config.json` at the project root and creates `src/shared/http/client.ts`.
+
+```bash
+vf init
+```
+
+Produces `vf.config.json`:
+
+```json
+{
+  "srcDir": "src",
+  "featuresDir": "src/features",
+  "sharedDir": "src/shared",
+  "alias": "@",
+  "httpClient": "fetch",
+  "usesPinia": true,
+  "usesVueRouter": true,
+  "usesTanstackQuery": false
+}
+```
+
+All subsequent generators read this file. If it doesn't exist, safe defaults are used (`fetch`, no Pinia, no Router).
+
+---
+
+### `g:feat <name>`
+
+Scaffolds a complete feature module under `featuresDir/<name>/`.
+
+```bash
+vf g:feat Product
+```
+
+Generated structure (with Pinia + Vue Router enabled):
+
+```
+src/features/product/
+├── composables/
+│   ├── useProductService.ts   # business logic (data refs, CRUD)
+│   └── useProductPage.ts      # UI state (loading, error) — delegates to service
+├── services/
+│   └── product.service.ts     # HTTP layer using httpClient
+├── stores/
+│   └── product.store.ts       # Pinia store (Composition API) or reactive() fallback
+├── types/
+│   └── product.types.ts       # entity interface + CreateDto + UpdateDto
+├── views/
+│   └── ProductView.vue        # page component wired to useProductPage (Vue Router only)
+├── routes.ts                  # lazy-loaded route record (Vue Router only)
+├── components/                # feature-local components (empty)
+└── index.ts                   # public barrel export
+```
+
+Without Vue Router, `routes.ts` and `views/` are omitted and a blank `views/` folder is created instead.
+
+---
+
+### `g:composable <name>`
+
+Creates a standalone composable inside a feature or in `sharedDir/composables/`.
+
+```bash
+vf g:composable useFilters --feature product
+vf g:composable useTheme              # → src/shared/composables/useTheme.ts
+```
+
+---
+
+### `g:component <name>`
+
+Creates a Vue component. Supports nested paths.
+
+```bash
+vf g:component ProductCard --feature product
+vf g:component cards/ProductCard
+```
+
+---
+
+### `g:service <name>`
+
+Adds a service and its types file to an existing feature.
+
+```bash
+vf g:service product --feature product
+```
+
+---
+
+### `g:store <name>`
+
+Adds a store to an existing feature. Uses Pinia (`defineStore`) when `usesPinia: true`, falls back to `reactive()` otherwise.
+
+```bash
+vf g:store product --feature product
+```
+
+---
+
+## Architecture
+
+Each feature follows a strict layered separation:
+
+```
+service.ts
+    └── useXxxService.ts   ← business composable: data refs + CRUD, no UI state
+            └── useXxxPage.ts   ← UI composable: loading + error, delegates to service
+                    └── XxxView.vue   ← page component, calls load() on mount
+```
+
+**Why two composables?**
+
+- `useXxxService` owns domain data. Can be reused (e.g. in a modal) without triggering loading spinners.
+- `useXxxPage` owns UI concerns. Keeps views thin and independently testable.
+
+The store is optional and intended for state that must be shared across features.
+
+---
+
+## HTTP client
+
+`vf init` generates `src/shared/http/client.ts` with a unified `httpClient` interface:
+
+```ts
+httpClient.get<T>(url)
+httpClient.post<T>(url, body)
+httpClient.put<T>(url, body)
+httpClient.patch<T>(url, body)
+httpClient.delete<T>(url)
+```
+
+Both the `fetch` and `axios` implementations expose the same interface, so generated services work unchanged regardless of which you choose.
+
+The base URL is read from the `VITE_API_BASE_URL` environment variable.
+
+---
+
+## Expected project structure
+
+```
+src/
+├── features/        # generated modules
+├── shared/
+│   ├── http/
+│   │   └── client.ts   # generated by vf init
+│   └── composables/
+└── main.ts
+```
+
+The path alias (`@` by default) must point to `src/` in your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "paths": { "@/*": ["./src/*"] }
+  }
+}
+```
+
+---
+
+## Custom Templates
+
+You can override any scaffold template on a per-project basis by creating `.hbs` files in a local folder and pointing `vf.config.json` to it.
+
+### Setup
+
+**Option A — via `vf init`:**
+Answer `y` when asked _"Use custom templates?"_. This sets `templatesDir: ".vf/templates"` in `vf.config.json` and creates the empty folder.
+
+**Option B — copy all defaults for editing:**
+```bash
+vf templates:init
+```
+This copies every built-in template to `.vf/templates/`, ready to edit. It also adds `"templatesDir": ".vf/templates"` to `vf.config.json` if not already set.
+
+**Option C — manual:**
+Add `"templatesDir": ".vf/templates"` to your `vf.config.json` and create only the templates you want to override.
+
+### File structure
+
+Your local templates must mirror the built-in structure:
+
+```
+.vf/templates/
+├── component/
+│   └── Component.vue.hbs
+├── composable/
+│   └── composable.ts.hbs
+└── feature/
+    ├── service.ts.hbs
+    ├── service-crud.ts.hbs
+    ├── service-composable.ts.hbs
+    ├── service-composable-crud.ts.hbs
+    ├── page-composable.ts.hbs
+    ├── page-composable-crud.ts.hbs
+    ├── store.ts.hbs
+    ├── store-composable.ts.hbs
+    ├── types.ts.hbs
+    ├── types-crud.ts.hbs
+    ├── index.ts.hbs
+    ├── routes.ts.hbs
+    └── View.vue.hbs
+```
+
+You only need to include the files you want to override — missing files fall back to the built-in defaults automatically.
+
+### Handlebars context variables
+
+| Variable | Type | Available in |
+|---|---|---|
+| `name` | `string` | all templates — kebab-case feature name |
+| `Name` | `string` | all templates — PascalCase feature name |
+| `nameCamel` | `string` | feature templates — camelCase feature name |
+| `alias` | `string` | feature templates — import alias from config (e.g. `@`) |
+| `usesVueRouter` | `boolean` | feature templates |
+
+### `.gitignore` recommendation
+
+Commit `.vf/templates/` to your repo so the whole team uses the same overrides:
+
+```
+# .gitignore — do NOT ignore .vf/templates if you want team-wide overrides
+# .vf/          ← remove this line if present
+```
+
+If you want the overrides to be personal only, add `.vf/` to `.gitignore`.
+
+---
+
+## Development
+
+```bash
+npm run dev      # run CLI with tsx (no build step)
+npm run build    # compile to dist/
+```
+
+## License
+
+MIT

package/bin/vf.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.js';

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }