mirror of
https://github.com/cypress-io/cypress.git
synced 2026-04-30 03:51:21 -05:00
Bill Glesias
3481d1acaf
* migrate cli scripts to TypeScript * convert all javascript source files in the CLI to TypeScript rebase into first * chore: refactor all tests to TypeScript rebase into second * add npmignore for cli for typescript files * update build process * fix publically available exports * Fix cy-in-cy tests * add ts-expect-error to failing files * fix projectConfigIpc failures as there are now multiple installs of tsx * fix after-pack hook * fix binary script * chore: update publish binary to account for CLI being an ESModule compiled down to CommonJS * does this work? * fix the verify spec by making the listr2 renderer silent as it behaves differently since the refactor and is printing non deterministic outputs into our tests that do not have a large impact on the area we are testing and mostly served to actually test the renders of the listr2 framework itself * empty commit * additional refactor to code to remove strange any typing and exporting * bump cache and build binaries * fix CLI exports to keep backwards compatibility * fix unit-tests * turn on mac jobs * fix group name rename in CLI * remove babel deps from cli and explicitly install typescript * address feedback from code review * dont just falsy check results and instead explicitly check for null or undefined * add ts-expect-error * additional pass on cleaning up dynamic require / import from global lib references * annotate ts-expect-errors with reason for why error is expected * add rest of ts-expect-error comments * removing hardcoded branch to publish binary chore/migrate_cli_to_typescript
101 lines
3.6 KiB
JavaScript
101 lines
3.6 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
// @ts-check
|
|
/* eslint-disable no-console */
|
|
import fs from 'fs-extra'
|
|
import { includeTypes } from './utils'
|
|
import shell from 'shelljs'
|
|
import { join } from 'path'
|
|
import resolvePkg from 'resolve-pkg'
|
|
|
|
import './clean'
|
|
|
|
shell.set('-v') // verbose
|
|
shell.set('-e') // any error is fatal
|
|
|
|
// We include the TypeScript definitions for the bundled 3rd party tools
|
|
// thus we need to copy them from "dev" dependencies into our types folder
|
|
// and we need to sometimes tweak these types files to use relative paths
|
|
// This ensures that globals like Cypress.$, Cypress._ etc are property typed
|
|
// yet we do not install "@types/.." packages with "npm install cypress"
|
|
// because they can conflict with user's own libraries
|
|
|
|
fs.ensureDirSync(join(__dirname, '..', 'types'))
|
|
|
|
includeTypes.forEach((folder: string) => {
|
|
const source: string = resolvePkg(`@types/${folder}`, { cwd: __dirname })
|
|
|
|
fs.copySync(source, join(__dirname, '..', 'types', folder))
|
|
})
|
|
|
|
// jQuery v3.3.x includes "dist" folder that just references back to itself
|
|
// causing dtslint to think there are double definitions. Remove that folder.
|
|
const typesJqueryDistFolder: string = join('types', 'jquery', 'dist')
|
|
|
|
shell.rm('-rf', typesJqueryDistFolder)
|
|
|
|
/**
|
|
* Replaces "reference types=<n>" comment with "reference path=..." line.
|
|
* @param {string} typeName - like "chai" or "jquery"
|
|
* @param {string} relativeTypesFilePath - relative path to .d.ts file like "../chai/index.d.ts"
|
|
* @param {string} filename - the source file to change
|
|
*/
|
|
function makeReferenceTypesCommentRelative (typeName: string, relativeTypesFilePath: string, filename: string): void {
|
|
console.log('in file %s changing reference for types %s to relative path %s',
|
|
filename, typeName, relativeTypesFilePath)
|
|
|
|
const referenceTypes: string = `<reference types="${typeName}" />`
|
|
const relativeTypes: string = `<reference path="${relativeTypesFilePath}" />`
|
|
|
|
shell.sed(
|
|
'-i',
|
|
referenceTypes,
|
|
relativeTypes,
|
|
filename,
|
|
)
|
|
}
|
|
|
|
// fix paths to Chai, jQuery and other types to be relative
|
|
makeReferenceTypesCommentRelative('chai', '../chai/index.d.ts',
|
|
join('types', 'chai-jquery', 'index.d.ts'))
|
|
|
|
makeReferenceTypesCommentRelative('jquery', '../jquery/index.d.ts',
|
|
join('types', 'chai-jquery', 'index.d.ts'))
|
|
|
|
const sinonChaiFilename: string = join('types', 'sinon-chai', 'index.d.ts')
|
|
|
|
makeReferenceTypesCommentRelative('chai', '../chai/index.d.ts', sinonChaiFilename)
|
|
|
|
// also use relative import via path for sinon-chai
|
|
// there is reference comment line we need to fix to be relative
|
|
makeReferenceTypesCommentRelative('sinon', '../sinon/index.d.ts', sinonChaiFilename)
|
|
|
|
// and an import sinon line to be changed to relative path
|
|
shell.sed('-i', 'from "sinon";', 'from "../sinon";', sinonChaiFilename)
|
|
|
|
// copy experimental network stubbing type definitions
|
|
// so users can import: `import 'cypress/types/net-stubbing'`
|
|
fs.copySync(resolvePkg('@packages/net-stubbing/lib/external-types.ts'), 'types/net-stubbing.d.ts')
|
|
|
|
// https://github.com/cypress-io/cypress/issues/18069
|
|
// To avoid type clashes, some files should be commented out entirely by patch-package
|
|
// and uncommented here.
|
|
|
|
const filesToUncomment: string[] = [
|
|
'mocha/index.d.ts',
|
|
'jquery/JQuery.d.ts',
|
|
'jquery/legacy.d.ts',
|
|
'jquery/misc.d.ts',
|
|
]
|
|
|
|
filesToUncomment.forEach((file: string) => {
|
|
const filePath: string = join(__dirname, '../types', file)
|
|
const str: string = fs.readFileSync(filePath).toString()
|
|
|
|
const result: string = str.split('\n').map((line: string) => {
|
|
return line.startsWith('//z ') ? line.substring(4) : line
|
|
}).join('\n')
|
|
|
|
fs.writeFileSync(filePath, result)
|
|
})
|