@servicetitan/startup 33.1.1 → 34.0.1

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

@@ -3,22 +3,14 @@ import { execSync } from 'child_process';
 import { fs, vol } from 'memfs';
 import path from 'path';
 import terminalLink from 'terminal-link';
-
+import type { ProjectPackage } from '../../../../utils';
 import { findPackages, getReviewConfiguration, log } from '../../../../utils';
 import { expectCalls } from '../__mocks__';
+import { Review } from '../review';
 import { rules } from '../rules';
-import {
-    ErrorSeverity,
-    FixCategory,
-    Level,
-    Package,
-    PackageError,
-    ReviewConfiguration,
-} from '../types';
+import { ErrorSeverity, FixCategory, Level, PackageError, ReviewConfiguration } from '../types';
 import { indent } from '../utils';
 
-import { Review } from '../review';
-
 jest.mock('child_process', () => ({ execSync: jest.fn() }));
 jest.mock('fs', () => fs);
 jest.mock('terminal-link', () => jest.fn());
@@ -68,6 +60,10 @@ describe(`[startup] ${Review.name}`, () => {
         });
     }
 
+    test('allows running from global location', () => {
+        expect(Review.allowRunFromGlobal).toBe(true);
+    });
+
     describe('when not run from workspace root', () => {
         beforeEach(() => vol.fromJSON({}));
 
@@ -77,15 +73,17 @@ describe(`[startup] ${Review.name}`, () => {
     describe('when run from workspace root', () => {
         const rootPackageJSON = { name: 'root', workspaces: ['packages/*'] };
         const packageLockJSON = { packages: {} };
-        const packages: Package[] = [
+        const packages: ProjectPackage[] = [
             {
                 name: 'a',
+                version: '1.0.0',
                 dependencies: { foo: '1.0.1', bar: '1.0.0' },
                 devDependencies: { qux: 'file:.yalc/qux' }, // test ignores non-version dependencies
                 location: 'a',
             },
             {
                 name: 'b',
+                version: '1.0.0',
                 dependencies: { foo: '1.0.0', bar: '1.0.0' },
                 devDependencies: { baz: '1.0.0' },
                 location: 'b',
@@ -152,13 +150,13 @@ describe(`[startup] ${Review.name}`, () => {
         });
 
         describe('with --rule option', () => {
-            beforeEach(() => (args.rule = rules[0].id));
+            beforeEach(() => (args.rule = [rules[0].id]));
 
             test('runs only specified rule', async () => {
                 await subject();
 
                 rules.forEach(rule => {
-                    if (args.rule === rule.id) {
+                    if (args.rule?.includes(rule.id)) {
                         expect(rule.run).toHaveBeenCalled();
                     } else {
                         expect(rule.run).not.toHaveBeenCalled();
@@ -278,9 +276,10 @@ describe(`[startup] ${Review.name}`, () => {
                     test('regenerates lockfile', async () => {
                         await subject();
 
-                        expect(execSync).toHaveBeenCalledWith('npx startup install --fix --quiet', {
-                            stdio: 'inherit',
-                        });
+                        expect(execSync).toHaveBeenCalledWith(
+                            'npx @servicetitan/install --fix --quiet',
+                            { stdio: 'inherit' }
+                        );
                     });
 
                     test('summarizes fixes and remaining problems', async () => {
@@ -452,7 +451,7 @@ describe(`[startup] ${Review.name}`, () => {
 
                         const execStartupInstallWithFixOption = [
                             execSync,
-                            'npx startup install --fix --quiet',
+                            'npx @servicetitan/install --fix --quiet',
                             { stdio: 'inherit' },
                         ];
 
@@ -467,7 +466,7 @@ describe(`[startup] ${Review.name}`, () => {
                     });
 
                     describe('with --rule option', () => {
-                        beforeEach(() => (args.rule = rules[1].id));
+                        beforeEach(() => (args.rule = [rules[1].id]));
 
                         test('fixes only specified rule', async () => {
                             await subject();

package/src/cli/commands/review/review.ts

@@ -9,8 +9,8 @@ import {
     readJsonSafe,
     toArray,
 } from '../../../utils';
-import { Command, CommandArgs } from '../types';
-
+import { Command, CommandOptions } from '../types';
+import { rules } from './rules';
 import {
     ErrorSeverity,
     FixCategory,
@@ -29,21 +29,18 @@ import {
     pluralize,
     summarize,
 } from './utils';
-import { rules } from './rules';
 
 const collator = new Intl.Collator();
 
-interface Args extends CommandArgs {
-    fix?: boolean;
-    rule?: string | string[];
-}
+const options = {
+    fix: { boolean: true, description: 'Fix detected problems' },
+    rule: { array: true, string: true, description: 'Limit checks to specified rule(s)' },
+} satisfies CommandOptions;
 
-export class Review extends Command<Args> {
+export class Review extends Command<typeof options> {
+    static readonly allowRunFromGlobal = true;
     static readonly description = 'Check project for configuration errors';
-    static readonly options = {
-        fix: { boolean: true, description: 'Fix detected problems' },
-        rule: { array: true, description: 'Limit checks to specified rule(s)' },
-    };
+    static readonly options = options;
 
     private readonly severityToLabel: Record<ErrorSeverity, string> = {
         [ErrorSeverity.warning]: chalk.yellow('warning'),
@@ -121,7 +118,7 @@ export class Review extends Command<Args> {
                 }
             });
 
-            execSync('npx startup install --fix --quiet', { stdio: 'inherit' });
+            execSync('npx @servicetitan/install --fix --quiet', { stdio: 'inherit' });
             project = this.createProject();
             errors = this.findErrors(project);
         }
@@ -225,13 +222,7 @@ export class Review extends Command<Args> {
 
     private getSelectedRules() {
         const rule = this.args.rule;
-        if (typeof rule === 'string' && rule) {
-            return new Set([rule]);
-        }
-        if (Array.isArray(rule)) {
-            return new Set(rule.filter(id => !!id));
-        }
-        return undefined;
+        return rule ? new Set(rule.filter(id => !!id)) : undefined;
     }
 }
 

package/src/cli/commands/review/rules/__tests__/no-deprecated-content-base.test.ts

@@ -1,5 +1,6 @@
 import { execSync } from 'child_process';
 import path from 'path';
+import { expectCalls } from '../../__mocks__';
 import {
     ErrorSeverity,
     FixCategory,
@@ -7,7 +8,6 @@ import {
     PackageError,
     ReviewConfiguration,
 } from '../../types';
-import { expectCalls } from '../../__mocks__';
 import { mockConfig, mockProject } from '../__mocks__';
 import { NoDeprecatedContentBase } from '../no-deprecated-content-base';
 

package/src/cli/commands/review/rules/__tests__/no-deprecated-startup-install.test.ts

@@ -1,7 +1,6 @@
 import { execSync } from 'child_process';
 import { FixCategory, Package, PackageError, ReviewConfiguration } from '../../types';
 import { mockProject } from '../__mocks__';
-
 import { NoDeprecatedStartupInstall } from '../no-deprecated-startup-install';
 
 jest.mock('child_process', () => ({ execSync: jest.fn() }));

package/src/cli/commands/review/rules/__tests__/no-direct-peer-dependencies.test.ts

@@ -1,7 +1,7 @@
 import { execSync } from 'child_process';
 import path from 'path';
-import { FixCategory, Package, PackageError, ReviewConfiguration } from '../../types';
 import { expectCalls } from '../../__mocks__';
+import { FixCategory, Package, PackageError, ReviewConfiguration } from '../../types';
 import { mockConfig, mockProject } from '../__mocks__';
 import { NoDirectPeerDependencies } from '../no-direct-peer-dependencies';
 

package/src/cli/commands/review/rules/__tests__/no-typescript-entry-point.test.ts

@@ -3,7 +3,6 @@ import path from 'path';
 import { getFolders } from '../../../../../utils';
 import { FixCategory, Package, ReviewConfiguration } from '../../types';
 import { mockConfig, mockProject } from '../__mocks__';
-
 import { NoTypescriptEntryPoint } from '../no-typescript-entry-point';
 
 jest.mock('child_process', () => ({ execSync: jest.fn() }));

package/src/cli/commands/review/rules/__tests__/require-all-react-dependencies.test.ts

@@ -1,7 +1,6 @@
 import { FixCategory, Project, ReviewConfiguration } from '../../types';
 import { setVersion } from '../../utils';
 import { mockConfig, mockPackages, mockProject } from '../__mocks__';
-
 import { RequireAllReactDependencies } from '../require-all-react-dependencies';
 
 jest.mock('../../utils', () => ({

package/src/cli/commands/review/rules/__tests__/require-compatible-launch-darkly-sdk.test.ts

@@ -1,8 +1,8 @@
 import chalk from 'chalk';
 import { execSync } from 'child_process';
+import { expectCalls } from '../../__mocks__';
 import { FixCategory, Package, PackageError, Project, ReviewConfiguration } from '../../types';
 import { setVersion } from '../../utils';
-import { expectCalls } from '../../__mocks__';
 import { mockConfig, mockPackages, mockProject } from '../__mocks__';
 import { RequireCompatibleLaunchDarklySdk } from '../require-compatible-launch-darkly-sdk';
 
@@ -241,7 +241,7 @@ describe(`[startup] Review ${RequireCompatibleLaunchDarklySdk.name}`, () => {
             expectCalls(
                 ...[
                     `npm pkg set dependencies["${JS_CLIENT_SDK}"]=${sdkVersions.ldService}`,
-                    'npx startup install --fix --quiet',
+                    'npx @servicetitan/install --fix --quiet',
                     `npm pkg delete dependencies["${JS_CLIENT_SDK}"]`,
                 ].map(command => [execSync, command, { stdio: 'inherit' }])
             );

package/src/cli/commands/review/rules/__tests__/require-explicit-side-effects.test.ts

@@ -1,6 +1,5 @@
 import { ErrorSeverity, Package, ReviewConfiguration } from '../../types';
 import { mockConfig, mockProject } from '../__mocks__';
-
 import { RequireExplicitSideEffects } from '../require-explicit-side-effects';
 
 describe(`[startup] Review ${RequireExplicitSideEffects.name}`, () => {

package/src/cli/commands/review/rules/__tests__/require-npmrc.test.ts

@@ -1,6 +1,5 @@
 import { execSync } from 'child_process';
 import { ErrorSeverity, FixCategory } from '../../types';
-
 import { RequireNpmrc } from '../require-npmrc';
 
 jest.mock('child_process', () => ({ execSync: jest.fn() }));

package/src/cli/commands/review/rules/__tests__/require-one-anvil-uikit-contrib-version.test.ts

@@ -1,6 +1,5 @@
-import { RequireOneCollectionVersion } from '../require-one-collection-version';
-
 import { RequireOneAnvilUikitContribVersion } from '../require-one-anvil-uikit-contrib-version';
+import { RequireOneCollectionVersion } from '../require-one-collection-version';
 
 jest.mock('../require-one-collection-version');
 

package/src/cli/commands/review/rules/__tests__/require-one-collection-version.test.ts

@@ -3,7 +3,6 @@ import path from 'path';
 import { FixCategory, Project, ReviewConfiguration } from '../../types';
 import { setVersion } from '../../utils';
 import { mockConfig, mockPackages, mockProject } from '../__mocks__';
-
 import { RequireOneCollectionVersion } from '../require-one-collection-version';
 
 jest.mock('../../utils', () => ({

package/src/cli/commands/review/rules/__tests__/require-one-package-version.test.ts

@@ -3,7 +3,6 @@ import path from 'path';
 import { FixCategory, Project, ReviewConfiguration } from '../../types';
 import { setVersion } from '../../utils';
 import { mockConfig, mockPackages, mockProject } from '../__mocks__';
-
 import { RequireOnePackageVersion } from '../require-one-package-version';
 
 jest.mock('../../utils', () => ({

package/src/cli/commands/review/rules/__tests__/require-one-react-version.test.ts

@@ -1,5 +1,4 @@
 import { RequireOneCollectionVersion } from '../require-one-collection-version';
-
 import { RequireOneReactVersion } from '../require-one-react-version';
 
 jest.mock('../require-one-collection-version');

package/src/cli/commands/review/rules/__tests__/require-one-uikit-version.test.ts

@@ -1,5 +1,4 @@
 import { RequireOneCollectionVersion } from '../require-one-collection-version';
-
 import { RequireOneUikitVersion } from '../require-one-uikit-version';
 
 jest.mock('../require-one-collection-version');
@@ -21,6 +20,7 @@ describe(`[startup] Review ${RequireOneUikitVersion.name}`, () => {
         '@servicetitan/react-ioc',
         '@servicetitan/restrict-imports',
         '@servicetitan/startup',
+        '@servicetitan/startup-utils',
         '@servicetitan/stylelint-config',
         '@servicetitan/suppress-warnings',
         '@servicetitan/web-components',

package/src/cli/commands/review/rules/__tests__/require-project-version-in-root-node-modules.test.ts

@@ -3,7 +3,6 @@ import { execSync } from 'child_process';
 import { expectCalls } from '../../__mocks__';
 import { FixCategory, Package, Project, ReviewConfiguration } from '../../types';
 import { mockConfig, mockPackages, mockProject } from '../__mocks__';
-
 import { RequireProjectVersionInRootNodeModules } from '../require-project-version-in-root-node-modules';
 
 jest.mock('child_process', () => ({ execSync: jest.fn() }));
@@ -88,7 +87,7 @@ describe(`[startup] Review ${RequireProjectVersionInRootNodeModules.name}`, () =
             expectCalls(
                 ...[
                     'npm pkg set dependencies["foo"]="~1.0.0"',
-                    'npx startup install --fix --quiet',
+                    'npx @servicetitan/install --fix --quiet',
                     'npm pkg delete dependencies["foo"]',
                 ].map(command => [execSync, command, { stdio: 'inherit' }])
             );
@@ -176,7 +175,7 @@ describe(`[startup] Review ${RequireProjectVersionInRootNodeModules.name}`, () =
                 ...[
                     'npm pkg set dependencies["foo"]="~1.0.0"',
                     'npm pkg set dependencies["baz"]=">=3 <4"',
-                    'npx startup install --fix --quiet',
+                    'npx @servicetitan/install --fix --quiet',
                     'npm pkg delete dependencies["foo"]',
                     'npm pkg delete dependencies["baz"]',
                 ].map(command => [execSync, command, { stdio: 'inherit' }])

package/src/cli/commands/review/rules/__tests__/require-servicetitan-scope.test.ts

@@ -1,6 +1,5 @@
 import { ErrorSeverity, Package, ReviewConfiguration } from '../../types';
 import { mockConfig, mockProject } from '../__mocks__';
-
 import { RequireServiceTitanScope } from '../require-servicetitan-scope';
 
 describe(`[startup] Review ${RequireServiceTitanScope.name}`, () => {

package/src/cli/commands/review/rules/__tests__/require-tsconfig-references.test.ts

@@ -0,0 +1,193 @@
+import { fs, vol } from 'memfs';
+import path from 'node:path';
+import { createPackage } from '../../../../../__mocks__';
+import { prettifySync } from '../../../../../utils';
+import { Package } from '../../types';
+import { mockProject } from '../__mocks__';
+import { RequireTsconfigReferences } from '../require-tsconfig-references';
+
+jest.mock('node:fs', () => fs);
+jest.mock('node:child_process', () => ({
+    execSync: jest.fn(),
+}));
+jest.mock('../../../../../utils', () => ({
+    ...jest.requireActual('../../../../../utils'),
+    prettifySync: jest.fn(),
+}));
+
+describe(`[startup] Review ${RequireTsconfigReferences.name}`, () => {
+    let rule: RequireTsconfigReferences;
+    let packages: Package[];
+
+    beforeEach(() => {
+        rule = new RequireTsconfigReferences();
+        packages = [
+            // Note, tests assume the "app" that depends on local package(s) is first
+            createPackage({ name: 'app', dependencies: { utils: '1.0.0' } }),
+            createPackage({ name: 'utils' }),
+        ];
+    });
+
+    afterEach(() => vol.reset());
+
+    const subject = () => rule.run(mockProject({ packages }));
+
+    function appTsConfig() {
+        return path.join(packages[0].location, 'tsconfig.json');
+    }
+
+    function volFromJSON(json: Record<string, any>) {
+        vol.fromJSON(
+            Object.fromEntries(
+                Object.entries(json).map(([filePath, content]) => [
+                    filePath,
+                    JSON.stringify(content),
+                ])
+            )
+        );
+    }
+
+    function itReportsNoErrors() {
+        test('reports no errors', () => {
+            expect(subject()).toEqual([]);
+        });
+    }
+
+    describe('when package has correct tsconfig reference', () => {
+        beforeEach(() => {
+            volFromJSON({
+                [appTsConfig()]: { references: [{ path: '../utils/tsconfig.json' }] },
+            });
+        });
+
+        itReportsNoErrors();
+    });
+
+    describe('when reference is build config', () => {
+        beforeEach(() => {
+            volFromJSON({
+                [appTsConfig()]: { references: [{ path: '../utils/tsconfig.build.json ' }] },
+            });
+        });
+
+        itReportsNoErrors();
+    });
+
+    describe('when reference omits .json extension', () => {
+        beforeEach(() => {
+            volFromJSON({
+                [appTsConfig()]: { references: [{ path: '../utils/tsconfig' }] },
+            });
+        });
+
+        itReportsNoErrors();
+    });
+
+    describe('when reference is directory', () => {
+        beforeEach(() => {
+            volFromJSON({
+                [appTsConfig()]: { references: [{ path: '../utils' }] },
+                'packages/utils/tsconfig.json': {}, // ensures directory exists
+            });
+        });
+
+        itReportsNoErrors();
+    });
+
+    describe('when package is missing reference', () => {
+        beforeEach(() => {
+            volFromJSON({ [appTsConfig()]: {} });
+        });
+
+        function itReportsError() {
+            test('reports error', () => {
+                expect(subject()).toEqual([
+                    expect.objectContaining({
+                        id: 'require-tsconfig-references',
+                        message: 'missing reference for dependency: utils',
+                        location: appTsConfig(),
+                        fixable: 'normal',
+                    }),
+                ]);
+            });
+        }
+
+        itReportsError();
+
+        describe.each(['devDependencies', 'peerDependencies'])(
+            'when dependency is in %s',
+            (key: keyof Package) => {
+                beforeEach(() => {
+                    const appPackage = packages[0];
+                    appPackage[key] = appPackage.dependencies;
+                    delete appPackage.dependencies;
+                });
+
+                itReportsError();
+            }
+        );
+
+        describe('when package is workspace root', () => {
+            beforeEach(() => (packages[0].location = '.'));
+
+            itReportsNoErrors();
+        });
+
+        describe('fix', () => {
+            const fixSubject = () => {
+                const ruleErrors = subject();
+                ruleErrors.forEach(rule.fix);
+            };
+
+            function expectReferences(references: Record<string, string>[]) {
+                const json = fs.readFileSync(appTsConfig(), { encoding: 'utf-8' }).toString();
+                expect(JSON.parse(json)).toEqual({ references });
+            }
+
+            test('fixes error', () => {
+                fixSubject();
+
+                expectReferences([{ path: '../utils' }]);
+            });
+
+            test('prettifies output', () => {
+                fixSubject();
+
+                expect(prettifySync).toHaveBeenCalledWith(appTsConfig());
+            });
+
+            describe('when reference is build config', () => {
+                beforeEach(() => {
+                    volFromJSON({
+                        [appTsConfig()]: {},
+                        'packages/utils/tsconfig.build.json': {},
+                    });
+                });
+
+                test('references build config', () => {
+                    fixSubject();
+
+                    expectReferences([{ path: '../utils/tsconfig.build.json' }]);
+                });
+            });
+
+            describe('when package has other references', () => {
+                const references = [{ path: '../foo' }];
+
+                beforeEach(() => {
+                    volFromJSON({ [appTsConfig()]: { references } });
+                });
+
+                test('preserves other references', () => {
+                    fixSubject();
+
+                    expectReferences([...references, { path: '../utils' }]);
+                });
+            });
+
+            test('ignores invalid data', () => {
+                expect(() => rule.fix({} as any)).not.toThrow();
+            });
+        });
+    });
+});

package/src/cli/commands/review/rules/index.ts

@@ -14,6 +14,7 @@ import { RequireOneReactVersion } from './require-one-react-version';
 import { RequireOneUikitVersion } from './require-one-uikit-version';
 import { RequireProjectVersionInRootNodeModules } from './require-project-version-in-root-node-modules';
 import { RequireServiceTitanScope } from './require-servicetitan-scope';
+import { RequireTsconfigReferences } from './require-tsconfig-references';
 
 export const rules: PackageRule[] = [
     new RequireAllReactDependencies(),
@@ -31,4 +32,5 @@ export const rules: PackageRule[] = [
     new RequireServiceTitanScope(),
     new RequireExplicitSideEffects(),
     new RequireNpmrc(),
+    new RequireTsconfigReferences(),
 ];

package/src/cli/commands/review/rules/require-compatible-launch-darkly-sdk.ts

@@ -56,7 +56,7 @@ export class RequireCompatibleLaunchDarklySdk implements PackageRule {
 
         [
             `npm pkg set dependencies["${JS_CLIENT_SDK}"]=${targetVersion}`,
-            'npx startup install --fix --quiet',
+            'npx @servicetitan/install --fix --quiet',
             `npm pkg delete dependencies["${JS_CLIENT_SDK}"]`,
         ].forEach(command => execSync(command, { stdio: 'inherit' }));
     }

package/src/cli/commands/review/rules/require-one-uikit-version.ts

@@ -16,6 +16,7 @@ const UIKIT_PACKAGES = [
     '@servicetitan/react-ioc',
     '@servicetitan/restrict-imports',
     '@servicetitan/startup',
+    '@servicetitan/startup-utils',
     '@servicetitan/stylelint-config',
     '@servicetitan/suppress-warnings',
     '@servicetitan/web-components',

package/src/cli/commands/review/rules/require-project-version-in-root-node-modules.ts

@@ -1,9 +1,9 @@
 import chalk from 'chalk';
+import { execSync } from 'child_process';
 import { satisfies } from 'semver';
+import { log } from '../../../../utils';
 import { FixCategory, PackageError, PackageRule, Project } from '../types';
 import { applyFilter, getKey, getMaxVersion } from '../utils';
-import { execSync } from 'child_process';
-import { log } from '../../../../utils';
 
 interface Mismatch {
     name: string;
@@ -67,7 +67,7 @@ export class RequireProjectVersionInRootNodeModules implements PackageRule {
 
         [
             ...entries.map(([name, version]) => `npm pkg set dependencies["${name}"]="${version}"`),
-            'npx startup install --fix --quiet',
+            'npx @servicetitan/install --fix --quiet',
             ...entries.map(([name]) => `npm pkg delete dependencies["${name}"]`),
         ].forEach(command => execSync(command, { stdio: 'inherit' }));
     }