Wofo: task development wofkflow assistant

Usage

start new task:

wofo start TASK-1234

this will:

1. update local repository:

   • if it's not cloned yet:

     • clone repo into ...tasks/.origin dir (or into config.rootDir/config.originDir)

   • if already cloned:

     • pull latest changes into .origin dir

   • run shell commands from config.hooks.originUpdated (e.g [npm install] to install deps)

2. copy the .origin to ~/tasks/TASK-1234 subdir

   • (this step will be skipped for config.copyOriginToTask: false)

3. create new branch, named TASK-1234

   • or task-1234 if the lowecase is specified in config.branches.inLowerCase:true

4. run config.hooks.taskCopyReady hook, (optional, see config) e.g.:

   • [ npm install ] to install deps

   • [ npm install, code .] install deps and open VSCode with newly created task dir

start new task derived from specific branch: (temporarily disabled)

wofo start TASK-1234 some-remote-branch

this will do all the same but tas branch will be derived from some-remote-branch instead of config.branches.baseBranch

make commit

wofo commit some commit message

will make commit with the message:

TASK-1234 | some commit message

if config.commits.firstWordAsCommitType and config.commits.headerSeparator are specified:

TASK-1234 | some | commit message

if no config.commits.headerSeparator in config:

TASK-1234 some commit message

if no config.commits.taskId in config:

some commit message

rebase on base branch

wofo rebase

will rebase current branch onto origin/<config.branches.baseBranch> (fetching it before)

wofo rebase another-branch

will rebase current branch onto another-branch

wofo rebase tries to detect all commits related to the current task by filtering the ones which commit message starts from TASK-XXXX (or whatever config.commits.taskId.extractRegex is specified in config to get task id from current branch name)

squash tasks commits

wofo squash

will squash all last commits prefixed with current task id (TASK-XXXX) into one commit. The commit message will be the message of the first task commit message

wofo squash fix some message

will squash task commits into one with message:

TASK-1234 | fix | some message

get info

show current config

wofo show config

 > Workspace config:

 {
  repo: '[email protected]:off-border/workflow-assist.git',
  rootDir: '~/tasks',
  originDir: '.origin',
...

show current task

wofo show task

> Current task: TASK-1234

Getting commands help

    wofo help

will display the usage info

wofo help <command>

will show detailed help for selected command

Installation

0. npm i -g wofo
1. create your workflow directory (e.g. ~/tasks)
2. create .workflow.config.js in the workflow dir
3. copy the following code to the config file and change the settings as you wish

module.exports = {
    // your project repo
    repo: '[email protected]:off-border/workflow-assist.git',

    // where you want your working copies to be put
    rootDir: '~/tasks',

    // where to keep the main repo copy. this will be a subdir in your rootDir
    originDir: '.origin',

    tasks: {
        // prefix to append to generated task dir (e.g. fe-TASK-1234)
        directoryPrefix: 'fe-'
    }

    // configure a new task branches creation and rebasing
    branches: {
        // the branch which task branches will be created from and rebased on
        baseBranch: 'master',
        // always convert task-id to lowercase (TASK-1234 -> task-1234)
        inLowerCase: true,
        // max length of the task branch name
        maxLength: 50,
    },

    // to switch whether it should create a new folder for task or use the current one
    copyOriginToTaskDir: true,

    // hooks
    hooks: {
        // commands to run after copying .origin to a TASK-1234 dir
        taskCopyReady: [
            // install deps
            'yarn',
            'echo DEPS INSTALLED',
            // launch VSCode (for linux)
            'code $TASK_DIR &',
        ],
    },

    // commits config
    commits: {
        // how to format task-id in the commit message
        taskId: {
            // regEx to extract task id from current branch name
            // e.g. here will be extracted:
            //    TASK-1234 from TASK-1234-some-text
            //    !1234 from !1234-some-text
            extractRegex: /(!\d+|TASK-\d+)/i,

            // convert task id to upper case (task-1234 -> TASK-1234)
            upperCase: true,
        },

        // header fields separator (e.g. "TASK-1234 | type | message")
        headerSeparator: ' | ',

        // use the first word of the message as a commit type
        // (e.g. "wofo commit 'some commit message'" -> "TASK-1234 | some | commit message)
        firstWordAsCommitType: true,
    },
};

Known issues

no global .wofkflow.config.js yet

for now wofo command looks for config starting from current dir and goes up until it finds .wofkflow.config.js in some of the parent dirs. That means the command should be run in the directory where the correct config file exists is located in one of the parent dirs.

js/cjs config wrong format

for now only .js config files supported (no .ts/.json)

Config export format (commonjs/esnext) depends on the package.json "type" section value. (e.g. "type": "module") (for JS/TS based projects)

If wofo command says that no config file found - check if its export type corresponds to your project package.json -> type setting