fix(metadata): Updated package and npmextra json description and keywords for enhanced development workflow clarity
This commit is contained in:
parent
6870c40e57
commit
f25ade3e97
@ -1,5 +1,11 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-02-25 - 1.12.8 - fix(metadata)
|
||||
Updated package and npmextra json description and keywords for enhanced development workflow clarity
|
||||
|
||||
- Updated the description in package.json to focus on project setup and management.
|
||||
- Aligned the keywords in both package.json and npmextra.json to include more relevant terms such as gitzone utilities, template management, and CI/CD.
|
||||
|
||||
## 2025-02-25 - 1.12.7 - fix(meta)
|
||||
Fix issues in project metadata and configuration.
|
||||
|
||||
|
||||
@ -10,21 +10,26 @@
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "gitzone/private",
|
||||
"gitrepo": "gitzone",
|
||||
"description": "A CLI toolbelt to streamline local development cycles by using various gitzone utilities.",
|
||||
"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.",
|
||||
"npmPackagename": "@gitzone_private/gitzone",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"CLI",
|
||||
"development",
|
||||
"git",
|
||||
"npm",
|
||||
"local development",
|
||||
"gitzone utilities",
|
||||
"project setup",
|
||||
"version control",
|
||||
"code formatting",
|
||||
"template management",
|
||||
"npm packages",
|
||||
"TypeScript",
|
||||
"automation",
|
||||
"project setup",
|
||||
"code formatting",
|
||||
"commit management",
|
||||
"template creation",
|
||||
"logging",
|
||||
"meta project management"
|
||||
"meta project management",
|
||||
"sync",
|
||||
"Docker",
|
||||
"CI/CD"
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
23
package.json
23
package.json
@ -2,7 +2,7 @@
|
||||
"name": "@git.zone/cli",
|
||||
"private": false,
|
||||
"version": "1.12.7",
|
||||
"description": "A CLI toolbelt to streamline local development cycles by using various gitzone utilities.",
|
||||
"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",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@ -34,16 +34,21 @@
|
||||
},
|
||||
"keywords": [
|
||||
"CLI",
|
||||
"development",
|
||||
"git",
|
||||
"npm",
|
||||
"local development",
|
||||
"gitzone utilities",
|
||||
"project setup",
|
||||
"version control",
|
||||
"code formatting",
|
||||
"template management",
|
||||
"npm packages",
|
||||
"TypeScript",
|
||||
"automation",
|
||||
"project setup",
|
||||
"code formatting",
|
||||
"commit management",
|
||||
"template creation",
|
||||
"logging",
|
||||
"meta project management"
|
||||
"meta project management",
|
||||
"sync",
|
||||
"Docker",
|
||||
"CI/CD"
|
||||
],
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"license": "MIT",
|
||||
@ -111,4 +116,4 @@
|
||||
"peek-readable": "5.3.1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
224
readme.md
224
readme.md
@ -1,191 +1,155 @@
|
||||
# @git.zone/cli
|
||||
|
||||
A CLI toolbelt to streamline local development cycles by using various gitzone utilities.
|
||||
A CLI toolbelt to streamline local development cycles by utilizing various gitzone utilities.
|
||||
|
||||
## Install
|
||||
|
||||
To install the `@git.zone/cli` tool, you need to have Node.js and npm installed on your machine. Once you have those set up, you can install the CLI tool globally using the following command:
|
||||
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:
|
||||
|
||||
```shell
|
||||
npm install -g @git.zone/cli
|
||||
```
|
||||
|
||||
This will add the `gitzone` or `gzone` command to your PATH, allowing you to use the tool from any directory.
|
||||
This command makes `gitzone` or `gzone` accessible from any directory on your system.
|
||||
|
||||
## Usage
|
||||
|
||||
The `gitzone` CLI is designed to streamline various aspects of the local development cycle, including project setup, maintenance, and deployment. Below, we'll go through several scenarios that demonstrate the capabilities of `gitzone`.
|
||||
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.
|
||||
|
||||
### Getting Started
|
||||
### Initializing a New Project
|
||||
|
||||
To start using `gitzone`, you need to initialize a new project or use it with an existing one. This section will guide you through the initial setup and provide examples of the core commands.
|
||||
|
||||
#### Initialize a New Project
|
||||
|
||||
`gitzone` can create several types of projects, including standard npm modules, websites using LitElement, and custom web components. To create a new project, you can use the following command:
|
||||
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 one of the following:
|
||||
- `npm`: A standard npm module with TypeScript support, testing, and CI/CD setup.
|
||||
- `website`: A LitElement-based website with e2e testing, bundling, and service worker support.
|
||||
- `element`: A LitElement standard setup for creating web components.
|
||||
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 of starting a new npm project:
|
||||
1. Open your terminal and navigate to the directory where you want to create your project.
|
||||
2. Execute the following command:
|
||||
```shell
|
||||
gitzone template npm
|
||||
```
|
||||
3. Follow the interactive prompts to set up your project. You will be asked to provide information such as the project name, description, GitHub repository, etc.
|
||||
**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
|
||||
### Committing Changes
|
||||
|
||||
To standardize commit messages and increment versions based on change types (fix, feat, breaking change):
|
||||
Standardizing commit messages and versionning with gitzone:
|
||||
|
||||
```shell
|
||||
gitzone commit
|
||||
```
|
||||
|
||||
This command will prompt you with a series of questions to help construct a standardized commit message and create a new 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`.
|
||||
|
||||
#### Deprecating a Package
|
||||
### Handling Package Deprecation
|
||||
|
||||
To deprecate an old package in favor of a new one:
|
||||
Replace an outdated package with a new one for your team and users:
|
||||
|
||||
```shell
|
||||
gitzone deprecate
|
||||
```
|
||||
|
||||
This command will prompt you for the old and new package names and will automatically deprecate the old package on npm.
|
||||
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.
|
||||
|
||||
#### Opening CI/CD Settings
|
||||
### CI/CD Utilities
|
||||
|
||||
Quickly open the CI/CD settings page of your project repository:
|
||||
Access your project’s CI/CD settings instantly:
|
||||
|
||||
```shell
|
||||
gitzone open ci
|
||||
```
|
||||
|
||||
### Example Commands
|
||||
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.
|
||||
|
||||
#### Project Setup and Initialization
|
||||
### Maintaining Project Cleanliness
|
||||
|
||||
Let's go through how to scaffold a new web component project:
|
||||
|
||||
1. Navigate to your desired directory.
|
||||
2. Run the following command:
|
||||
```shell
|
||||
gitzone template element
|
||||
```
|
||||
3. Follow the prompts to set up your web component project.
|
||||
|
||||
#### Managing Project Lifecycle
|
||||
|
||||
Commands to manage your project's lifecycle:
|
||||
|
||||
- **Commit Changes:**
|
||||
```shell
|
||||
gitzone commit
|
||||
```
|
||||
- **Deprecate a Package:**
|
||||
```shell
|
||||
gitzone deprecate
|
||||
```
|
||||
- **Format Project Files:**
|
||||
```shell
|
||||
gitzone format
|
||||
```
|
||||
- **Regenerate Readme:**
|
||||
```shell
|
||||
gitzone readme
|
||||
```
|
||||
- **Update Local Repositories:**
|
||||
```shell
|
||||
gitzone update
|
||||
```
|
||||
|
||||
#### Advanced Scenarios
|
||||
|
||||
##### Formatting
|
||||
|
||||
To ensure consistent formatting using Prettier:
|
||||
For consistent code formatting across your project:
|
||||
|
||||
```shell
|
||||
gitzone format
|
||||
```
|
||||
|
||||
##### Building the Project
|
||||
This command applies uniform formatting styles using Prettier, ensuring your JS/TS and markdown files align with the project's style guide.
|
||||
|
||||
To build your project as defined in your `package.json`:
|
||||
### Lifecycle Management Commands
|
||||
|
||||
```shell
|
||||
npm run build
|
||||
```
|
||||
#### Clean Builds
|
||||
|
||||
##### Git and Version Control
|
||||
|
||||
Check the current project version:
|
||||
|
||||
```shell
|
||||
gitzone -v
|
||||
```
|
||||
|
||||
To synchronize local repositories with remotes:
|
||||
|
||||
```shell
|
||||
gitzone update
|
||||
```
|
||||
|
||||
##### Metadata and Configuration
|
||||
|
||||
To initialize or update metadata:
|
||||
|
||||
```shell
|
||||
gitzone meta init
|
||||
```
|
||||
|
||||
### Continuous Integration and Delivery (CI/CD)
|
||||
|
||||
#### Running Tests
|
||||
|
||||
To execute tests defined in your `package.json`:
|
||||
|
||||
```shell
|
||||
npm test
|
||||
```
|
||||
|
||||
#### Building Documentation
|
||||
|
||||
Generate documentation:
|
||||
|
||||
```shell
|
||||
npm run buildDocs
|
||||
```
|
||||
|
||||
### Troubleshooting and Debugging
|
||||
|
||||
#### Detailed Logs
|
||||
|
||||
Enable detailed logging for troubleshooting:
|
||||
|
||||
```shell
|
||||
gitzone --loglevel=debug
|
||||
```
|
||||
|
||||
#### Cleaning Up
|
||||
|
||||
To clean up project artifacts:
|
||||
Remove generated files and prepare for a fresh build:
|
||||
|
||||
```shell
|
||||
gitzone clean
|
||||
```
|
||||
|
||||
### Summary
|
||||
This utility cleans up build artifacts from your project directory so that you can run a fresh build without residual clutter affecting outcomes.
|
||||
|
||||
The `gitzone` CLI tool provides a comprehensive suite of commands that streamline project setup, lifecycle management, and deployment, which are indispensable for modern development workflows. By familiarizing yourself with the different commands, you can maximize your productivity and focus on what really matters—writing code. Whether you are starting a new project, maintaining an existing one, or deploying your work, `gitzone` is your toolbelt for efficient development cycles.
|
||||
#### Sync and meta Configuration
|
||||
|
||||
To manage metadata that guides your project configurations and module syncing:
|
||||
|
||||
```shell
|
||||
gitzone meta init
|
||||
```
|
||||
|
||||
This initialization sets the groundwork for supporting gitzone projects by helping you create a `.meta.json` file that tracks subprojects.
|
||||
|
||||
### Advanced Operations
|
||||
|
||||
#### Cloud and Docker Integrations
|
||||
|
||||
For projects integrating cloud deployment or containerization:
|
||||
|
||||
```shell
|
||||
gitzone docker prune
|
||||
```
|
||||
|
||||
This utility manages Docker resources by cleaning stale volumes, containers, and images, ensuring efficient resource use.
|
||||
|
||||
### Detailed Use Cases
|
||||
|
||||
#### **Project Setup and Template Management**
|
||||
|
||||
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.
|
||||
|
||||
#### **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
|
||||
```
|
||||
|
||||
- **Prettier Integration:** Formats not only TypeScript and JavaScript files but also documents such as `readme.md`, maintaining consistency in both code and documentation style.
|
||||
|
||||
#### **Synced Meta Projects**
|
||||
|
||||
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.
|
||||
|
||||
#### **CI/CD Integration**
|
||||
|
||||
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.
|
||||
|
||||
#### **Real-time Docker Management**
|
||||
|
||||
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.
|
||||
|
||||
### Leveraging gitzone
|
||||
|
||||
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.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
|
||||
@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@git.zone/cli',
|
||||
version: '1.12.7',
|
||||
description: 'A CLI toolbelt to streamline local development cycles by using various gitzone utilities.'
|
||||
version: '1.12.8',
|
||||
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.'
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user