@servicetitan/startup 24.0.4 → 24.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/startup",
-    "version": "24.0.4",
+    "version": "24.1.1",
     "description": "",
     "homepage": "https://docs.st.dev/docs/frontend/startup",
     "repository": {
@@ -28,7 +28,7 @@
         "@types/eslint": "~8.56.3",
         "@types/less": "~3.0.3",
         "@types/moment-locales-webpack-plugin": "~1.2.2",
-        "@types/sass": "~1.43.1",
+        "@types/sass": "~1.45.0",
         "@types/webpack-assets-manifest": "~5.1.4",
         "@types/webpack-dev-server": "~3.11.5",
         "@types/yargs": "~17.0.24"
@@ -37,10 +37,10 @@
         "@babel/preset-env": "~7.24.7",
         "@jest/core": "~29.7.0",
         "@jest/types": "~29.6.3",
-        "@servicetitan/eslint-config": "24.0.4",
-        "@servicetitan/stylelint-config": "24.0.4",
+        "@servicetitan/eslint-config": "24.1.1",
+        "@servicetitan/stylelint-config": "24.1.1",
         "@svgr/webpack": "^8.1.0",
-        "@swc/core": "1.5.27",
+        "@swc/core": "1.6.5",
         "@types/debug": "^4.1.12",
         "@types/jest": "~29.5.12",
         "chalk": "~4.1.2",
@@ -49,41 +49,42 @@
         "css-loader": "~7.1.2",
         "debug": "^4.3.5",
         "deepmerge": "~4.3.1",
-        "esbuild-loader": "~4.1.0",
+        "esbuild-loader": "~4.2.0",
         "eslint": "~8.57.0",
         "execa": "~5.1.1",
         "fork-ts-checker-webpack-plugin": "~9.0.2",
-        "glob": "~10.4.1",
+        "glob": "~10.4.2",
         "html-webpack-plugin": "~5.6.0",
         "identity-obj-proxy": "~3.0.0",
         "jest": "~29.7.0",
         "jest-circus": "~29.7.0",
         "jest-environment-jsdom": "^29.7.0",
         "jest-fetch-mock": "~3.0.3",
-        "lerna": "~8.1.3",
+        "lerna": "~8.1.5",
         "less": "~4.2.0",
         "less-loader": "~12.2.0",
         "less-plugin-npm-import": "~2.1.0",
-        "memfs": "~4.9.2",
+        "memfs": "~4.9.3",
         "mini-css-extract-plugin": "~2.9.0",
         "moment": "^2.30.1",
         "moment-locales-webpack-plugin": "~1.2.0",
+        "multimatch": "~5.0.0",
         "portfinder": "~1.0.32",
         "postcss": "~8.4.38",
         "prettier": "~2.7.1",
-        "sass": "~1.77.4",
+        "sass": "~1.77.6",
         "sass-loader": "~14.2.1",
         "source-map-loader": "~5.0.0",
         "style-loader": "~4.0.0",
         "stylelint": "~14.16.1",
         "swc-loader": "0.2.6",
-        "ts-jest": "~29.1.4",
+        "ts-jest": "~29.1.5",
         "ts-loader": "~9.5.1",
         "ts-node": "~10.9.2",
         "typed-css-modules": "~0.9.1",
         "typescript": "~5.4.5",
         "username": "~5.1.0",
-        "webpack": "~5.91.0",
+        "webpack": "~5.92.1",
         "webpack-assets-manifest": "~5.2.1",
         "webpack-bundle-analyzer": "^4.10.2",
         "webpack-dev-server": "~3.11.2",
@@ -100,5 +101,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "fb08cd20968e5ae1a57527bd8aa39d3e257750be"
+    "gitHead": "ffae5820df5a370516c3e6a8b71d44cc3bacd06e"
 }

package/src/cli/commands/__tests__/get-command.test.ts

@@ -0,0 +1,17 @@
+import { CommandName } from '../../../utils';
+
+import { getCommand } from '../get-command';
+
+describe(`${getCommand.name}`, () => {
+    const subject = (name: CommandName) => getCommand(name);
+
+    test('retrieves known commands', () => {
+        Object.values(CommandName).forEach(name => {
+            expect(subject(name)).toBeDefined();
+        });
+    });
+
+    test('returns undefined when command is unknown', () => {
+        expect(subject('foo' as CommandName)).toBeUndefined();
+    });
+});

package/src/cli/commands/__tests__/get-user-commands.test.ts

@@ -0,0 +1,24 @@
+import { CommandName } from '../../../utils';
+import { getCommand } from '../get-command';
+import { getUserCommands } from '../get-user-commands';
+
+describe(`${getUserCommands.name}`, () => {
+    const subject = () => getUserCommands();
+
+    test('returns commands with descriptions', () => {
+        const descriptions = Object.values(CommandName)
+            .map(name => {
+                const Command = getCommand(name)!;
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                return new Command({ _: [] }).description();
+            })
+            .filter(description => !!description);
+
+        expect(subject().length).toBe(descriptions.length);
+    });
+
+    test('returns commands in ascending order by name', () => {
+        const names = subject().map(({ name }) => name);
+        expect(names).toEqual([...names].sort((a, b) => a.localeCompare(b)));
+    });
+});

package/src/cli/commands/__tests__/init.test.ts

@@ -39,12 +39,12 @@ describe(`[startup] ${Init.name}`, () => {
         });
     }
 
-    itCopies('template');
+    itCopies('template', 'template-react18');
 
-    describe('when instructed to create React 18 template', () => {
-        beforeEach(() => (args.react18 = true));
+    describe('when instructed to create React 17 template', () => {
+        beforeEach(() => (args.react17 = true));
 
-        itCopies('template', 'template-react18');
+        itCopies('template');
     });
 
     describe('with an output location', () => {

package/src/cli/commands/__tests__/mfe-package-publish.test.ts

@@ -171,6 +171,14 @@ describe(`[startup] ${MFEPackagePublish.name}`, () => {
         itLogsMessageAndSkipsPublishing(/is already published/);
     });
 
+    describe('when package is private', () => {
+        beforeEach(() =>
+            vol.fromJSON({ 'package.json': JSON.stringify({ name: packageName, private: true }) })
+        );
+
+        itLogsMessageAndSkipsPublishing(/private package - skip publishing/);
+    });
+
     describe('with unrecognized branch', () => {
         beforeEach(() => jest.mocked(gitGetBranch).mockReturnValue('foo'));
 

package/src/cli/commands/build.ts

@@ -16,6 +16,10 @@ interface Args {
 export class Build implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'build project for production';
+    }
+
     @logErrors
     async execute() {
         const packages = splitPackagesByType(

package/src/cli/commands/bundle-package.ts

@@ -16,6 +16,10 @@ interface Args {
 export class BundlePackage implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         const { config, stat = false, watch } = this.args;

package/src/cli/commands/eslint.ts

@@ -11,6 +11,10 @@ interface Args {
 export class ESLintCommand implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute(): Promise<void> {
         const { _: paths, fix } = this.args;

package/src/cli/commands/get-command.ts

@@ -0,0 +1,50 @@
+import { CommandName } from '../../utils';
+
+import { Build } from './build';
+import { BundlePackage } from './bundle-package';
+import { ESLintCommand } from './eslint';
+import { Init } from './init';
+import { Install } from './install';
+import { KendoUILicense } from './kendo-ui-license';
+import { Lint } from './lint';
+import { MFEPackageClean, MFEPackagePublish, MFEPublish } from './mfe-publish';
+import { PreparePackage } from './prepare-package';
+import { Start } from './start';
+import { StylesCheck } from './styles-check';
+import { Tests } from './tests';
+import { Command } from './types';
+
+type Newable<T> = new (...args: any[]) => T;
+
+export function getCommand(name: CommandName): Newable<Command> | undefined {
+    switch (name) {
+        case CommandName.build:
+            return Build;
+        case CommandName['bundle-package']:
+            return BundlePackage;
+        case CommandName.eslint:
+            return ESLintCommand;
+        case CommandName.init:
+            return Init;
+        case CommandName.install:
+            return Install;
+        case CommandName['kendo-ui-license']:
+            return KendoUILicense;
+        case CommandName.lint:
+            return Lint;
+        case CommandName['mfe-package-clean']:
+            return MFEPackageClean;
+        case CommandName['mfe-package-publish']:
+            return MFEPackagePublish;
+        case CommandName['mfe-publish']:
+            return MFEPublish;
+        case CommandName['prepare-package']:
+            return PreparePackage;
+        case CommandName.start:
+            return Start;
+        case CommandName['styles-check']:
+            return StylesCheck;
+        case CommandName.test:
+            return Tests;
+    }
+}

package/src/cli/commands/get-user-commands.ts

@@ -0,0 +1,19 @@
+import { CommandName } from '../../utils';
+
+import { getCommand } from './get-command';
+
+interface UserCommand {
+    name: string;
+    description: string;
+}
+
+export function getUserCommands() {
+    return Object.values(CommandName)
+        .sort((a, b) => a.localeCompare(b))
+        .map(name => {
+            const Command = getCommand(name)!;
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            return { name, description: new Command({ _: [] }).description() };
+        })
+        .filter(({ description }) => !!description) as UserCommand[];
+}

package/src/cli/commands/index.ts

@@ -1,6 +1,8 @@
 export * from './build';
 export * from './bundle-package';
 export * from './eslint';
+export * from './get-command';
+export * from './get-user-commands';
 export * from './init';
 export * from './install';
 export * from './kendo-ui-license';
@@ -10,7 +12,4 @@ export * from './start';
 export * from './tests';
 export * from './styles-check';
 export * from './mfe-publish';
-
-export interface Command {
-    execute(): Promise<void>;
-}
+export * from './types';

package/src/cli/commands/init.ts

@@ -7,13 +7,17 @@ import { log, logErrors } from '../../utils';
 import { Command } from './';
 
 interface Args {
-    react18?: boolean;
+    react17?: boolean;
     output?: string;
 }
 
 export class Init implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'generate empty project';
+    }
+
     @logErrors
     async execute() {
         const destination = path.resolve(this.args.output ?? '.');
@@ -25,11 +29,11 @@ export class Init implements Command {
 
         await copyFiles('template', destination);
 
-        if (this.args.react18) {
+        if (!this.args.react17) {
             await copyFiles('template-react18', destination);
         }
 
-        log.info(`copied${this.args.react18 ? ' React 18' : ''} template to ${destination}`);
+        log.info(`copied${this.args.react17 ? ' React 17' : ''} template to ${destination}`);
     }
 }
 

package/src/cli/commands/install.ts

@@ -4,6 +4,10 @@ import { log, logErrors, getStartupVersion } from '../../utils';
 import { Command } from '.';
 
 export class Install implements Command {
+    description() {
+        return 'install project dependencies';
+    }
+
     @logErrors
     async execute() {
         const installCommand = process.env.CI ? 'ci' : 'i';

package/src/cli/commands/kendo-ui-license.ts

@@ -30,6 +30,10 @@ const LICENSE = Buffer.from(ENCODED_LICENSE, 'base64').toString('ascii');
 const LICENSING_PACKAGE = '@progress/kendo-licensing';
 
 export class KendoUILicense implements Command {
+    description() {
+        return 'install KendoReact license key';
+    }
+
     async execute() {
         if (!isModuleInstalled(LICENSING_PACKAGE)) {
             return;

package/src/cli/commands/lint.ts

@@ -32,6 +32,10 @@ export class Lint implements Command {
         this.paths = [...args._];
     }
 
+    description() {
+        return 'run eslint and stylelint';
+    }
+
     async execute() {
         await this.checkStyles();
         await this.eslint();

package/src/cli/commands/mfe-publish.ts

@@ -45,6 +45,10 @@ interface Args extends ArgsPackagePublish, ArgsPackageClean {
 export class MFEPublish implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'publish or unpublish MFE packages';
+    }
+
     @logErrors
     async execute() {
         let packages = splitPackagesByType(getPackages())[PackageType.Webpack] ?? [];
@@ -93,14 +97,25 @@ export class MFEPublish implements Command {
 export class MFEPackagePublish implements Command {
     constructor(private args: ArgsPackagePublish) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!isWebComponent()) {
             throw new Error('only web-components can be published');
         }
 
-        const data = this.getPublishData();
         const packageJson = readJson('package.json');
+
+        if (packageJson.private) {
+            log.info('private package - skip publishing');
+
+            return;
+        }
+
+        const data = this.getPublishData();
         const packageName = packageJson.name;
 
         if (!data.version) {
@@ -197,6 +212,10 @@ export class MFEPackagePublish implements Command {
 export class MFEPackageClean implements Command {
     constructor(private args: ArgsPackageClean) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!isWebComponent()) {

package/src/cli/commands/prepare-package.ts

@@ -9,6 +9,10 @@ interface Args {
 export class PreparePackage implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!this.args.watch) {

package/src/cli/commands/start.ts

@@ -14,6 +14,10 @@ interface Args {
 export class Start implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'run project in development mode';
+    }
+
     @logErrors
     async execute() {
         const packages = splitPackagesByType(

package/src/cli/commands/styles-check.ts

@@ -121,6 +121,10 @@ function checkStylesWebComponent(files: FileInfo[]) {
 }
 
 export class StylesCheck implements Command {
+    description() {
+        return undefined;
+    }
+
     // eslint-disable-next-line @typescript-eslint/require-await
     async execute() {
         if (isLegacy()) {

package/src/cli/commands/tests.ts

@@ -9,6 +9,10 @@ import { Command } from '.';
 export class Tests implements Command {
     constructor(private args: Config.Argv) {}
 
+    description() {
+        return 'run tests';
+    }
+
     @logErrors
     async execute() {
         const jestConfig = getJestConfigCLI(this.args);

package/src/cli/commands/types.ts

@@ -0,0 +1,4 @@
+export interface Command {
+    execute(): Promise<void>;
+    description(): string | undefined;
+}

package/src/cli/index.ts

@@ -1,69 +1,23 @@
 import execa from 'execa';
 import { argv, Arguments } from 'yargs';
-
-import { CommandName, log } from '../utils';
-import {
-    Build,
-    BundlePackage,
-    Command,
-    ESLintCommand,
-    Init,
-    Install,
-    KendoUILicense,
-    Lint,
-    MFEPackageClean,
-    MFEPackagePublish,
-    MFEPublish,
-    PreparePackage,
-    Start,
-    StylesCheck,
-    Tests,
-} from './commands';
+import { CommandName, getStartupVersion, log } from '../utils';
+import { getCommand, getUserCommands } from './commands';
 import { setNodeOptions } from './utils';
 
-interface Newable<T> {
-    new (...args: any[]): T;
-}
-
-function getCommand(name: CommandName): Newable<Command> {
-    switch (name) {
-        case CommandName.build:
-            return Build;
-        case CommandName['bundle-package']:
-            return BundlePackage;
-        case CommandName.eslint:
-            return ESLintCommand;
-        case CommandName.init:
-            return Init;
-        case CommandName.install:
-            return Install;
-        case CommandName['kendo-ui-license']:
-            return KendoUILicense;
-        case CommandName.lint:
-            return Lint;
-        case CommandName['mfe-package-clean']:
-            return MFEPackageClean;
-        case CommandName['mfe-package-publish']:
-            return MFEPackagePublish;
-        case CommandName['mfe-publish']:
-            return MFEPublish;
-        case CommandName['prepare-package']:
-            return PreparePackage;
-        case CommandName.start:
-            return Start;
-        case CommandName['styles-check']:
-            return StylesCheck;
-        case CommandName.test:
-            return Tests;
-        default:
-            log.error(`${name}: command not found!`);
-            process.exit(127);
-    }
+const argvSync = argv as Arguments;
+const name = argvSync._[0]?.toString() as CommandName;
+if (!name) {
+    log.info(`startup cli v${getStartupVersion()}`);
+    usage();
+    process.exit(0);
 }
 
-const argvSync = argv as Arguments;
-const name = argvSync._[0].toString() as CommandName;
 const Command = getCommand(name);
+if (!Command) {
+    log.error(`Unknown command: "${name}"`);
+    usage();
+    process.exit(127);
+}
 
 if (setNodeOptions(name)) {
     // Run command in child process with amended NODE_OPTIONS
@@ -77,3 +31,17 @@ if (setNodeOptions(name)) {
         process.exit(1);
     });
 }
+
+function usage() {
+    write('\nUsage:\n');
+
+    const commands = getUserCommands().filter(({ name }) => !!name);
+    const maxNameLength = commands.reduce((result, { name }) => Math.max(result, name.length), 0);
+    commands.forEach(({ name, description }) => {
+        write(`startup ${name.padEnd(maxNameLength, ' ')}  ${description}`);
+    });
+}
+
+function write(text: string) {
+    return console.info(text); // eslint-disable-line no-console
+}

package/src/utils/__tests__/get-configuration.test.ts

@@ -40,11 +40,11 @@ describe('[startup] Utils', () => {
     afterEach(() => jest.resetAllMocks());
 
     describe(`${getConfiguration.name}`, () => {
-        let location: string | undefined;
+        let locationOrJson: string | Record<string, any> | undefined;
 
-        beforeEach(() => (location = undefined));
+        beforeEach(() => (locationOrJson = undefined));
 
-        const subject = () => getConfiguration(location);
+        const subject = () => getConfiguration(locationOrJson);
 
         itReturns(subject, {});
 
@@ -60,7 +60,7 @@ describe('[startup] Utils', () => {
             const cli = { baz: 'qux' };
 
             beforeEach(() => {
-                location = 'packages/foo';
+                locationOrJson = 'packages/foo';
                 vol.fromJSON({ [`packages/foo/${packageJson}`]: JSON.stringify({ cli }) });
             });
 
@@ -69,6 +69,18 @@ describe('[startup] Utils', () => {
             });
         });
 
+        describe('with JSON', () => {
+            const cli = { baz: 'qux' };
+
+            beforeEach(() => {
+                locationOrJson = { cli };
+            });
+
+            test("returns location's cli", () => {
+                expect(subject()).toEqual(cli);
+            });
+        });
+
         describe('with no package.json', () => {
             beforeEach(() => vol.reset());
 
@@ -79,11 +91,11 @@ describe('[startup] Utils', () => {
     });
 
     describe(`${getConfigurationSafe.name}`, () => {
-        let location: string | undefined;
+        let locationOrJson: string | Record<string, any> | undefined;
 
-        beforeEach(() => (location = undefined));
+        beforeEach(() => (locationOrJson = undefined));
 
-        const subject = () => getConfigurationSafe(location);
+        const subject = () => getConfigurationSafe(locationOrJson);
 
         itReturns(subject, {});
 
@@ -99,7 +111,7 @@ describe('[startup] Utils', () => {
             const cli = { baz: 'qux' };
 
             beforeEach(() => {
-                location = 'packages/foo';
+                locationOrJson = 'packages/foo';
                 vol.fromJSON({ [`packages/foo/${packageJson}`]: JSON.stringify({ cli }) });
             });
 
@@ -108,6 +120,16 @@ describe('[startup] Utils', () => {
             });
         });
 
+        describe('with JSON', () => {
+            const cli = { baz: 'qux' };
+
+            beforeEach(() => (locationOrJson = { cli }));
+
+            test("returns location's cli", () => {
+                expect(subject()).toEqual(cli);
+            });
+        });
+
         describe('with no package.json', () => {
             beforeEach(() => vol.reset());