@nx/cypress 16.0.0-beta.1

package/src/migrations/update-15-5-0/helpers.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BANNED_COMMANDS = exports.isAlreadyCommented = void 0;
+function isAlreadyCommented(node) {
+    return node.getFullText().includes('TODO(@nrwl/cypress)');
+}
+exports.isAlreadyCommented = isAlreadyCommented;
+exports.BANNED_COMMANDS = [
+    'as',
+    'children',
+    'closest',
+    'contains',
+    'debug',
+    'document',
+    'eq',
+    'filter',
+    'find',
+    'first',
+    'focused',
+    'get',
+    'hash',
+    'its',
+    'last',
+    'location',
+    'next',
+    'nextAll',
+    'not',
+    'parent',
+    'parents',
+    'parentsUntil',
+    'prev',
+    'prevUntil',
+    'root',
+    'shadow',
+    'siblings',
+    'title',
+    'url',
+    'window',
+];
+//# sourceMappingURL=helpers.js.map

package/src/migrations/update-15-5-0/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../../../packages/cypress/src/migrations/update-15-5-0/helpers.ts"],"names":[],"mappings":";;;AAEA,SAAgB,kBAAkB,CAAC,IAAU;IAC3C,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;AAC5D,CAAC;AAFD,gDAEC;AAEY,QAAA,eAAe,GAAG;IAC7B,IAAI;IACJ,UAAU;IACV,SAAS;IACT,UAAU;IACV,OAAO;IACP,UAAU;IACV,IAAI;IACJ,QAAQ;IACR,MAAM;IACN,OAAO;IACP,SAAS;IACT,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,UAAU;IACV,MAAM;IACN,SAAS;IACT,KAAK;IACL,QAAQ;IACR,SAAS;IACT,cAAc;IACd,MAAM;IACN,WAAW;IACX,MAAM;IACN,QAAQ;IACR,UAAU;IACV,OAAO;IACP,KAAK;IACL,QAAQ;CACT,CAAC"}

package/src/migrations/update-15-5-0/update-to-cypress-12.d.ts

@@ -0,0 +1,24 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+export declare function updateToCypress12(tree: Tree): GeneratorCallback;
+export declare function turnOffTestIsolation(tree: Tree, configPath: string): void;
+/**
+ * Leave a comment on all apis that have been removed andsuperseded by cy.intercept
+ * stating they these API are now removed and need to update.
+ * cy.route, cy.server, Cypress.Server.defaults
+ **/
+export declare function shouldUseCyIntercept(tree: Tree, filePath: string): void;
+/**
+ * Leave a comment on all apis that have been removed and superseded by cy.session
+ * stating they these API are now removed and need to update.
+ * Cypress.Cookies.defaults & Cypress.Cookies.preserveOnce
+ **/
+export declare function shouldUseCySession(tree: Tree, filePath: string): void;
+/**
+ * leave a comment about nested cy commands in a cy.should callback
+ * */
+export declare function shouldNotUseCyInShouldCB(tree: Tree, filePath: string): void;
+/**
+ * leave a comment on all usages of overriding built-ins that are now banned
+ * */
+export declare function shouldNotOverrideCommands(tree: Tree, filePath: string): void;
+export default updateToCypress12;

package/src/migrations/update-15-5-0/update-to-cypress-12.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldNotOverrideCommands = exports.shouldNotUseCyInShouldCB = exports.shouldUseCySession = exports.shouldUseCyIntercept = exports.turnOffTestIsolation = exports.updateToCypress12 = void 0;
+const devkit_1 = require("@nx/devkit");
+const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+const typescript_1 = require("typescript");
+const cypress_version_1 = require("../../utils/cypress-version");
+const helpers_1 = require("./helpers");
+const JS_TS_FILE_MATCHER = /\.[jt]sx?$/;
+function updateToCypress12(tree) {
+    if ((0, cypress_version_1.installedCypressVersion)() < 11) {
+        return;
+    }
+    const projects = (0, devkit_1.getProjects)(tree);
+    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, projectName, targetName, configName) => {
+        if (!(options.cypressConfig && tree.exists(options.cypressConfig))) {
+            return;
+        }
+        const projectConfig = projects.get(projectName);
+        turnOffTestIsolation(tree, options.cypressConfig);
+        (0, devkit_1.visitNotIgnoredFiles)(tree, projectConfig.root, (filePath) => {
+            if (!JS_TS_FILE_MATCHER.test(filePath)) {
+                return;
+            }
+            shouldUseCyIntercept(tree, filePath);
+            shouldUseCySession(tree, filePath);
+            shouldNotUseCyInShouldCB(tree, filePath);
+            shouldNotOverrideCommands(tree, filePath);
+        });
+    });
+    console.warn((0, devkit_1.stripIndents) `Cypress 12 has lots of breaking changes that might subtly break your tests.
+This migration marked known issues that need to be manually migrated, 
+but there can still be runtime based errors that were not detected.
+Please consult the offical Cypress v12 migration guide for more info on these changes and the next steps.
+https://docs.cypress.io/guides/references/migration-guide
+      `);
+    (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
+        json.devDependencies.cypress = '^12.2.0';
+        return json;
+    });
+    return () => {
+        (0, devkit_1.installPackagesTask)(tree);
+    };
+}
+exports.updateToCypress12 = updateToCypress12;
+function turnOffTestIsolation(tree, configPath) {
+    const config = tree.read(configPath, 'utf-8');
+    const isTestIsolationSet = tsquery_1.tsquery.query(config, 'ExportAssignment ObjectLiteralExpression > PropertyAssignment:has(Identifier[name="testIsolation"])');
+    if (isTestIsolationSet.length > 0) {
+        return;
+    }
+    const testIsolationProperty = `/**
+    * TODO(@nrwl/cypress): In Cypress v12,the testIsolation option is turned on by default. 
+    * This can cause tests to start breaking where not indended.
+    * You should consider enabling this once you verify tests do not depend on each other
+    * More Info: https://docs.cypress.io/guides/references/migration-guide#Test-Isolation
+    **/
+    testIsolation: false,`;
+    const updated = tsquery_1.tsquery.replace(config, 'ExportAssignment ObjectLiteralExpression > PropertyAssignment:has(Identifier[name="e2e"])', (node) => {
+        if ((0, typescript_1.isObjectLiteralExpression)(node.initializer)) {
+            const listOfProperties = node.initializer.properties
+                .map((j) => j.getText())
+                .join(',\n    ');
+            return `e2e: {
+    ${listOfProperties},
+    ${testIsolationProperty}
+ }`;
+        }
+        return `e2e: {
+    ...${node.initializer.getText()},
+    ${testIsolationProperty}
+  }`;
+    });
+    tree.write(configPath, updated);
+}
+exports.turnOffTestIsolation = turnOffTestIsolation;
+/**
+ * Leave a comment on all apis that have been removed andsuperseded by cy.intercept
+ * stating they these API are now removed and need to update.
+ * cy.route, cy.server, Cypress.Server.defaults
+ **/
+function shouldUseCyIntercept(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    const markedRemovedCommands = tsquery_1.tsquery.replace(content, ':matches(PropertyAccessExpression:has(Identifier[name="cy"]):has(Identifier[name="server"], Identifier[name="route"]), PropertyAccessExpression:has(Identifier[name="defaults"]):has(Identifier[name="Cypress"], Identifier[name="Server"]))', (node) => {
+        if ((0, helpers_1.isAlreadyCommented)(node)) {
+            return;
+        }
+        const expression = node.expression.getText().trim();
+        // prevent extra chaining i.e. cy.route().as() will return 2 results
+        // cy.route and cy.route().as
+        // only need the first 1 so skip any extra chaining
+        if (expression === 'cy' || expression === 'Cypress.Server') {
+            return `// TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+${node.getText()}`;
+        }
+    });
+    tree.write(filePath, markedRemovedCommands);
+}
+exports.shouldUseCyIntercept = shouldUseCyIntercept;
+/**
+ * Leave a comment on all apis that have been removed and superseded by cy.session
+ * stating they these API are now removed and need to update.
+ * Cypress.Cookies.defaults & Cypress.Cookies.preserveOnce
+ **/
+function shouldUseCySession(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    const markedRemovedCommands = tsquery_1.tsquery.replace(content, ':matches(PropertyAccessExpression:has(Identifier[name="defaults"]):has(Identifier[name="Cypress"], Identifier[name="Cookies"]), PropertyAccessExpression:has(Identifier[name="preserveOnce"]):has(Identifier[name="Cypress"], Identifier[name="Cookies"]))', (node) => {
+        if ((0, helpers_1.isAlreadyCommented)(node)) {
+            return;
+        }
+        const expression = node.expression.getText().trim();
+        // prevent grabbing other Cypress.<something>.defaults
+        if (expression === 'Cypress.Cookies') {
+            return `// TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
+${node.getText()}`;
+        }
+    });
+    tree.write(filePath, markedRemovedCommands);
+}
+exports.shouldUseCySession = shouldUseCySession;
+/**
+ * leave a comment about nested cy commands in a cy.should callback
+ * */
+function shouldNotUseCyInShouldCB(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    const markedNestedCyCommands = tsquery_1.tsquery.replace(content, 'CallExpression > PropertyAccessExpression:has(Identifier[name="cy"]):has(Identifier[name="should"])', (node) => {
+        var _a, _b;
+        if ((0, helpers_1.isAlreadyCommented)(node) ||
+            (node.parent && !(0, typescript_1.isCallExpression)(node.parent))) {
+            return;
+        }
+        const parentExpression = node.parent;
+        if (((_a = parentExpression === null || parentExpression === void 0 ? void 0 : parentExpression.arguments) === null || _a === void 0 ? void 0 : _a[0]) &&
+            ((0, typescript_1.isArrowFunction)(parentExpression.arguments[0]) ||
+                (0, typescript_1.isFunctionExpression)(parentExpression.arguments[0]))) {
+            const isUsingNestedCyCommand = ((_b = tsquery_1.tsquery.query(parentExpression.arguments[0], 'CallExpression > PropertyAccessExpression:has(Identifier[name="cy"])')) === null || _b === void 0 ? void 0 : _b.length) > 0;
+            if (isUsingNestedCyCommand) {
+                return `/**
+* TODO(@nrwl/cypress): Nesting Cypress commands in a should assertion now throws.
+* You should use .then() to chain commands instead.
+* More Info: https://docs.cypress.io/guides/references/migration-guide#-should
+**/
+${node.getText()}`;
+            }
+            return node.getText();
+        }
+    });
+    tree.write(filePath, markedNestedCyCommands);
+}
+exports.shouldNotUseCyInShouldCB = shouldNotUseCyInShouldCB;
+/**
+ * leave a comment on all usages of overriding built-ins that are now banned
+ * */
+function shouldNotOverrideCommands(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    const markedOverrideUsage = tsquery_1.tsquery.replace(content, 'PropertyAccessExpression:has(Identifier[name="overwrite"]):has(Identifier[name="Cypress"])', (node) => {
+        var _a, _b;
+        if ((0, helpers_1.isAlreadyCommented)(node)) {
+            return;
+        }
+        const expression = node.expression.getText().trim();
+        // prevent grabbing other Cypress.<something>.defaults
+        if (expression === 'Cypress.Commands') {
+            // get value.
+            const overwriteExpression = node.parent;
+            const command = (_b = (_a = overwriteExpression.arguments) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.text; // need string without quotes
+            if (helpers_1.BANNED_COMMANDS.includes(command)) {
+                // overwrite
+                return `/**
+* TODO(@nrwl/cypress): This command can no longer be overridden
+* Consider using a different name like 'custom_${command}'
+* More info: https://docs.cypress.io/guides/references/migration-guide#Cypress-Commands-overwrite
+**/
+${node.getText()}`;
+            }
+        }
+    });
+    tree.write(filePath, markedOverrideUsage);
+}
+exports.shouldNotOverrideCommands = shouldNotOverrideCommands;
+exports.default = updateToCypress12;
+//# sourceMappingURL=update-to-cypress-12.js.map

package/src/migrations/update-15-5-0/update-to-cypress-12.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-to-cypress-12.js","sourceRoot":"","sources":["../../../../../../packages/cypress/src/migrations/update-15-5-0/update-to-cypress-12.ts"],"names":[],"mappings":";;;AAAA,uCAQoB;AACpB,6FAA0F;AAC1F,uDAAoD;AACpD,2CAQoB;AAEpB,iEAAsE;AACtE,uCAAgE;AAEhE,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAExC,SAAgB,iBAAiB,CAAC,IAAU;IAC1C,IAAI,IAAA,yCAAuB,GAAE,GAAG,EAAE,EAAE;QAClC,OAAO;KACR;IACD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;IAEnC,IAAA,+CAAsB,EACpB,IAAI,EACJ,uBAAuB,EACvB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;QAC/C,IAAI,CAAC,CAAC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE;YAClE,OAAO;SACR;QACD,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChD,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QAElD,IAAA,6BAAoB,EAAC,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC1D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACtC,OAAO;aACR;YACD,oBAAoB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACrC,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACnC,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACzC,yBAAyB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAY,EAAA;;;;;OAKpB,CAAC,CAAC;IAEP,IAAA,mBAAU,EAAC,IAAI,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;QACxC,IAAI,CAAC,eAAe,CAAC,OAAO,GAAG,SAAS,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;AACJ,CAAC;AA3CD,8CA2CC;AAED,SAAgB,oBAAoB,CAAC,IAAU,EAAE,UAAkB;IACjE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,kBAAkB,GAAG,iBAAO,CAAC,KAAK,CACtC,MAAM,EACN,qGAAqG,CACtG,CAAC;IAEF,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,OAAO;KACR;IAED,MAAM,qBAAqB,GAAG;;;;;;0BAMN,CAAC;IACzB,MAAM,OAAO,GAAG,iBAAO,CAAC,OAAO,CAC7B,MAAM,EACN,2FAA2F,EAC3F,CAAC,IAAwB,EAAE,EAAE;QAC3B,IAAI,IAAA,sCAAyB,EAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC/C,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU;iBACjD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;iBACvB,IAAI,CAAC,SAAS,CAAC,CAAC;YACnB,OAAO;MACT,gBAAgB;MAChB,qBAAqB;GACxB,CAAC;SACG;QACD,OAAO;SACJ,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;MAC7B,qBAAqB;IACvB,CAAC;IACD,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAClC,CAAC;AAvCD,oDAuCC;AAED;;;;IAII;AACJ,SAAgB,oBAAoB,CAAC,IAAU,EAAE,QAAgB;IAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,qBAAqB,GAAG,iBAAO,CAAC,OAAO,CAC3C,OAAO,EACP,8OAA8O,EAC9O,CAAC,IAA8B,EAAE,EAAE;QACjC,IAAI,IAAA,4BAAkB,EAAC,IAAI,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC;QACpD,oEAAoE;QACpE,6BAA6B;QAC7B,mDAAmD;QACnD,IAAI,UAAU,KAAK,IAAI,IAAI,UAAU,KAAK,gBAAgB,EAAE;YAC1D,OAAO;EACb,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;SACZ;IACH,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC9C,CAAC;AArBD,oDAqBC;AAED;;;;IAII;AACJ,SAAgB,kBAAkB,CAAC,IAAU,EAAE,QAAgB;IAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,qBAAqB,GAAG,iBAAO,CAAC,OAAO,CAC3C,OAAO,EACP,4PAA4P,EAC5P,CAAC,IAA8B,EAAE,EAAE;QACjC,IAAI,IAAA,4BAAkB,EAAC,IAAI,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC;QACpD,sDAAsD;QACtD,IAAI,UAAU,KAAK,iBAAiB,EAAE;YACpC,OAAO;EACb,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;SACZ;IACH,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC9C,CAAC;AAnBD,gDAmBC;AAED;;KAEK;AACL,SAAgB,wBAAwB,CAAC,IAAU,EAAE,QAAgB;IACnE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,sBAAsB,GAAG,iBAAO,CAAC,OAAO,CAC5C,OAAO,EACP,qGAAqG,EACrG,CAAC,IAA8B,EAAE,EAAE;;QACjC,IACE,IAAA,4BAAkB,EAAC,IAAI,CAAC;YACxB,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAA,6BAAgB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAC/C;YACA,OAAO;SACR;QACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAwB,CAAC;QACvD,IACE,CAAA,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,SAAS,0CAAG,CAAC,CAAC;YAChC,CAAC,IAAA,4BAAe,EAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC7C,IAAA,iCAAoB,EAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACtD;YACA,MAAM,sBAAsB,GAC1B,CAAA,MAAA,iBAAO,CAAC,KAAK,CACX,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,EAC7B,sEAAsE,CACvE,0CAAE,MAAM,IAAG,CAAC,CAAC;YAChB,IAAI,sBAAsB,EAAE;gBAC1B,OAAO;;;;;EAKf,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;aACV;YACD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;SACvB;IACH,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;AAC/C,CAAC;AArCD,4DAqCC;AAED;;KAEK;AACL,SAAgB,yBAAyB,CAAC,IAAU,EAAE,QAAgB;IACpE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,mBAAmB,GAAG,iBAAO,CAAC,OAAO,CACzC,OAAO,EACP,4FAA4F,EAC5F,CAAC,IAA8B,EAAE,EAAE;;QACjC,IAAI,IAAA,4BAAkB,EAAC,IAAI,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC;QACpD,sDAAsD;QAEtD,IAAI,UAAU,KAAK,kBAAkB,EAAE;YACrC,aAAa;YACb,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAwB,CAAC;YAE1D,MAAM,OAAO,GAAG,MAAC,MAAA,mBAAmB,CAAC,SAAS,0CAAG,CAAC,CAAS,0CAAE,IAAI,CAAC,CAAC,6BAA6B;YAChG,IAAI,yBAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBACrC,YAAY;gBACZ,OAAO;;iDAEgC,OAAO;;;EAGtD,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;aACV;SACF;IACH,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;AAC5C,CAAC;AA/BD,8DA+BC;AAED,kBAAe,iBAAiB,CAAC"}

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function replacePackage(tree: Tree): Promise<void>;

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const replace_package_1 = require("@nx/devkit/src/utils/replace-package");
+function replacePackage(tree) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield (0, replace_package_1.replaceNrwlPackageWithNxPackage)(tree, '@nrwl/cypress', '@nx/cypress');
+        yield (0, devkit_1.formatFiles)(tree);
+    });
+}
+exports.default = replacePackage;
+//# sourceMappingURL=update-16-0-0-add-nx-packages.js.map

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-16-0-0-add-nx-packages.js","sourceRoot":"","sources":["../../../../../../packages/cypress/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.ts"],"names":[],"mappings":";;;AAAA,uCAA+C;AAC/C,0EAAuF;AAEvF,SAA8B,cAAc,CAAC,IAAU;;QACrD,MAAM,IAAA,iDAA+B,EAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;QAE5E,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CAAA;AAJD,iCAIC"}

package/src/plugins/preprocessor-vite.d.ts

@@ -0,0 +1,32 @@
+/**
+ * https://github.com/mammadataei/cypress-vite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2022 Mohammad Ataei
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ **/
+type CypressPreprocessor = (file: Record<string, any>) => string | Promise<string>;
+/**
+ * Use Vite as a file preprocess for Cypress test files.
+ * This preprocessor shouldn't be used directly.
+ * Instead, use the nxE2EPreset(__filename, { bundler: 'vite' }) function instead.
+ */
+declare function vitePreprocessor(userConfigPath?: string): CypressPreprocessor;
+export default vitePreprocessor;

package/src/plugins/preprocessor-vite.js

@@ -0,0 +1,96 @@
+"use strict";
+/**
+ * https://github.com/mammadataei/cypress-vite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2022 Mohammad Ataei
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ **/
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const cache = new Map();
+/**
+ * Use Vite as a file preprocess for Cypress test files.
+ * This preprocessor shouldn't be used directly.
+ * Instead, use the nxE2EPreset(__filename, { bundler: 'vite' }) function instead.
+ */
+function vitePreprocessor(userConfigPath) {
+    return (file) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { outputPath, filePath, shouldWatch } = file;
+        if (cache.has(filePath)) {
+            return cache.get(filePath);
+        }
+        const fileName = (0, path_1.basename)(outputPath);
+        const filenameWithoutExtension = (0, path_1.basename)(outputPath, (0, path_1.extname)(outputPath));
+        const defaultConfig = {
+            logLevel: 'silent',
+            define: {
+                'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
+            },
+            build: {
+                emptyOutDir: false,
+                minify: false,
+                outDir: (0, path_1.dirname)(outputPath),
+                sourcemap: true,
+                write: true,
+                watch: getWatcherConfig(shouldWatch),
+                lib: {
+                    entry: filePath,
+                    fileName: () => fileName,
+                    formats: ['umd'],
+                    name: filenameWithoutExtension,
+                },
+            },
+        };
+        cache.set(filePath, outputPath);
+        const { build } = require('vite');
+        const watcher = (yield build(Object.assign({ configFile: userConfigPath }, defaultConfig)));
+        return new Promise((resolve, reject) => {
+            if (shouldWatch && isWatcher(watcher)) {
+                watcher.on('event', (event) => {
+                    if (event.code === 'END') {
+                        resolve(outputPath);
+                        file.emit('rerun');
+                    }
+                    if (event.code === 'ERROR') {
+                        console.error(event);
+                        reject(new Error(event.error.message));
+                    }
+                });
+                file.on('close', () => {
+                    cache.delete(filePath);
+                    watcher.close();
+                });
+            }
+            else {
+                resolve(outputPath);
+            }
+        });
+    });
+}
+function isWatcher(maybeWatcher) {
+    return maybeWatcher.on !== undefined;
+}
+function getWatcherConfig(shouldWatch) {
+    return shouldWatch ? {} : null;
+}
+exports.default = vitePreprocessor;
+//# sourceMappingURL=preprocessor-vite.js.map

package/src/plugins/preprocessor-vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preprocessor-vite.js","sourceRoot":"","sources":["../../../../../packages/cypress/src/plugins/preprocessor-vite.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;IAuBI;;;AAEJ,+BAAkD;AAUlD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;AAExC;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,cAAuB;IAC/C,OAAO,CAAO,IAAI,EAAE,EAAE;QACpB,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAEnD,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvB,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC5B;QAED,MAAM,QAAQ,GAAG,IAAA,eAAQ,EAAC,UAAU,CAAC,CAAC;QACtC,MAAM,wBAAwB,GAAG,IAAA,eAAQ,EAAC,UAAU,EAAE,IAAA,cAAO,EAAC,UAAU,CAAC,CAAC,CAAC;QAE3E,MAAM,aAAa,GAAiB;YAClC,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE;gBACN,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7D;YACD,KAAK,EAAE;gBACL,WAAW,EAAE,KAAK;gBAClB,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,IAAA,cAAO,EAAC,UAAU,CAAC;gBAC3B,SAAS,EAAE,IAAI;gBACf,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC;gBACpC,GAAG,EAAE;oBACH,KAAK,EAAE,QAAQ;oBACf,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ;oBACxB,OAAO,EAAE,CAAC,KAAK,CAAC;oBAChB,IAAI,EAAE,wBAAwB;iBAC/B;aACF;SACF,CAAC;QAEF,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAEhC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,OAAO,GAAG,CAAC,MAAM,KAAK,iBAC1B,UAAU,EAAE,cAAc,IACvB,aAAa,EAChB,CAAgB,CAAC;QAEnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,WAAW,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;gBACrC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC5B,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;wBACxB,OAAO,CAAC,UAAU,CAAC,CAAC;wBACpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;qBACpB;oBAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;wBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;wBACrB,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;qBACxC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;oBACpB,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACvB,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,OAAO,CAAC,UAAU,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,YAAiB;IAClC,OAAO,YAAY,CAAC,EAAE,KAAK,SAAS,CAAC;AACvC,CAAC;AAED,SAAS,gBAAgB,CAAC,WAAoB;IAC5C,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,kBAAe,gBAAgB,CAAC"}

package/src/utils/add-linter.d.ts

@@ -0,0 +1,21 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+import { Linter } from '@nx/linter';
+export interface CyLinterOptions {
+    project: string;
+    linter: Linter;
+    setParserOptionsProject?: boolean;
+    skipPackageJson?: boolean;
+    rootProject?: boolean;
+    js?: boolean;
+    /**
+     * Directory from the project root, where the cypress files will be located.
+     * typically src/ or cypress/
+     **/
+    cypressDir: string;
+    /**
+     * overwrite existing eslint rules for the cypress defaults
+     * This is useful when adding linting to a brand new project vs an existing one
+     **/
+    overwriteExisting?: boolean;
+}
+export declare function addLinterToCyProject(tree: Tree, options: CyLinterOptions): Promise<GeneratorCallback>;

package/src/utils/add-linter.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addLinterToCyProject = void 0;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const linter_1 = require("@nx/linter");
+const global_eslint_config_1 = require("@nx/linter/src/generators/init/global-eslint-config");
+const cypress_version_1 = require("./cypress-version");
+const versions_1 = require("./versions");
+function addLinterToCyProject(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (options.linter === linter_1.Linter.None) {
+            return () => { };
+        }
+        const tasks = [];
+        const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
+        if (!tree.exists((0, devkit_1.joinPathFragments)(projectConfig.root, '.eslintrc.json'))) {
+            tasks.push(yield (0, linter_1.lintProjectGenerator)(tree, {
+                project: options.project,
+                linter: options.linter,
+                skipFormat: true,
+                tsConfigPaths: [(0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json')],
+                eslintFilePatterns: [
+                    `${projectConfig.root}/**/*.${options.js ? 'js' : '{js,ts}'}`,
+                ],
+                setParserOptionsProject: options.setParserOptionsProject,
+                skipPackageJson: options.skipPackageJson,
+                rootProject: options.rootProject,
+            }));
+        }
+        if (!options.linter || options.linter !== linter_1.Linter.EsLint) {
+            return (0, devkit_1.runTasksInSerial)(...tasks);
+        }
+        tasks.push(!options.skipPackageJson
+            ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { 'eslint-plugin-cypress': versions_1.eslintPluginCypressVersion })
+            : () => { });
+        (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(projectConfig.root, '.eslintrc.json'), (json) => {
+            var _a;
+            if (options.rootProject) {
+                json.plugins = ['@nrwl/nx'];
+                json.extends = ['plugin:cypress/recommended'];
+            }
+            else {
+                json.extends = ['plugin:cypress/recommended', ...json.extends];
+            }
+            (_a = json.overrides) !== null && _a !== void 0 ? _a : (json.overrides = []);
+            const globals = options.rootProject ? [global_eslint_config_1.globalJavaScriptOverrides] : [];
+            const override = {
+                files: ['*.ts', '*.tsx', '*.js', '*.jsx'],
+                parserOptions: !options.setParserOptionsProject
+                    ? undefined
+                    : {
+                        project: `${projectConfig.root}/tsconfig.*?.json`,
+                    },
+                rules: {},
+            };
+            const cyFiles = [
+                Object.assign(Object.assign({}, override), { files: [
+                        '*.cy.{ts,js,tsx,jsx}',
+                        `${options.cypressDir}/**/*.{ts,js,tsx,jsx}`,
+                    ] }),
+            ];
+            if (options.overwriteExisting) {
+                json.overrides = [...globals, override];
+            }
+            else {
+                json.overrides.push(...globals);
+                json.overrides.push(...cyFiles);
+            }
+            const cyVersion = (0, cypress_version_1.installedCypressVersion)();
+            if (cyVersion && cyVersion < 7) {
+                /**
+                 * We need this override because we enabled allowJS in the tsconfig to allow for JS based Cypress tests.
+                 * That however leads to issues with the CommonJS Cypress plugin file.
+                 */
+                json.overrides.push({
+                    files: [`${options.cypressDir}/plugins/index.js`],
+                    rules: {
+                        '@typescript-eslint/no-var-requires': 'off',
+                        'no-undef': 'off',
+                    },
+                });
+            }
+            return json;
+        });
+        return (0, devkit_1.runTasksInSerial)(...tasks);
+    });
+}
+exports.addLinterToCyProject = addLinterToCyProject;
+//# sourceMappingURL=add-linter.js.map

package/src/utils/add-linter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-linter.js","sourceRoot":"","sources":["../../../../../packages/cypress/src/utils/add-linter.ts"],"names":[],"mappings":";;;;AAAA,uCAQoB;AACpB,uCAA0D;AAC1D,8FAAgG;AAChG,uDAA4D;AAC5D,yCAAwD;AAqBxD,SAAsB,oBAAoB,CACxC,IAAU,EACV,OAAwB;;QAExB,IAAI,OAAO,CAAC,MAAM,KAAK,eAAM,CAAC,IAAI,EAAE;YAClC,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;SACjB;QAED,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,MAAM,aAAa,GAAG,IAAA,iCAAwB,EAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE;YACzE,KAAK,CAAC,IAAI,CACR,MAAM,IAAA,6BAAoB,EAAC,IAAI,EAAE;gBAC/B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,CAAC,IAAA,0BAAiB,EAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;gBACvE,kBAAkB,EAAE;oBAClB,GAAG,aAAa,CAAC,IAAI,SAAS,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE;iBAC9D;gBACD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;gBACxD,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAC,CACH,CAAC;SACH;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,eAAM,CAAC,MAAM,EAAE;YACvD,OAAO,IAAA,yBAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;SACnC;QAED,KAAK,CAAC,IAAI,CACR,CAAC,OAAO,CAAC,eAAe;YACtB,CAAC,CAAC,IAAA,qCAA4B,EAC1B,IAAI,EACJ,EAAE,EACF,EAAE,uBAAuB,EAAE,qCAA0B,EAAE,CACxD;YACH,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,CACb,CAAC;QAEF,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,EACvD,CAAC,IAAI,EAAE,EAAE;;YACP,IAAI,OAAO,CAAC,WAAW,EAAE;gBACvB,IAAI,CAAC,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC5B,IAAI,CAAC,OAAO,GAAG,CAAC,4BAA4B,CAAC,CAAC;aAC/C;iBAAM;gBACL,IAAI,CAAC,OAAO,GAAG,CAAC,4BAA4B,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;aAChE;YACD,MAAA,IAAI,CAAC,SAAS,oCAAd,IAAI,CAAC,SAAS,GAAK,EAAE,EAAC;YACtB,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,gDAAyB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,MAAM,QAAQ,GAAG;gBACf,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC;gBACzC,aAAa,EAAE,CAAC,OAAO,CAAC,uBAAuB;oBAC7C,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC;wBACE,OAAO,EAAE,GAAG,aAAa,CAAC,IAAI,mBAAmB;qBAClD;gBACL,KAAK,EAAE,EAAE;aACV,CAAC;YACF,MAAM,OAAO,GAAG;gDAET,QAAQ,KACX,KAAK,EAAE;wBACL,sBAAsB;wBACtB,GAAG,OAAO,CAAC,UAAU,uBAAuB;qBAC7C;aAEJ,CAAC;YACF,IAAI,OAAO,CAAC,iBAAiB,EAAE;gBAC7B,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;aACzC;iBAAM;gBACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;gBAChC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;aACjC;YAED,MAAM,SAAS,GAAG,IAAA,yCAAuB,GAAE,CAAC;YAC5C,IAAI,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;gBAC9B;;;mBAGG;gBACH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;oBAClB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,UAAU,mBAAmB,CAAC;oBACjD,KAAK,EAAE;wBACL,oCAAoC,EAAE,KAAK;wBAC3C,UAAU,EAAE,KAAK;qBAClB;iBACF,CAAC,CAAC;aACJ;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CACF,CAAC;QAEF,OAAO,IAAA,yBAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;IACpC,CAAC;CAAA;AAlGD,oDAkGC"}

package/src/utils/ct-helpers.d.ts

@@ -0,0 +1,16 @@
+import type { ExecutorContext, ProjectGraph } from '@nx/devkit';
+import { ProjectConfiguration, TargetConfiguration } from '@nx/devkit';
+export declare const CY_FILE_MATCHER: RegExp;
+/**
+ * return a path to a temp css file
+ * temp file is scoped to the project root
+ * i.e. <context.root>/tmp/<project-root>/ct-styles.css
+ */
+export declare function getTempTailwindPath(context: ExecutorContext): string;
+/**
+ * Checks if the childProjectName is a descendent of the parentProjectName
+ * in the project graph
+ **/
+export declare function isCtProjectUsingBuildProject(graph: ProjectGraph, parentProjectName: string, childProjectName: string): boolean;
+export declare function getProjectConfigByPath(graph: ProjectGraph, configPath: string): ProjectConfiguration;
+export declare function createExecutorContext(graph: ProjectGraph, targets: Record<string, TargetConfiguration>, projectName: string, targetName: string, configurationName: string): ExecutorContext;

package/src/utils/ct-helpers.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createExecutorContext = exports.getProjectConfigByPath = exports.isCtProjectUsingBuildProject = exports.getTempTailwindPath = exports.CY_FILE_MATCHER = void 0;
+const devkit_1 = require("@nx/devkit");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const find_project_for_path_1 = require("nx/src/project-graph/utils/find-project-for-path");
+const project_graph_1 = require("nx/src/project-graph/project-graph");
+const file_utils_1 = require("nx/src/project-graph/file-utils");
+exports.CY_FILE_MATCHER = new RegExp(/\.cy\.[tj]sx?$/);
+/**
+ * return a path to a temp css file
+ * temp file is scoped to the project root
+ * i.e. <context.root>/tmp/<project-root>/ct-styles.css
+ */
+function getTempTailwindPath(context) {
+    var _a;
+    if (!context.projectName) {
+        throw new Error('No project name found in context');
+    }
+    const project = context === null || context === void 0 ? void 0 : context.projectGraph.nodes[context.projectName];
+    if (!project) {
+        throw new Error(`No project found in project graph for ${context.projectName}`);
+    }
+    if ((_a = project === null || project === void 0 ? void 0 : project.data) === null || _a === void 0 ? void 0 : _a.root) {
+        return (0, path_1.join)(context.root, 'tmp', project.data.root, 'ct-styles.css');
+    }
+}
+exports.getTempTailwindPath = getTempTailwindPath;
+/**
+ * Checks if the childProjectName is a descendent of the parentProjectName
+ * in the project graph
+ **/
+function isCtProjectUsingBuildProject(graph, parentProjectName, childProjectName) {
+    const isProjectDirectDep = graph.dependencies[parentProjectName].some((p) => p.target === childProjectName);
+    if (isProjectDirectDep) {
+        return true;
+    }
+    const maybeIntermediateProjects = graph.dependencies[parentProjectName].filter((p) => !graph.externalNodes[p.target]);
+    for (const maybeIntermediateProject of maybeIntermediateProjects) {
+        if (isCtProjectUsingBuildProject(graph, maybeIntermediateProject.target, childProjectName)) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.isCtProjectUsingBuildProject = isCtProjectUsingBuildProject;
+function getProjectConfigByPath(graph, configPath) {
+    var _a, _b, _c;
+    var _d;
+    const configFileFromWorkspaceRoot = (0, path_1.relative)(devkit_1.workspaceRoot, configPath);
+    const normalizedPathFromWorkspaceRoot = (0, devkit_1.normalizePath)((0, fs_1.lstatSync)(configPath).isFile()
+        ? configFileFromWorkspaceRoot.replace((0, path_1.extname)(configPath), '')
+        : configFileFromWorkspaceRoot);
+    const projectRootMappings = (0, find_project_for_path_1.createProjectRootMappings)(graph.nodes);
+    const componentTestingProjectName = (0, find_project_for_path_1.findProjectForPath)(normalizedPathFromWorkspaceRoot, projectRootMappings);
+    if (!componentTestingProjectName ||
+        !((_a = graph.nodes[componentTestingProjectName]) === null || _a === void 0 ? void 0 : _a.data)) {
+        throw new Error((0, devkit_1.stripIndents) `Unable to find the project configuration that includes ${normalizedPathFromWorkspaceRoot}. 
+      Found project name? ${componentTestingProjectName}. 
+      Graph has data? ${!!((_b = graph.nodes[componentTestingProjectName]) === null || _b === void 0 ? void 0 : _b.data)}`);
+    }
+    // make sure name is set since it can be undefined
+    (_c = (_d = graph.nodes[componentTestingProjectName].data).name) !== null && _c !== void 0 ? _c : (_d.name = componentTestingProjectName);
+    return graph.nodes[componentTestingProjectName].data;
+}
+exports.getProjectConfigByPath = getProjectConfigByPath;
+function createExecutorContext(graph, targets, projectName, targetName, configurationName) {
+    const projectsConfigurations = (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(graph);
+    const nxJsonConfiguration = (0, file_utils_1.readNxJson)();
+    return {
+        cwd: process.cwd(),
+        projectGraph: graph,
+        target: targets[targetName],
+        targetName,
+        configurationName,
+        root: devkit_1.workspaceRoot,
+        isVerbose: false,
+        projectName,
+        projectsConfigurations,
+        nxJsonConfiguration,
+        workspace: Object.assign(Object.assign({}, nxJsonConfiguration), projectsConfigurations),
+    };
+}
+exports.createExecutorContext = createExecutorContext;
+//# sourceMappingURL=ct-helpers.js.map