fix: scoped type generation (#24)

Author: danadajian

cypress/commands/example.ts

@@ -18,6 +18,11 @@ export function functionExample(input: string) {
   cy.contains(input);
 }
 
+export function functionExampleScoped(element: Cypress.JQueryWithSelector, input: string) {
+  cy.log('Here is a scoped custom command!');
+  cy.wrap(element).should('have.text', input);
+}
+
 export const arrowFunctionExample = (input: string) => {
   cy.log('Here is a custom command from an arrow function!');
   cy.contains(input);
@@ -27,6 +32,7 @@ declare global {
   namespace Cypress {
     interface Chainable {
       functionExample(input: string): Chainable;
+      functionExampleScoped(input: string): Chainable;
       arrowFunctionExample(input: string): Chainable;
     }
   }

cypress/e2e/e2e-example.cy.ts

@@ -26,6 +26,10 @@ describe('Example Test', () => {
     cy.arrowFunctionExample(expectedText);
   });
 
+  it('should support scoped methods', () => {
+    cy.contains(expectedText).functionExampleScoped(expectedText);
+  });
+
   it('should dynamically import nested custom commands', () => {
     cy.nestedExample(expectedText);
   });

src/common.ts

@@ -0,0 +1,3 @@
+export const COMMANDS_DIRECTORY = 'cypress/commands';
+
+export const isScopedMethod = (methodName: string) => methodName.endsWith('Scoped');

src/generate-types-from-abstract-syntax-tree.ts

@@ -26,6 +26,7 @@ import generate from '@babel/generator';
 import { readFileSync } from 'fs';
 import { resolve } from 'path';
 import { format, Options } from 'prettier';
+import { isScopedMethod } from './common';
 
 export const generateTypesFromAbstractSyntaxTree = (filePath: string, prettierConfig?: Options) => {
   const contents = readFileSync(resolve(filePath)).toString();
@@ -52,9 +53,10 @@ export const generateTypesFromAbstractSyntaxTree = (filePath: string, prettierCo
         }
         return parameter as Identifier;
       });
+      const firstParamOmitted = parameters.slice(1);
       return {
         functionIdentifier,
-        parameters
+        parameters: isScopedMethod(functionIdentifier.name) ? firstParamOmitted : parameters
       };
     });
   const newInterface = generateInterface(customCommands);

src/index.ts

@@ -11,6 +11,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { isScopedMethod } from './common';
+
 before('Import Custom Commands', () => {
   cy.task('importCustomCommands').then(
     ({ filePaths, commandsDirectory }: { filePaths: string[]; commandsDirectory: string }) => {
@@ -23,7 +25,7 @@ before('Import Custom Commands', () => {
         const methodNames = Object.keys(customCommandObject);
         methodNames.forEach((methodName: keyof Cypress.Chainable) => {
           const method = customCommandObject[methodName];
-          if (methodName.endsWith('Scoped')) {
+          if (isScopedMethod(methodName)) {
             Cypress.Commands.add(methodName, { prevSubject: 'element' }, method);
           } else {
             Cypress.Commands.add(methodName, method);

src/plugin.ts

@@ -16,8 +16,7 @@ import { generateTypesFromAbstractSyntaxTree } from './generate-types-from-abstr
 import { writeFileSync } from 'fs';
 import { resolve, sep } from 'path';
 import { Options as PrettierConfig, resolveConfig } from 'prettier';
-
-export const COMMANDS_DIRECTORY = 'cypress/commands';
+import { COMMANDS_DIRECTORY } from './common';
 
 export type CypressCodegen = (
   on: Cypress.PluginEvents,

test/generate-types-from-abstract-syntax-tree.test.ts

@@ -224,6 +224,36 @@ declare global {
     }
   }
 }
+`);
+  });
+
+  it('should generate a special type for scoped commands', async () => {
+    (readFileSync as jest.Mock).mockReturnValue(`// some comment
+
+export function functionExampleScoped(
+  element: Cypress.JQueryWithSelector,
+  input1: string
+) {
+  cy.log('Here is a scoped custom command!');
+}
+`);
+    const result = generateTypesFromAbstractSyntaxTree(filePath, prettierConfig);
+    expect(result).toEqual(`// some comment
+
+export function functionExampleScoped(
+  element: Cypress.JQueryWithSelector,
+  input1: string
+) {
+  cy.log('Here is a scoped custom command!');
+}
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      functionExampleScoped(input1: string): Chainable;
+    }
+  }
+}
 `);
   });
 });