🛠️ A scrum git branch manager
MIT License
Tedder - a scrum git branch manager
npm install tedder
Note: You can install and run tedder both locally and globally.
Specify the base branch to branch off when creating the new scrum branch.
Default | CLI Override | CLI shortcut Override | Config Override |
---|---|---|---|
origin/master | --base <str> | -b <str> | base: <str> |
Remote name
Default | CLI Override | CLI shortcut Overide | Config Override |
---|---|---|---|
origin | --remote <str> | -r <str> | remote: <str> |
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 <str> | -d <str> | day: <str> |
Specify the scrum round which is used to calculate the date.
Default | CLI Override | CLI shortcut Overide | Config Override |
---|---|---|---|
1 | --next <num> | -n <num> | next: <num> |
Specify the tempalte for computing branch name. [] is used as delimiter:
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 <str> | -t <str> | template: <str> |
Whether only check remote branch exists
Default | CLI Override | CLI shortcut Override | Config Override |
---|---|---|---|
false | --checkOnly | -c | checkOnly: true |
tedder [options]
"scripts": {
"scrum": "tedder"
}
Tedder uses cosmiconfig for configuration file support. This means you can configure tedder via:
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]"
}
You can mix the usage of cli and configuration file. The options from cli take precedence over those from configuration file.
There is a bonus which will trigger at a small chance while using the tool. Pls give me a shot if you're lucky :