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

CLI improvements #1437

Merged
merged 13 commits into from
Mar 7, 2024
Merged

CLI improvements #1437

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
126e336
feat: allow unknown cli options for integrations
locksten Mar 4, 2024
5f01212
update logger
pavjacko Mar 5, 2024
7c0fa5d
handle log level
pavjacko Mar 5, 2024
757246e
update logger
pavjacko Mar 5, 2024
4a80791
fix relative path prints, fix UTs
pavjacko Mar 5, 2024
d012ddf
Merge branch 'feat/cli-updates' into chore/cli-updates
pavjacko Mar 5, 2024
062fab6
typed integration
pavjacko Mar 6, 2024
9878ea5
add integration to app-harness
pavjacko Mar 6, 2024
ce8a17f
update starter int
pavjacko Mar 6, 2024
de04774
fix support for single command integrations
pavjacko Mar 6, 2024
4101853
update option types
pavjacko Mar 7, 2024
1e7f659
fix rnv standalone
pavjacko Mar 7, 2024
a354017
remove console.log
pavjacko Mar 7, 2024
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
Prev Previous commit
Next Next commit
update logger
  • Loading branch information
@pavjacko
pavjacko committed Mar 5, 2024
commit 5f0121257a0240e680f027626c7cbfb173edc3c6
99 changes: 58 additions & 41 deletions packages/cli/src/logger/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,17 @@ import {
} from '@rnv/core';

const ICN_ROCKET = isSystemWin ? 'RNV' : '🚀';
const ICN_UNICORN = isSystemWin ? 'unicorn' : '🦄';
// const ICN_UNICORN = isSystemWin ? 'unicorn' : '🦄';
const _chalkCols = generateDefaultChalk();
const _chalkMono = {
..._chalkCols,
};

const colorBlue = { r: 10, g: 116, b: 230 }; // '#0a74e6'

let currentChalk: RnvApiChalk = _chalk;
let chalkBlue: any = _chalk.rgb(colorBlue.r, colorBlue.g, colorBlue.b);

let RNV = 'ReNative';
const PRIVATE_PARAMS = ['-k', '--key'];
let _currentProcess: NodeJS.Process;
Expand All @@ -44,6 +49,7 @@ export const logInitialize = () => {

if (ctx.program.mono) {
currentChalk = _chalkMono;
chalkBlue = _chalkMono;
}
_updateDefaultColors();
RNV = getCurrentCommand();
Expand All @@ -52,17 +58,16 @@ export const logInitialize = () => {

export const logWelcome = () => {
const ctx = getContext();
const chalCol = currentChalk.rgb(10, 116, 230);
const shortLen = 64;
// prettier-ignore
let str = _defaultColor(`
┌─────────────────────────────────────────────────────────────────┐
│ ${chalCol('██████╗')} ███████╗${chalCol('███╗ ██╗')} █████╗ ████████╗██╗${chalCol('██╗ ██╗')}███████╗ │
│ ${chalCol('██╔══██╗')}██╔════╝${chalCol('████╗ ██║')}██╔══██╗╚══██╔══╝██║${chalCol('██║ ██║')}██╔════╝ │
│ ${chalCol('██████╔╝')}█████╗ ${chalCol('██╔██╗ ██║')}███████║ ██║ ██║${chalCol('██║ ██║')}█████╗ │
│ ${chalCol('██╔══██╗')}██╔══╝ ${chalCol('██║╚██╗██║')}██╔══██║ ██║ ██║${chalCol('╚██╗ ██╔╝')}██╔══╝ │
│ ${chalCol('██║ ██║')}███████╗${chalCol('██║ ╚████║')}██║ ██║ ██║ ██║${chalCol(' ╚████╔╝ ')}███████╗ │
│ ${chalCol('╚═╝ ╚═╝')}╚══════╝${chalCol('╚═╝ ╚═══╝')}╚═╝ ╚═╝ ╚═╝ ╚═╝${chalCol(' ╚═══╝ ')}╚══════╝ │
│ ${chalkBlue('██████╗')} ███████╗${chalkBlue('███╗ ██╗')} █████╗ ████████╗██╗${chalkBlue('██╗ ██╗')}███████╗ │
│ ${chalkBlue('██╔══██╗')}██╔════╝${chalkBlue('████╗ ██║')}██╔══██╗╚══██╔══╝██║${chalkBlue('██║ ██║')}██╔════╝ │
│ ${chalkBlue('██████╔╝')}█████╗ ${chalkBlue('██╔██╗ ██║')}███████║ ██║ ██║${chalkBlue('██║ ██║')}█████╗ │
│ ${chalkBlue('██╔══██╗')}██╔══╝ ${chalkBlue('██║╚██╗██║')}██╔══██║ ██║ ██║${chalkBlue('╚██╗ ██╔╝')}██╔══╝ │
│ ${chalkBlue('██║ ██║')}███████╗${chalkBlue('██║ ╚████║')}██║ ██║ ██║ ██║${chalkBlue(' ╚████╔╝ ')}███████╗ │
│ ${chalkBlue('╚═╝ ╚═╝')}╚══════╝${chalkBlue('╚═╝ ╚═══╝')}╚═╝ ╚═╝ ╚═╝ ╚═╝${chalkBlue(' ╚═══╝ ')}╚══════╝ │
`);

if (ctx.files?.rnv?.package?.version) {
Expand Down Expand Up @@ -208,7 +213,7 @@ export const logSummary = (header = 'SUMMARY') => {
logAndSave(chalk().white('npx ' + getCurrentCommand(true)), true);
}

let logContent = printIntoBox(`All good as ${ICN_UNICORN} `);
let logContent = ''; //= printIntoBox(`All good as ${ICN_UNICORN} `);
if (ctx.logMessages && ctx.logMessages.length) {
logContent = '';
ctx.logMessages.forEach((m) => {
Expand All @@ -220,9 +225,14 @@ export const logSummary = (header = 'SUMMARY') => {
ctx.timeEnd = new Date();
timeString = `| ${ctx.timeEnd.toLocaleString()}`;

let str = printBoxStart(`${ICN_ROCKET} ${header} ${timeString}`, getCurrentCommand());
// let envString = '';
// if (ctx.process) {
// envString = `${ctx.process.platform} | ${ctx.process.arch} | node v${ctx.process.versions?.node}`;
// }

let str = printBoxStart(`${header} ${timeString} | rnv@${ctx.rnvVersion}`, getCurrentCommand());

str += printIntoBox(`ReNative Version: ${_highlightColor(ctx.rnvVersion)}`);
// str += printIntoBox(`ReNative Version: ${_highlightColor(ctx.rnvVersion)}`);
if (ctx.files?.project?.package?.name && ctx.files?.project?.package?.version) {
str += printIntoBox(`Project Name ($package.name): ${_highlightColor(ctx.files.project.package.name)}`);
str += printIntoBox(
Expand Down Expand Up @@ -280,7 +290,7 @@ export const logSummary = (header = 'SUMMARY') => {
str += printIntoBox(`Executed Time: ${_msToTime(ctx.timeEnd.getTime() - ctx.timeStart.getTime())}`);
}

str += printIntoBox('');
// str += printIntoBox('');

str += logContent.replace(/\n\s*\n\s*\n/g, '\n\n');

Expand Down Expand Up @@ -308,7 +318,7 @@ const _msToTime = (seconds: number) => {

const _getCurrentTask = () => {
const ctx = getContext();
return ctx._currentTask ? currentChalk.grey(` [${ctx._currentTask}]`) : '';
return ctx._currentTask ? currentChalk.grey(` ○ ${ctx._currentTask}:`) : '';
};

const _sanitizePaths = (msg: string) => {
Expand Down Expand Up @@ -341,22 +351,20 @@ export const logTask = (task: string, customChalk?: string | RnvApiChalkFn) => {

let msg = '';
if (typeof customChalk === 'string') {
msg = `${currentChalk.green(`[ task ]${_getCurrentTask()}`)} ${task}${taskCount} ${currentChalk.grey(
msg = `${currentChalk.green(`[task]${_getCurrentTask()}`)} ${task}${taskCount} ${currentChalk.grey(
customChalk
)}`;
} else if (customChalk) {
msg = customChalk(`[ task ]${_getCurrentTask()} ${task}${taskCount}`);
msg = customChalk(`[task]${_getCurrentTask()} ${task}${taskCount}`);
} else {
msg = `${currentChalk.green(`[ task ]${_getCurrentTask()}`)} ${task}${taskCount}`;
msg = `${currentChalk.green(`[task]${_getCurrentTask()}`)} ${task}${taskCount}`;
}

console.log(_sanitizePaths(msg));
// console.log(_sanitizePaths(msg));
};

export const logDefault = (task: string, customChalk?: string | RnvApiChalkFn) => {
if (!TASK_COUNTER[task]) TASK_COUNTER[task] = 0;
TASK_COUNTER[task] += 1;
const taskCount = currentChalk.grey(`[${TASK_COUNTER[task]}]`);
const taskCount = getLogCounter(task);

if (_jsonOnly) {
return _printJson({
Expand All @@ -368,17 +376,26 @@ export const logDefault = (task: string, customChalk?: string | RnvApiChalkFn) =

let msg = '';
if (typeof customChalk === 'string') {
msg = `[ log ]${_getCurrentTask()} ${task}${taskCount} ${currentChalk.grey(customChalk)}`;
msg = `[log]${_getCurrentTask()} ${task}${taskCount} ${currentChalk.grey(customChalk)}`;
} else if (customChalk) {
msg = customChalk(`[ log ]${_getCurrentTask()} ${task}${taskCount}`);
msg = customChalk(`[log]${_getCurrentTask()} ${task} ${taskCount}`);
} else {
msg = `[ log ]${_getCurrentTask()} ${task}${taskCount}`;
msg = `[log]${_getCurrentTask()} ${task} ${taskCount}`;
}

console.log(_sanitizePaths(msg));
// console.log(_sanitizePaths(msg));
};

const getLogCounter = (task: string) => {
if (!TASK_COUNTER[task]) TASK_COUNTER[task] = 0;
TASK_COUNTER[task] += 1;
const taskCount = currentChalk.grey(`[${TASK_COUNTER[task]}]`);
return taskCount;
};

export const logInitTask = (task: string, customChalk?: string | ((s: string) => string)) => {
const taskCount = getLogCounter(task);

if (_jsonOnly) {
return _printJson({
type: 'taskInit',
Expand All @@ -388,11 +405,11 @@ export const logInitTask = (task: string, customChalk?: string | ((s: string) =>
}
let msg = '';
if (typeof customChalk === 'string') {
msg = `${currentChalk.rgb(183, 84, 117)(`[ task ] ${task}`)} ${currentChalk.grey(customChalk)}`;
msg = `${chalkBlue(`task: ○ ${task}`)} ${customChalk} ${taskCount}`;
} else if (customChalk) {
msg = customChalk(`[ task ] ${task}`);
msg = customChalk(`task ○ ${task} ${taskCount}`);
} else {
msg = currentChalk.rgb(183, 84, 117)(`[ task ] ${task}`);
msg = `${chalkBlue('task:')} ○ ${task} ${taskCount}`;
}

console.log(msg);
Expand All @@ -414,13 +431,17 @@ export const logExitTask = (task: string, customChalk?: (s: string) => string) =
message: stripAnsi(_sanitizePaths(typeof customChalk === 'string' ? customChalk : task)),
});
}
const taskCount = getLogCounter(task);

let msg = '';
if (typeof customChalk === 'string') {
msg = `${currentChalk.rgb(183, 84, 117)(`[ task ] ${task}`)} ${currentChalk.grey(customChalk)}`;
msg = `${currentChalk.green(`task: < ${task}`)} ${currentChalk.grey(
customChalk
)}${taskCount} ${currentChalk.green('✔')}`;
} else if (customChalk) {
msg = customChalk(`[ task ] ${task}`);
msg = customChalk(`task: < ${task} ${taskCount} ${currentChalk.green('✔')}`);
} else {
msg = currentChalk.rgb(183, 84, 117)(`[ task ] ${task}`);
msg = `${currentChalk.green('task:')} ${currentChalk.green('✔')} ${task} ${taskCount}`;
}

console.log(msg);
Expand All @@ -432,11 +453,7 @@ export const logHook = (hook = '', msg = '') => {
if (_getCurrentTask()) payload.task = stripAnsi(_getCurrentTask());
return _printJson(payload);
}
console.log(
`${currentChalk.rgb(127, 255, 212)(`[ hook ]${_getCurrentTask()} ${hook}`)} ${currentChalk.grey(
_sanitizePaths(msg)
)}`
);
console.log(`${`[hook]`} ${_sanitizePaths(msg)}`);
};

export const logWarning = (msg: string | boolean | unknown) => {
Expand All @@ -449,7 +466,7 @@ export const logWarning = (msg: string | boolean | unknown) => {
message: stripAnsi(msgSn),
});
}
logAndSave(currentChalk.yellow(`[ warn ]${_getCurrentTask()} ${msgSn}`));
logAndSave(currentChalk.yellow(`[warn]${_getCurrentTask()} ${msgSn}`));
};

export const logInfo = (msg: string) => {
Expand All @@ -461,7 +478,7 @@ export const logInfo = (msg: string) => {
message: stripAnsi(_sanitizePaths(msg)),
});
}
console.log(currentChalk.cyan(`[ info ]${_getCurrentTask()} ${_sanitizePaths(msg)}`));
console.log(`${currentChalk.cyan('info:')}${_getCurrentTask()} ${_sanitizePaths(msg)}`);
};

export const logDebug = (...args: Array<string>) => {
Expand Down Expand Up @@ -490,7 +507,7 @@ export const isInfoEnabled = () => _isInfoEnabled;

export const logComplete = (isEnd = false) => {
if (_jsonOnly) return;
console.log(currentChalk.bold.white(`\n ${RNV} - Done! ${ICN_ROCKET}`));
console.log(currentChalk.bold(`${RNV} - Done! ${ICN_ROCKET}`));
if (isEnd) logEnd(0);
};

Expand All @@ -502,7 +519,7 @@ export const logSuccess = (msg: string) => {
message: stripAnsi(_sanitizePaths(msg)),
});
}
logAndSave(currentChalk.magenta(`[ success ]${_getCurrentTask()} ${_sanitizePaths(msg)}`));
logAndSave(currentChalk.magenta(`[success]${_getCurrentTask()} ${_sanitizePaths(msg)}`));
};

export const logError = (e: Error | string | unknown, isEnd = false, skipAnalytics = false) => {
Expand Down Expand Up @@ -536,9 +553,9 @@ export const logError = (e: Error | string | unknown, isEnd = false, skipAnalyti
message: stripAnsi(_sanitizePaths(err)),
});
} else if (e && e instanceof Error && e.message) {
logAndSave(currentChalk.red(`[ error ]${_getCurrentTask()} ${e.message}\n${e.stack}`), isEnd);
logAndSave(currentChalk.red(`[error]${_getCurrentTask()} ${e.message}\n${e.stack}`), isEnd);
} else {
logAndSave(currentChalk.red(`[ error ]${_getCurrentTask()} ${e}`), isEnd);
logAndSave(currentChalk.red(`[error]${_getCurrentTask()} ${e}`), isEnd);
}

ctx.runtime.keepSessionActive = false;
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/buildHooks/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { inquirerPrompt } from '../api';
import { getConfigProp } from '../context/contextProps';

export const executePipe = async (c: RnvContext, key: string) => {
logHook('executePipe', c?.program?.json ? key : `('${key}')`);
logDebug('executePipe', c?.program?.json ? key : `('${key}')`);

await buildHooks(c);

Expand Down Expand Up @@ -91,7 +91,7 @@ export const buildHooks = async (c: RnvContext) => {
? c.paths.buildHooks.src.indexTs
: c.paths.buildHooks.src.index;
try {
logHook('buildHooks', 'Build hooks not complied. BUILDING...');
logInfo('Build hooks not complied. BUILDING...');

await build({
entryPoints: [indexPath],
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tasks/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ export const findSuitableTask = async (c: RnvContext, specificTask?: string): Pr
}

logInfo(
`Current Engine: ${chalk().bold.white(c.runtime.engine?.config.id)} path: ${chalk().grey(
`Current Engine: ${chalk().bold.cyan(c.runtime.engine?.config.id)} path: ${chalk().grey(
c.runtime.engine?.rootPath
)}`
);
Expand Down Expand Up @@ -377,9 +377,10 @@ export const executeTask = async (
originTask?: string,
isFirstTask?: boolean
) => {
const pt = parentTask ? `=> [${parentTask}] ` : '';
// const pt = parentTask ? `=> [${parentTask}] ` : '';
c._currentTask = task;
logInitTask(`${pt}=> [${chalk().bold.rgb(170, 106, 170)(task)}]`);
// logInitTask(`${pt}=> [${chalk().bold.rgb(170, 106, 170)(task)}]`);
logInitTask(`${task}`);

if (!executedTasks[task]) executedTasks[task] = 0;
if (executedTasks[task] > TASK_LIMIT) {
Expand All @@ -402,8 +403,8 @@ To avoid that test your task code against parentTask and avoid executing same ta
executedTasks[task]++;

c._currentTask = parentTask;
const prt = parentTask ? `<= [${chalk().rgb(170, 106, 170)(parentTask)}] ` : '';
logExitTask(`${prt}<= ${task}`);
// const prt = parentTask ? `<= [${chalk().rgb(170, 106, 170)(parentTask)}] ` : '';
logExitTask(`${task}`);
};

/**
Expand Down