| 1 | # standup-boy
|
| 2 |
|
| 3 | > A simple module to create daily standup texts :clock10:
|
| 4 |
|
| 5 | Standup-boy helps you create daily standup texts fast and easy.
|
| 6 | It prompts you the usual stuff for a daily standup, then outputs a nicely-formatted, emoji-ready text for you to use in whatever platform you desire.
|
| 7 | Assumes markdown formatting.
|
| 8 |
|
| 9 | ## Install
|
| 10 |
|
| 11 | ```
|
| 12 | $ npm install --global standup-boy
|
| 13 | ```
|
| 14 |
|
| 15 | ```
|
| 16 | $ standup-boy --help
|
| 17 |
|
| 18 | Usage
|
| 19 | standup-boy
|
| 20 |
|
| 21 | Examples
|
| 22 | $ standup-boy
|
| 23 | ? What did I accomplish yesterday? Something!
|
| 24 | ? What will I do today? Something Else!
|
| 25 | ? What obstacles are impeding my progress? Any info I need or want to share? Not much...
|
| 26 |
|
| 27 | :triumph: **`What did I accomplish yesterday`**
|
| 28 | Something!
|
| 29 | :scream_cat: **`What will I do today`**
|
| 30 | Something Else!
|
| 31 | :cry: **`What obstacles are impeding my progress? Any info I need or want to share?`**
|
| 32 | Not much...
|
| 33 | Copied the result to the clipboard!
|
| 34 | ```
|
| 35 |
|
| 36 |
|
| 37 | ## Configuration
|
| 38 |
|
| 39 | You can obtain the path to the configuration file by simply running `standup-boy --path`. Edit the resulting file to override the defaults.
|
| 40 |
|
| 41 | Mind that this configuration only alters the final text that gets copied into your clipboard.
|
| 42 |
|
| 43 | ### Templates
|
| 44 |
|
| 45 | One can configure `standup-boy` to replace the default templates for the resulting standup text.
|
| 46 |
|
| 47 | An example of an alternative configuration, written in JSON format:
|
| 48 |
|
| 49 | ```json
|
| 50 | {
|
| 51 | "yesterday": "Hey, you! What did you do yesterday?",
|
| 52 |
|
| 53 | "today": "Oh really? And what are you gonna do today?",
|
| 54 |
|
| 55 | "obstacles": "Did you find any obstacles along the way, tho?"
|
| 56 | }
|
| 57 | ```
|
| 58 |
|
| 59 | ### Replace words
|
| 60 |
|
| 61 | `standup-boy` can also be configured to search and replace certain keywords for, for example, automatically link to JIRA tasks. RegExp syntax is supported.
|
| 62 |
|
| 63 | If you want to introduce the matched string into the replaced value, you can add the `%VAL%` keyword anywhere in your resulting text to interpolate the matched variable into it.
|
| 64 |
|
| 65 | An example of an alternative configuration, written in JSON format:
|
| 66 |
|
| 67 | ```json
|
| 68 | {
|
| 69 | "JIRA-[0-9]*": "[%VAL%](https://your-jira.url/%VAL%)"
|
| 70 | }
|
| 71 | ```
|
| 72 |
|
| 73 | This results in this text:
|
| 74 |
|
| 75 | ```
|
| 76 | I completed JIRA-220 today!
|
| 77 | ```
|
| 78 |
|
| 79 | Being replaced by:
|
| 80 |
|
| 81 | ```
|
| 82 | I completed [JIRA-220](https://your-jira.url/JIRA-220) today!
|
| 83 | ```
|
| 84 |
|
| 85 | If translated to markdown, a nice link appears in place of the old, lame, jira task name.
|
| 86 |
|
| 87 | ## License
|
| 88 |
|
| 89 | MIT © [vikepic](https://vikepic.github.io)
|