@11joselu/cypress-to-playwright/lib/command.js

Automatic migration from cypress to playwright

import { basename, dirname, join, resolve, sep } from 'path';
import pc from 'picocolors';
import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
import { globSync } from 'glob';
import { converter } from './converter.js';
import { RequiredDirectoryException } from './core/required-directory-exception.js';
import { createInMemoryCustomCommandTracker } from './core/infrastructure/in-memory-custom-command-tracker.js';
export function execute(directory, logger) {
    const customCommandsTracker = createInMemoryCustomCommandTracker();
    validateDirectory(directory);
    const outputDir = resolve(directory, '..', 'playwright');
    mkdir(outputDir);
    const files = getFiles(directory);
    const result = files.map(readCyCode).map((file) => migrateCodeToPlaywright(file, customCommandsTracker));
    result.forEach(writeMigratedCodeFrom(directory, outputDir));
    const migrated = result.filter((p) => !p.hasCyReferences);
    const notMigrated = result
        .filter((p) => p.hasCyReferences)
        .map((p) => p.path)
        .map((p) => p.replace(resolve('..'), ''));
    logger.log(getSummary(migrated.length, notMigrated));
    logger.log(getNextStep(outputDir));
}
function validateDirectory(directory) {
    if (!directory) {
        throw new RequiredDirectoryException();
    }
}
function mkdir(dir) {
    if (!existsSync(dir)) {
        mkdirSync(dir, { recursive: true });
    }
}
function getFiles(directory) {
    return globSync(`${directory}/**/*.{js,ts}`, { ignore: `**/node_modules/**` })
        .filter((file) => !file.endsWith('cypress.config.js') && !file.endsWith('cypress.config.ts'))
        .sort((a) => {
        return a.includes('spec') || a.includes('cy') ? -1 : 1;
    });
}
function writeMigratedCodeFrom(readDirectory, outputDir) {
    return (file) => {
        const writeInFile = join(outputDir, fixFilePath(readDirectory, file.path));
        let content = file.newCode || '';
        if (file.newCode !== file.code && /(?:test|describe|expect)\s*?\(/g.test(content)) {
            content = "import { test, expect } from '@playwright/test';" + '\n' + content;
        }
        writeContentInFile(writeInFile, content);
    };
}
function readCyCode(path) {
    return {
        path: path,
        code: readFileSync(resolve(path), 'utf-8'),
        newCode: null,
        hasCyReferences: false,
    };
}
function migrateCodeToPlaywright(file, customCommandsTracker) {
    try {
        const newCode = converter(file.code, customCommandsTracker);
        return {
            ...file,
            newCode: newCode,
            hasCyReferences: newCode.includes('cy.'),
        };
    }
    catch (e) {
        console.error("Can't migrate: " + file.path);
        return {
            ...file,
            hasCyReferences: file.code.includes('cy.'),
        };
    }
}
function getSummary(migrated, notMigrated) {
    const strings = notMigrated
        .map((file) => {
        return `\n\t${pc.gray('- ' + file)}`;
    })
        .join('');
    return `
  ${pc.green('- Migrated:')} ${pc.green(migrated)}
  ${pc.yellow('- Partial migrated:')} ${pc.yellow(notMigrated.length)}${strings}\n`;
}
function getNextStep(outputDir) {
    return pc.yellow(`Next Step:
      1. Run 'npm init playwright@latest'.
      2. Change 'testDir' option inside the playwright configuration file to '/${basename(outputDir)}'.
      3. Analyze/Remove unnecessary files (like cy commands, cy plugins, clean package.json etc...)
      4. If there are partial migrated files. Fix it replacing cy code with playwright code`);
}
function fixFilePath(fromDir, file) {
    return file
        .replace(fromDir, '')
        .split(sep)
        .filter((p) => !['cypress', 'e2e'].includes(p))
        .join(sep);
}
function writeContentInFile(writeInFile, result) {
    mkdir(dirname(writeInFile));
    writeFileSync(writeInFile.replace('.cy.', '.spec.'), result, {
        flag: 'w',
    });
}
//# sourceMappingURL=command.js.map