Skip to content

Releases: amendx/shuri-cli

1.2.1

26 Jan 13:59
c5bcedd

Choose a tag to compare

🎉 Shuri CLI v1.2.1 - Release Notes

🐛 Bug Fix

  • Fixed double dot in test files: Test files now generate correctly as component.unit.js instead of component..unit.js

✨ New Features

  • Automatic VuePress Documentation: Complete docs generation for Vue 2 projects
  • Vue Version Detection: Shows detected Vue version in verbose output
  • --no-docs Flag: Skip documentation generation
  • --backup Flag: Create config file backups
  • Portuguese Localization: All messages now in Portuguese
  • Smart Vue 3 Handling: Auto-disables docs for Vue 3 with warnings

🔧 Improvements

  • Enhanced --root option affects documentation paths
  • Automatic VuePress sidebar updates
  • Alphabetical component sorting in README
  • Better error handling and user feedback

Install: npm install -g shuri-cli@1.2.1

1.2.0

02 Dec 03:28
d5fe383

Choose a tag to compare

🎉 Shuri CLI v1.2.0 - Release Notes

Vue.js Component Generator with Automatic Documentation


🌟 Major Features

📚 VuePress Documentation Generation

  • Automatic Documentation: Every component now generates complete VuePress v1 documentation automatically
  • Smart Vue Version Detection: Shows detected Vue version in verbose output with intelligent fallbacks
  • Vue 2 Compatibility: Documentation generation optimized for Vue 2 projects and VuePress v1
  • Vue 3 Safe Mode: Automatically disables documentation for Vue 3 projects with clear warnings

🔧 Enhanced CLI Experience

  • --no-docs Flag: Skip documentation generation when not needed
  • --backup Flag: Create automatic backups of modified configuration files
  • --root Option Enhanced: Affects both component structure and documentation naming
  • Vue Version Display: Shows detected/selected Vue version in verbose mode
  • Portuguese Localization: All error messages and logs now in Portuguese for better UX

📁 Generated Documentation Structure

docs/
├── components/
│ └── component-name.md # 📖 Component documentation
├── examples/
│ └── component-name/
│ └── component-name-example.vue # 🎯 Interactive examples
├── components-api/
│ └── component-name-api.js # 📋 API reference
└── .vuepress/
└── config.js # ⚙️ Auto-updated sidebar

🔧 Technical Improvements

Modular Architecture

  • docs-templates.js - Documentation template system
  • vuepress-config.js - VuePress configuration management
  • components-index.js - Component indexing with alphabetical sorting
  • Enhanced error handling with Portuguese messages

Smart Configuration Management

  • Automatic VuePress Sidebar Updates: New components added with correct /components/name paths
  • Alphabetical Component Sorting: README lists maintained in alphabetical order
  • Backup System: Optional .bak files for configuration safety
  • Path Resolution: Robust handling of documentation paths and naming

Vue Version Intelligence

  • Auto-Detection: Reads package.json to determine Vue version
  • Flag Override: --vue2 and --vue3 flags override detection
  • Smart Fallbacks: Defaults to Vue 2 when version cannot be determined
  • Documentation Compatibility: Prevents incompatible documentation generation

🎯 CLI Usage Examples

# Standard component with documentation (Vue 2)
shuri-cli new UserCard --verbose

# Vue 3 component (documentation auto-disabled)
shuri-cli new UserCard --vue3 --verbose

# Skip documentation explicitly
shuri-cli new UserCard --no-docs

# With backup and custom naming
shuri-cli new "Complex Button" --root simple-btn --backup --verbose

# Complete example with all options
shuri-cli new "Data Table Component" \
  --root data-table \
  --style-ext scss \
  --backup \
  --verbose

⚠️ Important Notes

Documentation System Requirements
Vue 2 Only: Documentation generation supports Vue 2 projects exclusively (temporary)
VuePress v1: Optimized for VuePress version 1 compatibility
Automatic Handling: Vue 3 projects automatically skip documentation with warnings

1.1.0

30 Nov 02:27

Choose a tag to compare

Changelog

🚀 Latest Changes

  • (template): fix unused features on templates and typos
  • (feature): create <root> option for custom root dir & update readme ✨
  • (config): fix pkg fix and publish workflow
  • (core): add package-lock
  • (git): setup publish workflow
  • (template): formatting templates to better suit both vue 2 & vue 3
  • (core): update folders structure | rename core func | add readme | config adjustment | programmatic run enabled
  • (core): scaffolding for programmatic usage

1.0.0

29 Nov 06:15

Choose a tag to compare

🚀 Shuri CLI v1.0.0

Vue.js component generator - First stable release!

✨ Features

  • Complete scaffolding: .vue component + index.js + styles + tests
  • Vue 2/3 support: Auto-detects version or force specific syntax
  • Style preprocessors: CSS, SCSS, Sass, Less, Stylus
  • Flexible naming: PascalCase, camelCase, kebab-case, spaces
  • CLI + Programmatic API: Use from terminal or Node.js
  • Smart options: --dry-run, --kebab, --no-style, custom directories

📦 Installation

npm install -g shuri-cli

🚀 Usage

# Basic component
shuri-cli new MyButton

# With options
shuri-cli new "User Card" --kebab --style-ext scss --out src/ui

Full DocumentationIssues