https://github.com/headwindz/tedder
🛠️ A scrum git branch manager
https://github.com/headwindz/tedder
git scrum tool
Last synced: 2 months ago
JSON representation
🛠️ A scrum git branch manager
- Host: GitHub
- URL: https://github.com/headwindz/tedder
- Owner: headwindz
- License: mit
- Created: 2018-06-27T08:30:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T15:32:41.000Z (almost 2 years ago)
- Last Synced: 2025-01-28T01:23:28.875Z (over 1 year ago)
- Topics: git, scrum, tool
- Language: JavaScript
- Homepage:
- Size: 551 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **Tedder - a scrum git branch manager**
[](https://github.com/prettier/prettier)
[](https://github.com/headwindz/tedder/blob/master/LICENSE)
[](https://www.npmjs.com/package/tedder)
[](https://npmcharts.com/compare/tedder?minimal=true)
## Why
- Developers sometimes break the naming standard and create inconsistent branches.
- Developers hang around asking whether a scrum branch has been created.
# Getting started
```
npm install tedder
```
_Note: You can install and run tedder both locally and globally._
# Usage
## Options
### Base branch
Specify the base branch to branch off when creating the new scrum branch.
| Default | CLI Override | CLI shortcut Override | Config Override |
| :-----------: | :------------: | :------------------: | :-------------: |
| origin/master | --base \ | -b \ | base: \ |
### Git repo remote
Remote name
| Default | CLI Override | CLI shortcut Overide | Config Override |
| :-----: | :--------------: | :------------------: | :-------------: |
| origin | --remote \ | -r \ | remote: \ |
### Day
Specify which day of the week your scrum branch is targeting. The value should be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun
| Default | CLI Override | CLI shortcut Overide | Config Override |
| :-----: | :-----------: | :------------------: | :-------------: |
| Mon | --day \ | -d \ | day: \ |
### Scrum round
Specify the scrum round which is used to calculate the date.
| Default | CLI Override | CLI shortcut Overide | Config Override |
| :-----: | :------------: | :------------------: | :-------------: |
| 1 | --next \ | -n \ | next: \ |
### tempalte
Specify the tempalte for computing branch name. **\[\]** is used as delimiter:
- \[yyyy\]: get full year
- \[yy\]: get year
- \[mm\]: get month
- \[dd\]: get day
E.g. if your scum is targeted for 16th/Aug/2018 and your template is `feature/[yyyy][mm][dd]` then tedder will create the branch `feature/2018/08/16` fro you.
| Default | CLI Override | CLI shortcut Override | Config Override |
| :--------------------------: | :----------------: | :------------------: | :---------------: |
| feature/\[yyyy\]\[mm\]\[dd\] | --template \ | -t \ | template: \ |
### checkOnly
Whether only check remote branch exists
| Default | CLI Override | CLI shortcut Override | Config Override |
| :-----: | :----------: | :------------------: | :-------------: |
| false | --checkOnly | -c | checkOnly: true |
## With the CLI
```
tedder [options]
```
## With npm script
```
"scripts": {
"scrum": "tedder"
}
```
## Configuration File
Tedder uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for configuration file support. This means you can configure tedder via:
- A .tedderrc file, written in YAML or JSON, with optional extensions: .yaml/.yml/.json/.js.
- A .tedderrc.toml file, written in TOML (the .toml extension is required).
- A tedder.config.js file that exports an object.
- A "tedder" key in your package.json file.
The configuration file will be resolved starting from the location of the file being formatted, and searching up the file tree until a config file is (or isn't) found.
E.g. basic rc config:
```
{
"day": "Thu",
"template": "feat/[yyyy][mm][dd]"
}
```
## Mix CLI and configuration file
You can mix the usage of cli and configuration file. The options from cli take precedence over those from configuration file.
# Last but not least
There is a bonus which will trigger at a small chance while using the tool. Pls give me a shot if you're lucky :