@servicetitan/startup 28.3.0 → 28.3.1

package/dist/cli/utils/tcm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tcm.d.ts","sourceRoot":"","sources":["../../../src/cli/utils/tcm.ts"],"names":[],"mappings":"AA0DA,wBAAsB,GAAG,kBAIxB;AAED,wBAAsB,QAAQ,kBAE7B"}
+{"version":3,"file":"tcm.d.ts","sourceRoot":"","sources":["../../../src/cli/utils/tcm.ts"],"names":[],"mappings":"AAmEA,wBAAsB,GAAG,kBAIxB;AAED,wBAAsB,QAAQ,kBAE7B"}

package/dist/cli/utils/tcm.js

@@ -19,8 +19,8 @@ async function compile(filePath) {
     }
 }
 async function run({ watch } = {}) {
-    const { source } = (0, utils_1.getFolders)();
-    const filesPattern = `${source}/**/*.module.{${_1.styleExtensions.join()}}`.replace(/\\/g, '/');
+    const source = (0, utils_1.getFolders)().source.replace(/\\/g, '/');
+    const filesPattern = `${source}/**/*.module.{${_1.styleExtensions.join()}}`;
     const creator = new typed_css_modules_1.default({
         camelCase: true,
         namedExports: true,
@@ -38,15 +38,23 @@ async function run({ watch } = {}) {
     if (!watch) {
         const files = await (0, glob_1.glob)(filesPattern);
         await Promise.all(files.map(writeFile));
+        return;
     }
-    else {
-        utils_1.log.info('Watch ' + filesPattern + '...');
-        const watcher = chokidar_1.default.watch([filesPattern], { ignoreInitial: true });
-        watcher.on('add', writeFile);
-        watcher.on('change', writeFile);
-        if (process.env.NODE_ENV !== 'test') {
-            await new Promise(() => { });
-        }
+    utils_1.log.info('Watch ' + filesPattern + '...');
+    const stylesRegex = new RegExp(`\\.module\\.(${_1.styleExtensions.join('|')})$`);
+    const watcher = chokidar_1.default.watch(source, {
+        ignored: (path, stats) => !!(stats === null || stats === void 0 ? void 0 : stats.isFile()) && !stylesRegex.test(path),
+        ignoreInitial: true,
+    });
+    const callback = async (path) => {
+        utils_1.log.debug('tcm', `Compiling ${path}`);
+        await writeFile(path);
+    };
+    watcher.on('add', callback);
+    watcher.on('change', callback);
+    /* istanbul ignore next: not executed in test environment */
+    if (process.env.NODE_ENV !== 'test') {
+        await new Promise(() => { });
     }
 }
 async function tcm() {

package/dist/cli/utils/tcm.js.map

@@ -1 +1 @@
-{"version":3,"file":"tcm.js","sourceRoot":"","sources":["../../../src/cli/utils/tcm.ts"],"names":[],"mappings":";;;;;AA0DA,kBAIC;AAED,4BAEC;AAlED,+BAA4B;AAC5B,wDAAgC;AAEhC,0EAA2C;AAE3C,uCAA8C;AAC9C,wBAA8D;AAM9D,KAAK,UAAU,OAAO,CAAC,QAAgB;IACnC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,cAAW,EAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,cAAW,EAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAAC,EAAE,KAAK,KAAiB,EAAE;IACzC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,kBAAU,GAAE,CAAC;IAEhC,MAAM,YAAY,GAAG,GAAG,MAAM,iBAAiB,kBAAe,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE7F,MAAM,OAAO,GAAG,IAAI,2BAAU,CAAC;QAC3B,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,IAAI;KACrB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,EAAE,QAAgB,EAAE,EAAE;QACzC,IAAI,CAAC;YACD,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,WAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC,CAAC;IAEF,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,KAAK,GAAG,MAAM,IAAA,WAAI,EAAC,YAAY,CAAC,CAAC;QAEvC,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5C,CAAC;SAAM,CAAC;QACJ,WAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,YAAY,GAAG,KAAK,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAEhC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAClC,MAAM,IAAI,OAAO,CAAO,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,GAAG;IACrB,WAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;IAExE,MAAM,GAAG,EAAE,CAAC;AAChB,CAAC;AAEM,KAAK,UAAU,QAAQ;IAC1B,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC"}
+{"version":3,"file":"tcm.js","sourceRoot":"","sources":["../../../src/cli/utils/tcm.ts"],"names":[],"mappings":";;;;;AAmEA,kBAIC;AAED,4BAEC;AA3ED,+BAA4B;AAC5B,wDAAgC;AAEhC,0EAA2C;AAE3C,uCAA8C;AAC9C,wBAA8D;AAM9D,KAAK,UAAU,OAAO,CAAC,QAAgB;IACnC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,cAAW,EAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,cAAW,EAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAAC,EAAE,KAAK,KAAiB,EAAE;IACzC,MAAM,MAAM,GAAG,IAAA,kBAAU,GAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvD,MAAM,YAAY,GAAG,GAAG,MAAM,iBAAiB,kBAAe,CAAC,IAAI,EAAE,GAAG,CAAC;IAEzE,MAAM,OAAO,GAAG,IAAI,2BAAU,CAAC;QAC3B,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,IAAI;KACrB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,EAAE,QAAgB,EAAE,EAAE;QACzC,IAAI,CAAC;YACD,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,WAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC,CAAC;IAEF,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,KAAK,GAAG,MAAM,IAAA,WAAI,EAAC,YAAY,CAAC,CAAC;QACvC,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;QACxC,OAAO;IACX,CAAC;IAED,WAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,YAAY,GAAG,KAAK,CAAC,CAAC;IAE1C,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,gBAAgB,kBAAe,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;QACnC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,EAAE,CAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;QACtE,aAAa,EAAE,IAAI;KACtB,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;QACpC,WAAG,CAAC,KAAK,CAAC,KAAK,EAAE,aAAa,IAAI,EAAE,CAAC,CAAC;QACtC,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAE/B,4DAA4D;IAC5D,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;QAClC,MAAM,IAAI,OAAO,CAAO,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACtC,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,GAAG;IACrB,WAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;IAExE,MAAM,GAAG,EAAE,CAAC;AAChB,CAAC;AAEM,KAAK,UAAU,QAAQ;IAC1B,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/startup",
-    "version": "28.3.0",
+    "version": "28.3.1",
     "description": "",
     "homepage": "https://docs.st.dev/docs/frontend/startup",
     "repository": {
@@ -32,14 +32,14 @@
         "@jest/core": "~29.7.0",
         "@jest/types": "~29.6.3",
         "@jsdevtools/coverage-istanbul-loader": "^3.0.5",
-        "@servicetitan/eslint-config": "28.3.0",
-        "@servicetitan/stylelint-config": "28.3.0",
+        "@servicetitan/eslint-config": "28.3.1",
+        "@servicetitan/stylelint-config": "28.3.1",
         "@svgr/webpack": "^8.1.0",
         "@swc/core": "1.10.1",
         "@types/debug": "^4.1.12",
         "@types/jest": "~29.5.12",
         "chalk": "~4.1.2",
-        "chokidar": "~3.6.0",
+        "chokidar": "~4.0.3",
         "cpx2": "7.0.1",
         "css-loader": "~7.1.2",
         "css-minimizer-webpack-plugin": "^7.0.0",
@@ -61,7 +61,7 @@
         "less-loader": "~12.2.0",
         "less-plugin-npm-import": "~2.1.0",
         "lodash.memoize": "^4.1.2",
-        "memfs": "~4.15.0",
+        "memfs": "~4.15.1",
         "mini-css-extract-plugin": "~2.9.2",
         "moment": "^2.30.1",
         "moment-locales-webpack-plugin": "~1.2.0",
@@ -104,5 +104,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "63ce3ca18966fc5522a3b61df5e4c55f82b4272e"
+    "gitHead": "475386c1ac1891c3e585a2ce694472ad3a1353e8"
 }

package/src/cli/utils/__tests__/tcm.test.ts

@@ -2,7 +2,7 @@
  * @jest-environment node
  */
 import chokidar from 'chokidar';
-import fs from 'fs';
+import fs, { Stats } from 'fs';
 
 import { getFolders, log } from '../../../utils';
 import * as sassModule from '../compile-sass';
@@ -13,7 +13,7 @@ import { tcm, tcmWatch } from '../tcm';
 jest.mock('../../../utils', () => ({
     ...jest.requireActual('../../../utils'),
     getFolders: jest.fn(),
-    log: { error: jest.fn(), info: jest.fn() }, // suppress test output
+    log: { debug: jest.fn(), error: jest.fn(), info: jest.fn() }, // suppress test output
 }));
 
 /**
@@ -80,10 +80,6 @@ describe('[startup] Cli Utils', () => {
         let watchSpy: jest.SpyInstance;
         let fsWatcher: Partial<ReturnType<typeof chokidar.watch>>;
 
-        beforeAll(() => {
-            process.env.NODE_ENV ??= 'test'; // workaround issue with Jest not setting NODE_ENV=test
-        });
-
         beforeEach(() => {
             fsWatcher = { on: jest.fn() };
             watchSpy = jest.spyOn(chokidar, 'watch').mockReturnValue(fsWatcher as any);
@@ -95,10 +91,10 @@ describe('[startup] Cli Utils', () => {
         test('watches for new and changed style modules', async () => {
             await subject();
 
-            expect(watchSpy).toHaveBeenCalledWith(
-                [`${source}/**/*.module.{${styleExtensions.join()}}`],
-                { ignoreInitial: true }
-            );
+            expect(watchSpy).toHaveBeenCalledWith(source, {
+                ignored: expect.any(Function),
+                ignoreInitial: true,
+            });
             expect(fsWatcher.on).toHaveBeenCalledWith('add', expect.any(Function));
             expect(fsWatcher.on).toHaveBeenCalledWith('change', expect.any(Function));
         });
@@ -108,6 +104,56 @@ describe('[startup] Cli Utils', () => {
             return calls.find(([event]) => event === name)![1] as Listener;
         }
 
+        describe('"ignored" filter', () => {
+            const styleExtensions = ['.module.css', '.module.scss', '.module.less'];
+            let ignored: (path: string, stats?: Partial<Stats>) => boolean;
+            let filePath: string;
+            let stats: Partial<Stats> | undefined;
+
+            beforeEach(async () => {
+                await tcmWatch();
+                const { calls } = watchSpy.mock;
+                ignored = calls[0][1].ignored;
+                stats = { isFile: () => true };
+            });
+
+            const subject = () => ignored(filePath, stats);
+
+            function itReturns(value: boolean) {
+                test(`returns ${value}`, () => expect(subject()).toBe(value));
+            }
+
+            describe.each(styleExtensions)('when path ends with %s', ext => {
+                beforeEach(() => (filePath = `foo${ext}`));
+
+                itReturns(false);
+            });
+
+            describe.each(styleExtensions)('when path contains %s', ext => {
+                beforeEach(() => (filePath = `foo${ext}.d.ts`));
+
+                itReturns(true);
+            });
+
+            describe.each(['', '.scss', '.tsx'])('when path ends with "%s"', ext => {
+                beforeEach(() => (filePath = `foo${ext}`));
+
+                itReturns(true);
+
+                describe('when stats is undefined', () => {
+                    beforeEach(() => (stats = undefined));
+
+                    itReturns(false);
+                });
+
+                describe('when stats.isFile returns false', () => {
+                    beforeEach(() => (stats = { isFile: () => false }));
+
+                    itReturns(false);
+                });
+            });
+        });
+
         describe('when module is added', () => {
             const module = 'bar.module.scss';
 

package/src/cli/utils/tcm.ts

@@ -20,9 +20,8 @@ async function compile(filePath: string) {
 }
 
 async function run({ watch }: RunOptions = {}) {
-    const { source } = getFolders();
-
-    const filesPattern = `${source}/**/*.module.{${styleExtensions.join()}}`.replace(/\\/g, '/');
+    const source = getFolders().source.replace(/\\/g, '/');
+    const filesPattern = `${source}/**/*.module.{${styleExtensions.join()}}`;
 
     const creator = new DtsCreator({
         camelCase: true,
@@ -41,18 +40,28 @@ async function run({ watch }: RunOptions = {}) {
 
     if (!watch) {
         const files = await glob(filesPattern);
-
         await Promise.all(files.map(writeFile));
-    } else {
-        log.info('Watch ' + filesPattern + '...');
+        return;
+    }
 
-        const watcher = chokidar.watch([filesPattern], { ignoreInitial: true });
-        watcher.on('add', writeFile);
-        watcher.on('change', writeFile);
+    log.info('Watch ' + filesPattern + '...');
 
-        if (process.env.NODE_ENV !== 'test') {
-            await new Promise<void>(() => {});
-        }
+    const stylesRegex = new RegExp(`\\.module\\.(${styleExtensions.join('|')})$`);
+    const watcher = chokidar.watch(source, {
+        ignored: (path, stats) => !!stats?.isFile() && !stylesRegex.test(path),
+        ignoreInitial: true,
+    });
+    const callback = async (path: string) => {
+        log.debug('tcm', `Compiling ${path}`);
+        await writeFile(path);
+    };
+
+    watcher.on('add', callback);
+    watcher.on('change', callback);
+
+    /* istanbul ignore next: not executed in test environment */
+    if (process.env.NODE_ENV !== 'test') {
+        await new Promise<void>(() => {});
     }
 }