Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the ability to customize grey text #34

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add the ability to customize grey text #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
"default": {
"taskbookDirectory": "~",
"displayCompleteTasks": true,
"displayProgressOverview": true
"displayProgressOverview": true,
"greyRendererMethod": "grey"
}
},
"scripts": {
Expand Down
11 changes: 10 additions & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,8 @@ The following illustrates all the available options with their respective defaul
{
"taskbookDirectory": "~",
"displayCompleteTasks": true,
"displayProgressOverview": true
"displayProgressOverview": true,
"greyColorOverride": "grey"
}
```

Expand Down Expand Up @@ -191,6 +192,14 @@ Display tasks that are marked as complete.

Display progress overview below the timeline and board views.


##### `greyColorOverride`

- Type: `String`
- Default: `grey`

Use [Chalk Colors](https://github.com/chalk/chalk#colors) to override grey text color. Use it in case you want to customize grey text render or we can not see it in terminal.

## Flight Manual

The following is a minor walkthrough containing a set of examples on how to use taskbook.
Expand Down
62 changes: 34 additions & 28 deletions src/render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const config = require('./config');
signale.config({displayLabel: false});

const {await: wait, error, log, note, pending, success} = signale;
const {blue, green, grey, magenta, red, underline, yellow} = chalk;
const {blue, green, magenta, red, underline, yellow} = chalk;

const priorities = {2: 'yellow', 3: 'red'};

Expand All @@ -16,7 +16,7 @@ class Render {
}

_colorBoards(boards) {
return boards.map(x => grey(x)).join(' ');
return boards.map(x => this.greyRender(x)).join(' ');
}

_isBoardComplete(items) {
Expand All @@ -27,12 +27,12 @@ class Render {
_getAge(birthday) {
const daytime = 24 * 60 * 60 * 1000;
const age = Math.round(Math.abs((birthday - Date.now()) / daytime));
return (age === 0) ? '' : grey(`${age}d`);
return (age === 0) ? '' : this.greyRender(`${age}d`);
}

_getCorrelation(items) {
const {tasks, complete} = this._getItemStats(items);
return grey(`[${complete}/${tasks}]`);
return this.greyRender(`[${complete}/${tasks}]`);
}

_getItemStats(items) {
Expand All @@ -57,7 +57,7 @@ class Render {
}

_buildTitle(key, items) {
const title = (key === new Date().toDateString()) ? `${underline(key)} ${grey('[Today]')}` : underline(key);
const title = (key === new Date().toDateString()) ? `${underline(key)} ${this.greyRender('[Today]')}` : underline(key);
const correlation = this._getCorrelation(items);
return {title, correlation};
}
Expand All @@ -67,7 +67,7 @@ class Render {

const {_id} = item;
prefix.push(' '.repeat(4 - String(_id).length));
prefix.push(grey(`${_id}.`));
prefix.push(this.greyRender(`${_id}.`));

return prefix.join(' ');
}
Expand All @@ -81,7 +81,7 @@ class Render {
if (!isComplete && priority > 1) {
message.push(underline[priorities[priority]](description));
} else {
message.push(isComplete ? grey(description) : description);
message.push(isComplete ? this.greyRender(description) : description);
}

if (!isComplete && priority > 1) {
Expand Down Expand Up @@ -134,6 +134,12 @@ class Render {
return note(msgObj);
}

greyRender(text) {
const func = chalk[this._configuration.greyColorOverride] || chalk.grey;

return func(text);
}

displayByBoard(data) {
Object.keys(data).forEach(board => {
if (this._isBoardComplete(data[board]) && !this._configuration.displayCompleteTasks) {
Expand Down Expand Up @@ -176,10 +182,10 @@ class Render {
percent = percent >= 75 ? green(`${percent}%`) : percent >= 50 ? yellow(`${percent}%`) : `${percent}%`;

const status = [
`${green(complete)} ${grey('done')}`,
`${blue(inProgress)} ${grey('in-progress')}`,
`${magenta(pending)} ${grey('pending')}`,
`${blue(notes)} ${grey(notes === 1 ? 'note' : 'notes')}`
`${green(complete)} ${this.greyRender('done')}`,
`${blue(inProgress)} ${this.greyRender('in-progress')}`,
`${magenta(pending)} ${this.greyRender('pending')}`,
`${blue(notes)} ${this.greyRender(notes === 1 ? 'note' : 'notes')}`
];

if (complete !== 0 && inProgress === 0 && pending === 0 && notes === 0) {
Expand All @@ -190,8 +196,8 @@ class Render {
log({prefix: '\n ', message: 'Type `tb --help` to get started!', suffix: yellow('★')});
}

log({prefix: '\n ', message: grey(`${percent} of all tasks complete.`)});
log({prefix: ' ', message: status.join(grey(' · ')), suffix: '\n'});
log({prefix: '\n ', message: this.greyRender(`${percent} of all tasks complete.`)});
log({prefix: ' ', message: status.join(this.greyRender(' · ')), suffix: '\n'});
}

invalidCustomAppDir(path) {
Expand All @@ -201,7 +207,7 @@ class Render {
}

invalidID(id) {
const [prefix, suffix] = ['\n', grey(id)];
const [prefix, suffix] = ['\n', this.greyRender(id)];
const message = 'Unable to find item with id:';
error({prefix, message, suffix});
}
Expand All @@ -223,7 +229,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Checked ${ids.length > 1 ? 'tasks' : 'task'}:`;
success({prefix, message, suffix});
}
Expand All @@ -233,7 +239,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Unchecked ${ids.length > 1 ? 'tasks' : 'task'}:`;
success({prefix, message, suffix});
}
Expand All @@ -243,7 +249,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Started ${ids.length > 1 ? 'tasks' : 'task'}:`;
success({prefix, message, suffix});
}
Expand All @@ -253,7 +259,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Paused ${ids.length > 1 ? 'tasks' : 'task'}:`;
success({prefix, message, suffix});
}
Expand All @@ -263,7 +269,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Starred ${ids.length > 1 ? 'items' : 'item'}:`;
success({prefix, message, suffix});
}
Expand All @@ -273,7 +279,7 @@ class Render {
return;
}

const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Unstarred ${ids.length > 1 ? 'items' : 'item'}:`;
success({prefix, message, suffix});
}
Expand All @@ -297,44 +303,44 @@ class Render {
}

successCreate({_id, _isTask}) {
const [prefix, suffix] = ['\n', grey(_id)];
const [prefix, suffix] = ['\n', this.greyRender(_id)];
const message = `Created ${_isTask ? 'task:' : 'note:'}`;
success({prefix, message, suffix});
}

successEdit(id) {
const [prefix, suffix] = ['\n', grey(id)];
const [prefix, suffix] = ['\n', this.greyRender(id)];
const message = 'Updated description of item:';
success({prefix, message, suffix});
}

successDelete(ids) {
const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Deleted ${ids.length > 1 ? 'items' : 'item'}:`;
success({prefix, message, suffix});
}

successMove(id, boards) {
const [prefix, suffix] = ['\n', grey(boards.join(', '))];
const message = `Move item: ${grey(id)} to`;
const [prefix, suffix] = ['\n', this.greyRender(boards.join(', '))];
const message = `Move item: ${this.greyRender(id)} to`;
success({prefix, message, suffix});
}

successPriority(id, level) {
const prefix = '\n';
const message = `Updated priority of task: ${grey(id)} to`;
const message = `Updated priority of task: ${this.greyRender(id)} to`;
const suffix = level === '3' ? red('high') : (level === '2' ? yellow('medium') : green('normal'));
success({prefix, message, suffix});
}

successRestore(ids) {
const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Restored ${ids.length > 1 ? 'items' : 'item'}:`;
success({prefix, message, suffix});
}

successCopyToClipboard(ids) {
const [prefix, suffix] = ['\n', grey(ids.join(', '))];
const [prefix, suffix] = ['\n', this.greyRender(ids.join(', '))];
const message = `Copied the ${ids.length > 1 ? 'descriptions of items' : 'description of item'}:`;
success({prefix, message, suffix});
}
Expand Down