@qodalis/angular-cli
Version:
A lightweight and flexible command-line interface (CLI) tool designed to streamline workflows and automate tasks for developers.
98 lines • 12.2 kB
JavaScript
import { Injectable } from '@angular/core';
import { LIBRARY_VERSION } from '../../../version';
import { CLi_Name_Art } from '../../constants';
import { CliForegroundColor } from '@qodalis/cli-core';
import { getGreetingBasedOnTime } from '../../../utils';
import * as i0 from "@angular/core";
/**
* Service that displays the welcome message to the user.
*/
export class CliWelcomeMessageService {
/**
* Displays the welcome message to the user.
* @param context
* @returns void
*/
displayWelcomeMessage(context) {
const welcomeConfig = context.options?.welcomeMessage;
// Handle the 'show' property
if (welcomeConfig?.show) {
const showOption = welcomeConfig.show;
// Determine if the welcome message should be shown
if (!this.shouldDisplayWelcomeMessage(showOption)) {
context.showPrompt();
return;
}
}
if (welcomeConfig?.message) {
context.terminal.writeln(welcomeConfig?.message);
}
else {
const welcomeMessage = [
`Welcome to Web CLI [Version ${context.writer.wrapInColor(LIBRARY_VERSION, CliForegroundColor.Green)}]`,
'(c) 2024 Qodalis Solutions. All rights reserved.',
CLi_Name_Art,
'',
context.writer.wrapInColor('Documentation: ', CliForegroundColor.Green) + 'https://cli-docs.qodalis.com/',
'',
"Type 'help' to get started.",
'',
];
welcomeMessage.forEach((line, index) => {
context.terminal.write(line + '\r\n');
});
}
this.recordWelcomeMessageDisplay();
context.showPrompt();
context.textAnimator?.showText(getGreetingBasedOnTime(), {
speed: 60,
removeAfterTyping: true,
});
}
/**
* Determines if the welcome message should be displayed based on the show option.
* @param showOption - The show option from the config.
* @returns true if the message should be displayed, false otherwise.
*/
shouldDisplayWelcomeMessage(showOption) {
const lastDisplayed = this.getLastWelcomeMessageDisplayTime();
switch (showOption) {
case 'always':
return true;
case 'once':
return !lastDisplayed; // Show only if it hasn't been shown before
case 'daily':
if (!lastDisplayed)
return true; // No previous display, show it
const now = new Date();
const lastDate = new Date(lastDisplayed);
return now.toDateString() !== lastDate.toDateString(); // Compare dates
case 'never':
return false;
default:
return true;
}
}
/**
* Records the current time as the last display time for the welcome message.
*/
recordWelcomeMessageDisplay() {
localStorage.setItem('cliWelcomeMessageLastDisplayed', new Date().toISOString());
}
/**
* Retrieves the last display time of the welcome message.
* @returns The ISO string of the last display time or null if not recorded.
*/
getLastWelcomeMessageDisplayTime() {
return localStorage.getItem('cliWelcomeMessageLastDisplayed');
}
static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: CliWelcomeMessageService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: CliWelcomeMessageService, providedIn: 'root' }); }
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: CliWelcomeMessageService, decorators: [{
type: Injectable,
args: [{
providedIn: 'root',
}]
}] });
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cli-welcome-message.service.js","sourceRoot":"","sources":["../../../../../../../projects/cli/src/lib/cli/services/system/cli-welcome-message.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAwB,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;;AAExD;;GAEG;AAIH,MAAM,OAAO,wBAAwB;IACjC;;;;OAIG;IACI,qBAAqB,CAAC,OAA6B;QACtD,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC;QAEtD,6BAA6B;QAC7B,IAAI,aAAa,EAAE,IAAI,EAAE;YACrB,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC;YAEtC,mDAAmD;YACnD,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE;gBAC/C,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,OAAO;aACV;SACJ;QAED,IAAI,aAAa,EAAE,OAAO,EAAE;YACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;SACpD;aAAM;YACH,MAAM,cAAc,GAAG;gBACnB,+BAA+B,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,eAAe,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG;gBACvG,kDAAkD;gBAClD,YAAY;gBACZ,EAAE;gBACF,OAAO,CAAC,MAAM,CAAC,WAAW,CACtB,iBAAiB,EACjB,kBAAkB,CAAC,KAAK,CAC3B,GAAG,+BAA+B;gBACnC,EAAE;gBACF,6BAA6B;gBAC7B,EAAE;aACL,CAAC;YAEF,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBACnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;SACN;QAED,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACnC,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,sBAAsB,EAAE,EAAE;YACrD,KAAK,EAAE,EAAE;YACT,iBAAiB,EAAE,IAAI;SAC1B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACK,2BAA2B,CAC/B,UAAiD;QAEjD,MAAM,aAAa,GAAG,IAAI,CAAC,gCAAgC,EAAE,CAAC;QAE9D,QAAQ,UAAU,EAAE;YAChB,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC;YAChB,KAAK,MAAM;gBACP,OAAO,CAAC,aAAa,CAAC,CAAC,2CAA2C;YACtE,KAAK,OAAO;gBACR,IAAI,CAAC,aAAa;oBAAE,OAAO,IAAI,CAAC,CAAC,+BAA+B;gBAChE,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC;gBACzC,OAAO,GAAG,CAAC,YAAY,EAAE,KAAK,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,gBAAgB;YAC3E,KAAK,OAAO;gBACR,OAAO,KAAK,CAAC;YACjB;gBACI,OAAO,IAAI,CAAC;SACnB;IACL,CAAC;IAED;;OAEG;IACK,2BAA2B;QAC/B,YAAY,CAAC,OAAO,CAChB,gCAAgC,EAChC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAC3B,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,gCAAgC;QACpC,OAAO,YAAY,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAClE,CAAC;+GA7FQ,wBAAwB;mHAAxB,wBAAwB,cAFrB,MAAM;;4FAET,wBAAwB;kBAHpC,UAAU;mBAAC;oBACR,UAAU,EAAE,MAAM;iBACrB","sourcesContent":["import { Injectable } from '@angular/core';\nimport { LIBRARY_VERSION } from '../../../version';\nimport { CLi_Name_Art } from '../../constants';\nimport { CliForegroundColor, ICliExecutionContext } from '@qodalis/cli-core';\nimport { getGreetingBasedOnTime } from '../../../utils';\n\n/**\n * Service that displays the welcome message to the user.\n */\n@Injectable({\n    providedIn: 'root',\n})\nexport class CliWelcomeMessageService {\n    /**\n     * Displays the welcome message to the user.\n     * @param context\n     * @returns void\n     */\n    public displayWelcomeMessage(context: ICliExecutionContext) {\n        const welcomeConfig = context.options?.welcomeMessage;\n\n        // Handle the 'show' property\n        if (welcomeConfig?.show) {\n            const showOption = welcomeConfig.show;\n\n            // Determine if the welcome message should be shown\n            if (!this.shouldDisplayWelcomeMessage(showOption)) {\n                context.showPrompt();\n                return;\n            }\n        }\n\n        if (welcomeConfig?.message) {\n            context.terminal.writeln(welcomeConfig?.message);\n        } else {\n            const welcomeMessage = [\n                `Welcome to Web CLI [Version ${context.writer.wrapInColor(LIBRARY_VERSION, CliForegroundColor.Green)}]`,\n                '(c) 2024 Qodalis Solutions. All rights reserved.',\n                CLi_Name_Art,\n                '',\n                context.writer.wrapInColor(\n                    'Documentation: ',\n                    CliForegroundColor.Green,\n                ) + 'https://cli-docs.qodalis.com/',\n                '',\n                \"Type 'help' to get started.\",\n                '',\n            ];\n\n            welcomeMessage.forEach((line, index) => {\n                context.terminal.write(line + '\\r\\n');\n            });\n        }\n\n        this.recordWelcomeMessageDisplay();\n        context.showPrompt();\n        context.textAnimator?.showText(getGreetingBasedOnTime(), {\n            speed: 60,\n            removeAfterTyping: true,\n        });\n    }\n\n    /**\n     * Determines if the welcome message should be displayed based on the show option.\n     * @param showOption - The show option from the config.\n     * @returns true if the message should be displayed, false otherwise.\n     */\n    private shouldDisplayWelcomeMessage(\n        showOption: 'always' | 'once' | 'daily' | 'never',\n    ): boolean {\n        const lastDisplayed = this.getLastWelcomeMessageDisplayTime();\n\n        switch (showOption) {\n            case 'always':\n                return true;\n            case 'once':\n                return !lastDisplayed; // Show only if it hasn't been shown before\n            case 'daily':\n                if (!lastDisplayed) return true; // No previous display, show it\n                const now = new Date();\n                const lastDate = new Date(lastDisplayed);\n                return now.toDateString() !== lastDate.toDateString(); // Compare dates\n            case 'never':\n                return false;\n            default:\n                return true;\n        }\n    }\n\n    /**\n     * Records the current time as the last display time for the welcome message.\n     */\n    private recordWelcomeMessageDisplay(): void {\n        localStorage.setItem(\n            'cliWelcomeMessageLastDisplayed',\n            new Date().toISOString(),\n        );\n    }\n\n    /**\n     * Retrieves the last display time of the welcome message.\n     * @returns The ISO string of the last display time or null if not recorded.\n     */\n    private getLastWelcomeMessageDisplayTime(): string | null {\n        return localStorage.getItem('cliWelcomeMessageLastDisplayed');\n    }\n}\n"]}