Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
4003944139 | |||
83d374dffd | |||
49a5a66440 | |||
20a53d4d92 | |||
fe02b990b3 |
19
changelog.md
19
changelog.md
@@ -1,5 +1,24 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-08-08 - 1.16.3 - fix(changecache/prettier)
|
||||||
|
Skip directories during file processing to prevent errors in changecache and prettier formatting
|
||||||
|
|
||||||
|
- Removed unnecessary await on synchronous file reads in changecache
|
||||||
|
- Added directory checks in changecache to immediately skip directories
|
||||||
|
- Filtered out directories in prettier formatter to avoid processing non-files
|
||||||
|
|
||||||
|
## 2025-08-07 - 1.16.2 - fix(format)
|
||||||
|
Fix format command confirmation prompt to correctly check user response
|
||||||
|
|
||||||
|
- Fixed bug where format command always showed "cancelled" even when user confirmed
|
||||||
|
- Changed response check from `response.proceed` to `response.value` for SmartInteract compatibility
|
||||||
|
|
||||||
|
## 2025-08-04 - 1.16.1 - fix(package/config)
|
||||||
|
Move smartdiff dependency to runtime and add local bash permissions settings
|
||||||
|
|
||||||
|
- Moved '@push.rocks/smartdiff' from devDependencies to dependencies in package.json
|
||||||
|
- Added .claude/settings.local.json with allowed bash commands (grep, mkdir, find, ls)
|
||||||
|
|
||||||
## 2025-05-19 - 1.16.0 - feat(format)
|
## 2025-05-19 - 1.16.0 - feat(format)
|
||||||
Enhance format module with rollback, diff reporting, and improved parallel execution
|
Enhance format module with rollback, diff reporting, and improved parallel execution
|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/cli",
|
"name": "@git.zone/cli",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "1.16.0",
|
"version": "1.16.3",
|
||||||
"description": "A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.",
|
"description": "A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.",
|
||||||
"main": "dist_ts/index.ts",
|
"main": "dist_ts/index.ts",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
@@ -60,7 +60,6 @@
|
|||||||
"@git.zone/tsbuild": "^2.3.2",
|
"@git.zone/tsbuild": "^2.3.2",
|
||||||
"@git.zone/tsrun": "^1.3.3",
|
"@git.zone/tsrun": "^1.3.3",
|
||||||
"@git.zone/tstest": "^1.0.96",
|
"@git.zone/tstest": "^1.0.96",
|
||||||
"@push.rocks/smartdiff": "^1.0.3",
|
|
||||||
"@types/node": "^22.15.18"
|
"@types/node": "^22.15.18"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
@@ -75,6 +74,7 @@
|
|||||||
"@push.rocks/smartchok": "^1.0.34",
|
"@push.rocks/smartchok": "^1.0.34",
|
||||||
"@push.rocks/smartcli": "^4.0.11",
|
"@push.rocks/smartcli": "^4.0.11",
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
|
"@push.rocks/smartdiff": "^1.0.3",
|
||||||
"@push.rocks/smartfile": "^11.2.0",
|
"@push.rocks/smartfile": "^11.2.0",
|
||||||
"@push.rocks/smartgulp": "^3.0.4",
|
"@push.rocks/smartgulp": "^3.0.4",
|
||||||
"@push.rocks/smartinteract": "^2.0.15",
|
"@push.rocks/smartinteract": "^2.0.15",
|
||||||
|
419
readme.md
419
readme.md
@@ -1,155 +1,390 @@
|
|||||||
# @git.zone/cli
|
# @git.zone/cli 🚀
|
||||||
|
|
||||||
A CLI toolbelt to streamline local development cycles by utilizing various gitzone utilities.
|
**The ultimate CLI toolbelt for modern TypeScript development workflows**
|
||||||
|
|
||||||
## Install
|
[](https://www.npmjs.com/package/@git.zone/cli)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
To begin using `@git.zone/cli`, ensure that Node.js and npm are installed on your system. Once they are set up, install the CLI tool globally with the following command:
|
## 🎯 What is gitzone?
|
||||||
|
|
||||||
```shell
|
gitzone is a powerful command-line interface that supercharges your development workflow with automated project management, intelligent code formatting, and seamless version control. Whether you're bootstrapping a new TypeScript project, maintaining code quality, or managing complex multi-repository setups, gitzone has got you covered.
|
||||||
|
|
||||||
|
## 🏃♂️ Quick Start
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install globally via npm
|
||||||
npm install -g @git.zone/cli
|
npm install -g @git.zone/cli
|
||||||
|
|
||||||
|
# Or with pnpm (recommended)
|
||||||
|
pnpm add -g @git.zone/cli
|
||||||
```
|
```
|
||||||
|
|
||||||
This command makes `gitzone` or `gzone` accessible from any directory on your system.
|
Once installed, you can use either `gitzone` or the shorter `gzone` command from anywhere in your terminal.
|
||||||
|
|
||||||
## Usage
|
### Your First Command
|
||||||
|
|
||||||
The `gitzone` CLI provides a comprehensive set of utilities to optimize and manage the development lifecycle of projects, ranging from project initialization to version control, code formatting, and deployment processes. This usage guide will walk you through the available commands, their use cases, and provide detailed examples.
|
```bash
|
||||||
|
# Create a new TypeScript npm package
|
||||||
|
gitzone template npm
|
||||||
|
|
||||||
### Initializing a New Project
|
# Format your entire codebase
|
||||||
|
gitzone format
|
||||||
|
|
||||||
To bootstrap a new project aligned with modern TypeScript practices, use gitzone's template command. Choose from a range of templates tailored for different project types:
|
# Create a semantic commit
|
||||||
|
|
||||||
```shell
|
|
||||||
gitzone template [templatename]
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `[templatename]` with any of the following:
|
|
||||||
- `npm`: Starts an npm module with TypeScript, complete with test and CI/CD integration.
|
|
||||||
- `website`: Initializes a LitElement-based frontend application with features such as e2e testing and service worker setup.
|
|
||||||
- `element`: Prepares a new standard setup for creating reusable web components with LitElement.
|
|
||||||
|
|
||||||
**Example: Starting a New npm Project**
|
|
||||||
1. Navigate to your desired directory in the terminal.
|
|
||||||
2. Execute:
|
|
||||||
```shell
|
|
||||||
gitzone template npm
|
|
||||||
```
|
|
||||||
3. Respond to the prompts to customize the project settings. This includes setting up essential metadata such as name and repository information.
|
|
||||||
|
|
||||||
### Committing Changes
|
|
||||||
|
|
||||||
Standardizing commit messages and versionning with gitzone:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
gitzone commit
|
gitzone commit
|
||||||
```
|
```
|
||||||
|
|
||||||
This command provides an interactive prompt to create a conventional commit message, which will be automatically versioned based on the significance of the changes like `fix`, `feat`, or `BREAKING CHANGE`.
|
## 🛠️ Core Features
|
||||||
|
|
||||||
### Handling Package Deprecation
|
### 📦 Project Templates
|
||||||
|
|
||||||
Replace an outdated package with a new one for your team and users:
|
Instantly scaffold production-ready projects with best practices built-in:
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
gitzone deprecate
|
gitzone template [template-name]
|
||||||
```
|
```
|
||||||
|
|
||||||
The utility collects information about old and new package names through interactive prompts, and proceeds with deprecation notices in npm, guiding users towards the updated package.
|
**Available templates:**
|
||||||
|
- **`npm`** - TypeScript npm package with testing, CI/CD, and full tooling
|
||||||
|
- **`service`** - Microservice architecture with Docker support
|
||||||
|
- **`website`** - Modern web application with LitElement and service workers
|
||||||
|
- **`wcc`** - Web Component Collection for reusable UI components
|
||||||
|
|
||||||
### CI/CD Utilities
|
Each template comes pre-configured with:
|
||||||
|
- ✅ TypeScript with modern configurations
|
||||||
|
- ✅ Automated testing setup
|
||||||
|
- ✅ CI/CD pipelines (GitLab/GitHub)
|
||||||
|
- ✅ Code formatting and linting
|
||||||
|
- ✅ Documentation structure
|
||||||
|
|
||||||
Access your project’s CI/CD settings instantly:
|
### 🎨 Intelligent Code Formatting
|
||||||
|
|
||||||
```shell
|
The most powerful feature of gitzone - automatically format and standardize your entire codebase:
|
||||||
gitzone open ci
|
|
||||||
|
```bash
|
||||||
|
# Preview changes without applying them
|
||||||
|
gitzone format --dry-run
|
||||||
|
|
||||||
|
# Format with automatic approval
|
||||||
|
gitzone format --yes
|
||||||
|
|
||||||
|
# Save formatting plan for later execution
|
||||||
|
gitzone format --save-plan format-plan.json
|
||||||
|
|
||||||
|
# Execute a saved plan
|
||||||
|
gitzone format --from-plan format-plan.json
|
||||||
|
|
||||||
|
# Enable verbose output for debugging
|
||||||
|
gitzone format --verbose
|
||||||
```
|
```
|
||||||
|
|
||||||
This command opens the settings page of the repository’s CI/CD configuration directly from your CLI, thus swiftly transitioning from local tasks to cloud configurations.
|
**Format features:**
|
||||||
|
- 🔄 **Smart caching** - Only processes changed files
|
||||||
|
- 🛡️ **Rollback support** - Undo formatting changes if needed
|
||||||
|
- 📊 **Detailed reporting** - See exactly what changed
|
||||||
|
- ⚡ **Parallel execution** - Format multiple files simultaneously
|
||||||
|
- 🎯 **Module-specific formatting** - Target specific formatters
|
||||||
|
|
||||||
### Maintaining Project Cleanliness
|
**Rollback capabilities:**
|
||||||
|
```bash
|
||||||
|
# List all available backups
|
||||||
|
gitzone format --list-backups
|
||||||
|
|
||||||
For consistent code formatting across your project:
|
# Rollback to the last operation
|
||||||
|
gitzone format --rollback
|
||||||
|
|
||||||
```shell
|
# Rollback to a specific operation
|
||||||
gitzone format
|
gitzone format --rollback [operation-id]
|
||||||
|
|
||||||
|
# Clean old backups
|
||||||
|
gitzone format --clean-backups
|
||||||
```
|
```
|
||||||
|
|
||||||
This command applies uniform formatting styles using Prettier, ensuring your JS/TS and markdown files align with the project's style guide.
|
**Formatters included:**
|
||||||
|
- **Prettier** - JavaScript/TypeScript code formatting
|
||||||
|
- **License** - Ensure proper licensing
|
||||||
|
- **Package.json** - Standardize package configurations
|
||||||
|
- **Tsconfig** - TypeScript configuration optimization
|
||||||
|
- **Readme** - Documentation formatting
|
||||||
|
- **Gitignore** - Repository ignore rules
|
||||||
|
- **Templates** - Project template updates
|
||||||
|
- **Npmextra** - Extended npm configurations
|
||||||
|
|
||||||
### Lifecycle Management Commands
|
### 🔀 Semantic Commits & Versioning
|
||||||
|
|
||||||
#### Clean Builds
|
Create standardized commits that automatically handle versioning:
|
||||||
|
|
||||||
Remove generated files and prepare for a fresh build:
|
```bash
|
||||||
|
gitzone commit
|
||||||
```shell
|
|
||||||
gitzone clean
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This utility cleans up build artifacts from your project directory so that you can run a fresh build without residual clutter affecting outcomes.
|
Features:
|
||||||
|
- 📝 Interactive commit message builder
|
||||||
|
- 🏷️ Automatic version bumping (major/minor/patch)
|
||||||
|
- 📜 Changelog generation
|
||||||
|
- 🚀 Optional auto-push to origin
|
||||||
|
- 🎯 Conventional commit compliance
|
||||||
|
|
||||||
#### Sync and meta Configuration
|
The commit wizard guides you through:
|
||||||
|
1. **Type selection** (feat/fix/docs/style/refactor/perf/test/chore)
|
||||||
|
2. **Scope definition** (component/module affected)
|
||||||
|
3. **Description crafting**
|
||||||
|
4. **Breaking change detection**
|
||||||
|
5. **Version bump determination**
|
||||||
|
|
||||||
To manage metadata that guides your project configurations and module syncing:
|
### 🏗️ Meta Repository Management
|
||||||
|
|
||||||
```shell
|
Manage multiple related repositories as a cohesive unit:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Initialize a meta repository
|
||||||
gitzone meta init
|
gitzone meta init
|
||||||
|
|
||||||
|
# Add a sub-project
|
||||||
|
gitzone meta add [name] [git-url]
|
||||||
|
|
||||||
|
# Update all sub-projects
|
||||||
|
gitzone meta update
|
||||||
|
|
||||||
|
# Remove a sub-project
|
||||||
|
gitzone meta remove [name]
|
||||||
```
|
```
|
||||||
|
|
||||||
This initialization sets the groundwork for supporting gitzone projects by helping you create a `.meta.json` file that tracks subprojects.
|
Perfect for:
|
||||||
|
- Monorepo management
|
||||||
|
- Multi-package projects
|
||||||
|
- Coordinated deployments
|
||||||
|
- Synchronized versioning
|
||||||
|
|
||||||
### Advanced Operations
|
### 🐳 Docker Management
|
||||||
|
|
||||||
#### Cloud and Docker Integrations
|
Streamline your Docker workflow:
|
||||||
|
|
||||||
For projects integrating cloud deployment or containerization:
|
```bash
|
||||||
|
# Clean up all Docker resources
|
||||||
```shell
|
|
||||||
gitzone docker prune
|
gitzone docker prune
|
||||||
```
|
```
|
||||||
|
|
||||||
This utility manages Docker resources by cleaning stale volumes, containers, and images, ensuring efficient resource use.
|
This command removes:
|
||||||
|
- Stopped containers
|
||||||
|
- Unused images
|
||||||
|
- Dangling volumes
|
||||||
|
- Unused networks
|
||||||
|
|
||||||
### Detailed Use Cases
|
### 🔗 Quick CI/CD Access
|
||||||
|
|
||||||
#### **Project Setup and Template Management**
|
Jump directly to your CI/CD configurations:
|
||||||
|
|
||||||
Whether creating an npm module or a web component, the command `gitzone template [templatename]` invokes smart scaffolding processes that automatically set up a robust project environment equipped with modern tooling like TypeScript, Prettier configurations, and testing frameworks.
|
```bash
|
||||||
|
# Open CI/CD settings
|
||||||
|
gitzone open ci
|
||||||
|
|
||||||
#### **Commit Management**
|
# Open pipelines view
|
||||||
|
gitzone open pipelines
|
||||||
The `gitzone commit` command assures that your commit messages complement semantic versioning practices. It proposes version bumps based on detected changes and helps maintain an accurate project change log.
|
|
||||||
|
|
||||||
- **Interactive Commit:** Users engage in dialogues to define commit type (`fix`, `feat`, `BREAKING CHANGE`), scope, and description, resulting in uniform and meaningful commit logs.
|
|
||||||
- **Automatic Versioning:** After message crafting, the versioning is attended by bumps similar to npm’s `npm version` with stages such as `major`, `minor`, and `patch`.
|
|
||||||
|
|
||||||
#### **Formatting and Configurations**
|
|
||||||
|
|
||||||
A consistent format yields a professional and readable codebase:
|
|
||||||
```shell
|
|
||||||
gitzone format
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Prettier Integration:** Formats not only TypeScript and JavaScript files but also documents such as `readme.md`, maintaining consistency in both code and documentation style.
|
Works with GitLab repositories to provide instant access to your deployment configurations.
|
||||||
|
|
||||||
#### **Synced Meta Projects**
|
### 📝 Package Deprecation
|
||||||
|
|
||||||
Effectively supervise interconnected repositories or module collections:
|
Smoothly transition users from old to new packages:
|
||||||
- **Meta Initialization (`meta init`)**: Lay down a foundation for a meta repository that orchestrates multiple projects by overseeing them through a centralized metadata file.
|
|
||||||
- **Subproject Operations:** Commands such as `meta update`, `meta add`, `meta remove` enable dynamic management of subprojects, ensuring they remain updated with current features and aligned to the meta repository's standards.
|
|
||||||
|
|
||||||
#### **CI/CD Integration**
|
```bash
|
||||||
|
gitzone deprecate
|
||||||
|
```
|
||||||
|
|
||||||
Directly linking your local development processes to continuous integration settings with `gitzone open ci` provides seamless switches between code and configuration in cloud-based environments.
|
Interactive wizard for:
|
||||||
|
- Setting deprecation notices
|
||||||
|
- Guiding users to replacements
|
||||||
|
- Updating registry metadata
|
||||||
|
- Coordinating migration paths
|
||||||
|
|
||||||
#### **Real-time Docker Management**
|
### 🚦 Project Initialization
|
||||||
|
|
||||||
For developers employing Docker for service deployments, `gitzone docker prune` offers a quick remedy to residual services, optimizing local/docker-storage for a more streamlined experience in container management.
|
Prepare existing projects for development:
|
||||||
|
|
||||||
### Leveraging gitzone
|
```bash
|
||||||
|
gitzone start
|
||||||
|
```
|
||||||
|
|
||||||
By mastering the `gitzone` CLI commands, you gain unparalleled efficiency in managing your projects from conception to deployment. Encompassing a wide gamut of functionalities, from initial project scaffolding to synchronization of modularized repositories and beyond, `gitzone` serves as a linchpin for developers intent on optimizing their workflow. Understanding and utilizing its full potential catalyzes development cycles, granting the freedom to focus on innovation, collaboration, and delivering outstanding software products.
|
Automatically:
|
||||||
|
- Checks out master branch
|
||||||
|
- Pulls latest changes
|
||||||
|
- Installs dependencies
|
||||||
|
- Sets up development environment
|
||||||
|
|
||||||
|
### 🔧 Helper Utilities
|
||||||
|
|
||||||
|
Quick utilities for common tasks:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Generate a unique short ID
|
||||||
|
gitzone helpers shortid
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 Configuration
|
||||||
|
|
||||||
|
### npmextra.json Configuration
|
||||||
|
|
||||||
|
Customize gitzone behavior through `npmextra.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"gitzone": {
|
||||||
|
"format": {
|
||||||
|
"interactive": true,
|
||||||
|
"showDiffs": false,
|
||||||
|
"autoApprove": false,
|
||||||
|
"parallel": true,
|
||||||
|
"rollback": {
|
||||||
|
"enabled": true,
|
||||||
|
"autoRollbackOnError": true,
|
||||||
|
"backupRetentionDays": 7
|
||||||
|
},
|
||||||
|
"modules": {
|
||||||
|
"skip": ["prettier"],
|
||||||
|
"only": [],
|
||||||
|
"order": []
|
||||||
|
},
|
||||||
|
"cache": {
|
||||||
|
"enabled": true,
|
||||||
|
"clean": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
|
||||||
|
- `CI` - Detect CI environment for automated workflows
|
||||||
|
- `DEBUG` - Enable debug output
|
||||||
|
- `GITZONE_FORMAT_PARALLEL` - Control parallel formatting
|
||||||
|
|
||||||
|
## 🏆 Best Practices
|
||||||
|
|
||||||
|
### For New Projects
|
||||||
|
1. Start with a template: `gitzone template npm`
|
||||||
|
2. Customize the generated structure
|
||||||
|
3. Run initial format: `gitzone format`
|
||||||
|
4. Set up CI/CD: `gitzone open ci`
|
||||||
|
|
||||||
|
### For Existing Projects
|
||||||
|
1. Initialize: `gitzone start`
|
||||||
|
2. Format codebase: `gitzone format --dry-run` (preview first!)
|
||||||
|
3. Apply formatting: `gitzone format --yes`
|
||||||
|
4. Commit changes: `gitzone commit`
|
||||||
|
|
||||||
|
### For Teams
|
||||||
|
1. Document format preferences in `npmextra.json`
|
||||||
|
2. Use `--save-plan` for reviewable format changes
|
||||||
|
3. Enable rollback for safety
|
||||||
|
4. Standardize commit conventions
|
||||||
|
|
||||||
|
## 🎯 Common Workflows
|
||||||
|
|
||||||
|
### Clean Development Cycle
|
||||||
|
```bash
|
||||||
|
# 1. Start fresh
|
||||||
|
gitzone start
|
||||||
|
|
||||||
|
# 2. Make changes
|
||||||
|
# ... your development work ...
|
||||||
|
|
||||||
|
# 3. Format code
|
||||||
|
gitzone format
|
||||||
|
|
||||||
|
# 4. Commit with semantic versioning
|
||||||
|
gitzone commit
|
||||||
|
|
||||||
|
# 5. Deploy (if CI/CD configured)
|
||||||
|
# Automatic via git push
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multi-Repository Management
|
||||||
|
```bash
|
||||||
|
# 1. Set up meta repository
|
||||||
|
gitzone meta init
|
||||||
|
|
||||||
|
# 2. Add all related projects
|
||||||
|
gitzone meta add frontend https://github.com/org/frontend.git
|
||||||
|
gitzone meta add backend https://github.com/org/backend.git
|
||||||
|
gitzone meta add shared https://github.com/org/shared.git
|
||||||
|
|
||||||
|
# 3. Synchronize updates
|
||||||
|
gitzone meta update
|
||||||
|
```
|
||||||
|
|
||||||
|
### Safe Formatting with Rollback
|
||||||
|
```bash
|
||||||
|
# 1. Preview changes
|
||||||
|
gitzone format --dry-run
|
||||||
|
|
||||||
|
# 2. Save plan for review
|
||||||
|
gitzone format --save-plan format-changes.json
|
||||||
|
|
||||||
|
# 3. Apply formatting
|
||||||
|
gitzone format --from-plan format-changes.json
|
||||||
|
|
||||||
|
# 4. If something goes wrong, rollback
|
||||||
|
gitzone format --rollback
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔌 Integrations
|
||||||
|
|
||||||
|
### CI/CD Platforms
|
||||||
|
- **GitLab CI** - Full pipeline support with templates
|
||||||
|
- **GitHub Actions** - Automated workflows
|
||||||
|
- **Docker** - Container-based deployments
|
||||||
|
|
||||||
|
### Development Tools
|
||||||
|
- **TypeScript** - First-class support
|
||||||
|
- **Prettier** - Code formatting
|
||||||
|
- **ESLint** - Linting (via format modules)
|
||||||
|
- **npm/pnpm** - Package management
|
||||||
|
|
||||||
|
### Version Control
|
||||||
|
- **Git** - Deep integration
|
||||||
|
- **Semantic Versioning** - Automatic version bumping
|
||||||
|
- **Conventional Commits** - Standardized commit messages
|
||||||
|
|
||||||
|
## 💡 Pro Tips
|
||||||
|
|
||||||
|
1. **Use aliases**: Add `alias gz='gitzone'` to your shell profile
|
||||||
|
2. **Combine commands**: `gitzone format --yes && gitzone commit`
|
||||||
|
3. **Leverage templates**: Start projects right with proven structures
|
||||||
|
4. **Enable caching**: Dramatically speeds up formatting operations
|
||||||
|
5. **Save format plans**: Review changes before applying in production
|
||||||
|
|
||||||
|
## 🐛 Troubleshooting
|
||||||
|
|
||||||
|
### Format Command Shows "Cancelled"
|
||||||
|
If the format command shows cancelled even after confirming:
|
||||||
|
- Check your `npmextra.json` configuration
|
||||||
|
- Try with `--yes` flag to skip confirmation
|
||||||
|
- Use `--verbose` for detailed output
|
||||||
|
|
||||||
|
### Docker Commands Fail
|
||||||
|
Ensure Docker daemon is running:
|
||||||
|
```bash
|
||||||
|
docker info
|
||||||
|
```
|
||||||
|
|
||||||
|
### Template Creation Issues
|
||||||
|
Verify npm/pnpm is properly configured:
|
||||||
|
```bash
|
||||||
|
npm config get registry
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📈 Performance
|
||||||
|
|
||||||
|
gitzone is optimized for speed:
|
||||||
|
- **Parallel processing** for format operations
|
||||||
|
- **Smart caching** to avoid redundant work
|
||||||
|
- **Incremental updates** for meta repositories
|
||||||
|
- **Minimal dependencies** for fast installation
|
||||||
|
|
||||||
## License and Legal Information
|
## License and Legal Information
|
||||||
|
|
||||||
|
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@git.zone/cli',
|
name: '@git.zone/cli',
|
||||||
version: '1.16.0',
|
version: '1.16.3',
|
||||||
description: 'A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.'
|
description: 'A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.'
|
||||||
}
|
}
|
||||||
|
@@ -38,7 +38,7 @@ export class ChangeCache {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const content = await plugins.smartfile.fs.toStringSync(this.manifestPath);
|
const content = plugins.smartfile.fs.toStringSync(this.manifestPath);
|
||||||
return JSON.parse(content);
|
return JSON.parse(content);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,7 +59,13 @@ export class ChangeCache {
|
|||||||
|
|
||||||
// Get current file stats
|
// Get current file stats
|
||||||
const stats = await plugins.smartfile.fs.stat(absolutePath);
|
const stats = await plugins.smartfile.fs.stat(absolutePath);
|
||||||
const content = await plugins.smartfile.fs.toStringSync(absolutePath);
|
|
||||||
|
// Skip directories
|
||||||
|
if (stats.isDirectory()) {
|
||||||
|
return false; // Directories are not processed
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = plugins.smartfile.fs.toStringSync(absolutePath);
|
||||||
const currentChecksum = this.calculateChecksum(content);
|
const currentChecksum = this.calculateChecksum(content);
|
||||||
|
|
||||||
// Get cached info
|
// Get cached info
|
||||||
@@ -83,6 +89,12 @@ export class ChangeCache {
|
|||||||
|
|
||||||
// Get current file stats
|
// Get current file stats
|
||||||
const stats = await plugins.smartfile.fs.stat(absolutePath);
|
const stats = await plugins.smartfile.fs.stat(absolutePath);
|
||||||
|
|
||||||
|
// Skip directories
|
||||||
|
if (stats.isDirectory()) {
|
||||||
|
return; // Don't cache directories
|
||||||
|
}
|
||||||
|
|
||||||
const content = await plugins.smartfile.fs.toStringSync(absolutePath);
|
const content = await plugins.smartfile.fs.toStringSync(absolutePath);
|
||||||
const checksum = this.calculateChecksum(content);
|
const checksum = this.calculateChecksum(content);
|
||||||
|
|
||||||
|
@@ -15,8 +15,22 @@ export class PrettierFormatter extends BaseFormatter {
|
|||||||
// Get all files that match the pattern
|
// Get all files that match the pattern
|
||||||
const files = await plugins.smartfile.fs.listFileTree('.', globPattern);
|
const files = await plugins.smartfile.fs.listFileTree('.', globPattern);
|
||||||
|
|
||||||
// Check which files need formatting
|
// Filter out any potential directories and ensure we only process files
|
||||||
|
const validFiles: string[] = [];
|
||||||
for (const file of files) {
|
for (const file of files) {
|
||||||
|
try {
|
||||||
|
const stats = await plugins.smartfile.fs.stat(file);
|
||||||
|
if (!stats.isDirectory()) {
|
||||||
|
validFiles.push(file);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// Skip files that can't be accessed
|
||||||
|
logVerbose(`Skipping ${file} - cannot access: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check which files need formatting
|
||||||
|
for (const file of validFiles) {
|
||||||
// Skip files that haven't changed
|
// Skip files that haven't changed
|
||||||
if (!await this.shouldProcessFile(file)) {
|
if (!await this.shouldProcessFile(file)) {
|
||||||
logVerbose(`Skipping ${file} - no changes detected`);
|
logVerbose(`Skipping ${file} - no changes detected`);
|
||||||
@@ -85,7 +99,7 @@ export class PrettierFormatter extends BaseFormatter {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
// Read current content
|
// Read current content
|
||||||
const content = await plugins.smartfile.fs.toStringSync(change.path);
|
const content = plugins.smartfile.fs.toStringSync(change.path);
|
||||||
|
|
||||||
// Format with prettier
|
// Format with prettier
|
||||||
const prettier = await import('prettier');
|
const prettier = await import('prettier');
|
||||||
|
@@ -135,7 +135,7 @@ export let run = async (options: {
|
|||||||
default: true
|
default: true
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!(response as any).proceed) {
|
if (!(response as any).value) {
|
||||||
logger.log('info', 'Format operation cancelled by user');
|
logger.log('info', 'Format operation cancelled by user');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user