@elliemae/pui-cli 9.0.0-next.64 → 9.0.0-next.65

package/dist/cjs/commands/test.js

@@ -72,7 +72,36 @@ const cmdArgs = {
   maxWorkers: {
     string: true,
     default: "50%"
+  },
+  // example usage: pui-cli test --filterFnFilePath=./myFilter.js
+  //                               /\ this exports a filtering function as per documentation
+  //                               the filtering will be applied to the test that were already matched by the config file
+  filterFnFilePath: {
+    alias: "fffp",
+    string: true,
+    description: `Path to a module exporting a filtering function.
+  This asynchronous function receives a list of test paths which can be manipulated to exclude tests from running and must
+  return an object with shape { filtered: Array<string> } containing the tests that should be run by Jest. https://jestjs.io/docs/cli#--filterfile`
+  },
+  // ********************************************************************************************************
+  // The official website documentation says "testPathPatterns" as "plural",
+  //   but the actual CLI working flag is    "testPathPattern"  as "singular"
+  // ********************************************************************************************************
+  // example usage: pui-cli test --testPathPattern=button
+  //                               /\ this will run against all test that regExp match the button string
+  //                               which funny enough means it will run all tests that have the word "button" in their path
+  //                               (e.g. "src/components/button/button.test.js")
+  testPathPattern: {
+    alias: "tpp",
+    string: true,
+    description: "A regexp pattern string that is matched against all tests paths before executing the test, https://jestjs.io/docs/cli#--testpathpatternsregex"
   }
+  /* the above two methods are compatible with the config file
+  testGlobs won't work because
+  ● Validation Error:
+    Configuration options testMatch and testRegex cannot be used together.
+    Configuration Documentation: https://jestjs.io/docs/configuration
+  */
 };
 const getJestFlags = (argv) => {
   const flagsArray = [
@@ -97,6 +126,10 @@ const getJestFlags = (argv) => {
   if (argv.passWithNoTests) flagsArray.push("--passWithNoTests");
   if (argv.findReleatedTests) flagsArray.push("--bail --findRelatedTests");
   if (argv.silent) flagsArray.push("--silent");
+  if (argv.filterFnFilePath)
+    flagsArray.push(`--filter=${argv.filterFnFilePath}`);
+  if (argv.testPathPattern)
+    flagsArray.push(`--testPathPattern=${argv.testPathPattern}`);
   if (isCi) flagsArray.push("--ci --no-colors");
   return flagsArray.join(" ");
 };
@@ -109,7 +142,7 @@ const debugTest = async () => {
     `node --inspect-brk ./node_modules/jest-cli/bin/jest.js --runInBand --watch`
   );
 };
-const testCmd = {
+const typedTestCmd = {
   handler: async (argv) => {
     try {
       if ((0, import_utils.getCIEnv)()) {
@@ -129,4 +162,9 @@ const testCmd = {
   command: "test [options]",
   describe: "unit tests application code",
   builder: (yargsRef) => yargsRef.options(cmdArgs).help()
+  // the way yargs types are defined this fails if we don't cast it explicitly
+  // this cast is safe, we are not overriding the builder
+  // just telling typescript that our implementation is compatible with the yargs type system
+  // still leveraging the yargs types checks
 };
+const testCmd = typedTestCmd;

package/dist/cjs/testing/jest.config.cjs

@@ -83,7 +83,7 @@ const jestConfig = {
     '^.+\\.[jt]sx?$': ['@swc/jest', swcrcConfig],
   },
   transformIgnorePatterns: [
-    // eslint-disable-next-line prettier/prettier, no-useless-escape
+    // eslint-disable-next-line no-useless-escape
     '/node_modules/(?!(\@elliemae\/pui-cli|lodash-es|react-select|react-dates|d3|internmap|delaunator|robust-predicates))/',
   ],
   globals: {

package/dist/esm/commands/test.js

@@ -1,5 +1,5 @@
 import yargs from "yargs";
-import { exec, logError, logSuccess, getCIEnv } from "./utils.js";
+import { exec, getCIEnv, logError, logSuccess } from "./utils.js";
 const cmdArgs = {
   fix: {
     boolean: true,
@@ -39,7 +39,36 @@ const cmdArgs = {
   maxWorkers: {
     string: true,
     default: "50%"
+  },
+  // example usage: pui-cli test --filterFnFilePath=./myFilter.js
+  //                               /\ this exports a filtering function as per documentation
+  //                               the filtering will be applied to the test that were already matched by the config file
+  filterFnFilePath: {
+    alias: "fffp",
+    string: true,
+    description: `Path to a module exporting a filtering function.
+  This asynchronous function receives a list of test paths which can be manipulated to exclude tests from running and must
+  return an object with shape { filtered: Array<string> } containing the tests that should be run by Jest. https://jestjs.io/docs/cli#--filterfile`
+  },
+  // ********************************************************************************************************
+  // The official website documentation says "testPathPatterns" as "plural",
+  //   but the actual CLI working flag is    "testPathPattern"  as "singular"
+  // ********************************************************************************************************
+  // example usage: pui-cli test --testPathPattern=button
+  //                               /\ this will run against all test that regExp match the button string
+  //                               which funny enough means it will run all tests that have the word "button" in their path
+  //                               (e.g. "src/components/button/button.test.js")
+  testPathPattern: {
+    alias: "tpp",
+    string: true,
+    description: "A regexp pattern string that is matched against all tests paths before executing the test, https://jestjs.io/docs/cli#--testpathpatternsregex"
   }
+  /* the above two methods are compatible with the config file
+  testGlobs won't work because
+  ● Validation Error:
+    Configuration options testMatch and testRegex cannot be used together.
+    Configuration Documentation: https://jestjs.io/docs/configuration
+  */
 };
 const getJestFlags = (argv) => {
   const flagsArray = [
@@ -64,6 +93,10 @@ const getJestFlags = (argv) => {
   if (argv.passWithNoTests) flagsArray.push("--passWithNoTests");
   if (argv.findReleatedTests) flagsArray.push("--bail --findRelatedTests");
   if (argv.silent) flagsArray.push("--silent");
+  if (argv.filterFnFilePath)
+    flagsArray.push(`--filter=${argv.filterFnFilePath}`);
+  if (argv.testPathPattern)
+    flagsArray.push(`--testPathPattern=${argv.testPathPattern}`);
   if (isCi) flagsArray.push("--ci --no-colors");
   return flagsArray.join(" ");
 };
@@ -76,7 +109,7 @@ const debugTest = async () => {
     `node --inspect-brk ./node_modules/jest-cli/bin/jest.js --runInBand --watch`
   );
 };
-const testCmd = {
+const typedTestCmd = {
   handler: async (argv) => {
     try {
       if (getCIEnv()) {
@@ -96,7 +129,12 @@ const testCmd = {
   command: "test [options]",
   describe: "unit tests application code",
   builder: (yargsRef) => yargsRef.options(cmdArgs).help()
+  // the way yargs types are defined this fails if we don't cast it explicitly
+  // this cast is safe, we are not overriding the builder
+  // just telling typescript that our implementation is compatible with the yargs type system
+  // still leveraging the yargs types checks
 };
+const testCmd = typedTestCmd;
 export {
   testCmd
 };

package/dist/esm/testing/jest.config.cjs

@@ -83,7 +83,7 @@ const jestConfig = {
     '^.+\\.[jt]sx?$': ['@swc/jest', swcrcConfig],
   },
   transformIgnorePatterns: [
-    // eslint-disable-next-line prettier/prettier, no-useless-escape
+    // eslint-disable-next-line no-useless-escape
     '/node_modules/(?!(\@elliemae\/pui-cli|lodash-es|react-select|react-dates|d3|internmap|delaunator|robust-predicates))/',
   ],
   globals: {

package/dist/types/lib/commands/test.d.ts

@@ -1,14 +1,3 @@
-import { CommandModule } from 'yargs';
-interface Arguments {
-    fix: boolean;
-    watch: boolean;
-    debug: boolean;
-    passWithNoTests: boolean;
-    findReleatedTests: boolean;
-    silent: boolean;
-    coverage: string;
-    maxWorkers: string;
-}
-export declare const testCmd: CommandModule<Record<string, never>, Arguments>;
-export {};
+import type { CommandModule } from 'yargs';
+export declare const testCmd: CommandModule;
 //# sourceMappingURL=test.d.ts.map

package/dist/types/lib/commands/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../../../lib/commands/test.ts"],"names":[],"mappings":"AACA,OAAc,EAAQ,aAAa,EAAE,MAAM,OAAO,CAAC;AAEnD,UAAU,SAAS;IACjB,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,eAAe,EAAE,OAAO,CAAC;IACzB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AA6FD,eAAO,MAAM,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAoBnE,CAAC"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../../../lib/commands/test.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAIV,aAAa,EAEd,MAAM,OAAO,CAAC;AA4Kf,eAAO,MAAM,OAAO,EAAmB,aAAa,CAAC"}