Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceynri/fast-tag
๐ npm tag version cli-tools
https://github.com/ceynri/fast-tag
cli-tools npm
Last synced: 29 days ago
JSON representation
๐ npm tag version cli-tools
- Host: GitHub
- URL: https://github.com/ceynri/fast-tag
- Owner: ceynri
- Created: 2020-10-23T12:16:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-28T09:19:31.000Z (almost 3 years ago)
- Last Synced: 2024-12-02T04:35:45.963Z (about 2 months ago)
- Topics: cli-tools, npm
- Language: JavaScript
- Homepage:
- Size: 130 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fast-tag
A simple CLI tool that names tags, updates the version number in package.json, and pushes them to the remote repository.
English | [็ฎไฝไธญๆ](https://github.com/ceynri/fast-tag/blob/master/README_zh-CN.md)
## Installation
### Global installation (recommended)
Install globally to use it anywhere.
```bash
npm install fast-tag --global
```
### local installation
Open a command line in the project folder and install fast-tag:
```bash
npm install fast-tag --save-dev
```
Add the script in package.json:
```json
{
"script": {
"tag": "ftag"
}
}
```
Then input command `npm run tag` to execute fast-tag.
> โ Notes
>
> Since `npm run xxx` does not support pass-through of params, fast-tag will be restricted in usage. For example:
>
> ```json
> {
> "script": {
> "tag": "ftag",
> "tag:lerna": "ftag -L",
> "tag:m": "ftag -m"
> }
> }
> ```
>
> Therefore, if more params are needed, install globally is recommended.
## Dependencies
Requires [git](https://git-scm.com/downloads) to be installed and that it can be called using the command `git`.
Fast tag expects to do automatic version number update for package.json file, so it only can use in the npm project.
## Usage
### Introduction
```bash
ftag [options] [msg]
```
When you enter `ftag`, fast-tag will:
- update local repo from the remote repo and try to merge
- get the version number from the nearest package.json
- increment the version number according to the options (Upgrade patch version by default)
- save the new version number in the package.json file and push it to remote repo (commit message: `ci: version ${version}`)
- and then use the new version number as the tag name for `git tag` and push it to the remote repo
You can add `msg` as a commit message, fast tag will commit ALL uncommitted changes. If there are no uncommitted changes, `msg` will be used as the package.json submitted message.
Of course, it is recommended that before using the fast tag, you have already done the commit of the files, pull remote repo to the local, instead of relying on a ftag command to complete these things, which can maintain the independence of each command.
### Examples
simple usage:
```bash
ftag
```
lerna repo:
```bash
ftag -L
```
patch tag with update the minor version number:
```bash
ftag -m
```
patch tag with submitting all changes:
```bash
ftag 'feat: add some new features'
```
### Options
| abbr | full | effect |
| ---- | ----------- | ------------------------------------------------------------------------------- |
| -s | --small | (default) update PATCH version when you make backward compatible bug fixes |
| -m | --medium | update MINOR version when you add functionality in a backward compatible manner |
| -l | --large | update MAJOR version when you make incompatible API changes |
| -i | --input | input any version number by yourself |
| -n | --notupdate | use current version, not update package.json version number |
| -b | --branch | concatenate part of the branch name\* with the version number as tag name |
| -L | --lerna | lerna mode, equal to `--branch` |
| -d | --debug | show more output information for debugging |
| -h | --help | display help for command |
> part of the branch name\*: If the branch name contains `_` or `/` symbol, the branch name will be truncated and the previous part will be used.
## Libraries
- [Simple Git](https://github.com/steveukx/git-js) - A lightweight interface for running git commands in any node.js application.
- [Commander.js](https://github.com/tj/commander.js) - The complete solution for node.js command-line interfaces.
> โ Notes
>
> Simple Git depends on node.js version 12 or above, use in a lower version of node will result in errors.
>
> It is recommended to use fast-tag in node.js version 12 or above. If you encounter this problem in the lower version, you can also submit an issue. The project will add polyfill in the later version.
## Todo
- use `npm version [ | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=] | from-git]` to update package.json version number.
## Questions
> What is the purpose of this tool?
The initial reason for coding this CLI tool is: the front-end projects currently under development add git tags frequently and cumbersomely. If you need to use the semantic version to name the tag version in a standardized way, you have to look at the previous tag version every time, then increase on its basis.
If there are other requirements, for example, we want to concatenate branch name with the version number as the tag name (like `development_v1.1.4`), or we want to tag and update the version number of package.json at the same time, we have to find the previous tag version and handle these tasks manually, which is not comfortable enough in terms of experience.
So fast-tag was born.
> Will other commands are provided?
Currently, fast-tag only wants to patch tag well.
By the way, most of the effect can be implemented with git, such as the "one-click git add, commit, push", or the "alias โโlong command". It is not considered a good habit. Recommend memorizing the native command of git to make the use of git more flexible.