"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.",
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
# 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:
```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
# Create a semantic 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
gitzone deprecate
```bash
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
gitzone open ci
The most powerful feature of gitzone - automatically format and standardize your entire codebase:
```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
gitzone format
# Rollback to a specific operation
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.
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
# 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:
```shell
```bash
# Clean up all Docker resources
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**
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
# Open pipelines view
gitzone open pipelines
```
- **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:
- **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.
Smoothly transition users from old to new packages:
#### **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
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
@@ -168,4 +403,4 @@ Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
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.'
@@ -135,7 +135,7 @@ export let run = async (options: {
default:true
});
if(!(responseasany).proceed){
if(!(responseasany).value){
logger.log('info','Format operation cancelled by user');
return;
}
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
