feat: tie it all together

Author: sorccu

packages/cli/src/constructs/construct-diagnostics.ts

@@ -137,6 +137,20 @@ export class UnsupportedRuntimeFeatureDiagnostic extends ErrorDiagnostic {
   }
 }
 
+export class UnsatisfiedLocalPrerequisitesDiagnostic extends ErrorDiagnostic {
+  constructor (error: Error) {
+    super({
+      title: `Unsatisfied local prerequisites`,
+      message:
+        `Local environment does not satisfy the prerequisites for this `
+        + `functionality.`
+        + `\n\n`
+        + `Cause: ${error.message}`,
+      error,
+    })
+  }
+}
+
 export class ConstructDiagnostic extends Diagnostic {
   underlying: Diagnostic
 

packages/cli/src/constructs/playwright-check.ts

@@ -11,9 +11,10 @@ import {
   ConflictingPropertyDiagnostic,
   DeprecatedPropertyDiagnostic,
   InvalidPropertyValueDiagnostic,
+  UnsatisfiedLocalPrerequisitesDiagnostic,
   UnsupportedPropertyDiagnostic,
 } from './construct-diagnostics'
-import { Diagnostics } from './diagnostics'
+import { Diagnostics, ErrorDiagnostic } from './diagnostics'
 import { PlaywrightCheckBundle } from './playwright-check-bundle'
 import { Session } from './project'
 import { Ref } from './ref'
@@ -126,7 +127,7 @@ export interface PlaywrightCheckProps extends Omit<RuntimeCheckProps, 'retryStra
  */
 export class PlaywrightCheck extends RuntimeCheck {
   installCommand?: string
-  testCommand: string
+  testCommand?: string
   playwrightConfigPath: string
   pwProjects: string[]
   pwTags: string[]
@@ -149,7 +150,7 @@ export class PlaywrightCheck extends RuntimeCheck {
     this.include = config.include
       ? (Array.isArray(config.include) ? config.include : [config.include])
       : []
-    this.testCommand = config.testCommand ?? 'npx playwright test'
+    this.testCommand = config.testCommand
     this.groupName = config.groupName
     this.playwrightConfigPath = this.resolveContentFilePath(config.playwrightConfigPath)
     Session.registerConstruct(this)
@@ -240,6 +241,7 @@ export class PlaywrightCheck extends RuntimeCheck {
 
   async validate (diagnostics: Diagnostics): Promise<void> {
     await super.validate(diagnostics)
+    await this.#validateWorkspace(diagnostics)
     await this.validateRetryStrategy(diagnostics)
 
     try {
@@ -254,6 +256,29 @@ export class PlaywrightCheck extends RuntimeCheck {
     this.#validateGroupReferences(diagnostics)
   }
 
+  // eslint-disable-next-line require-await
+  async #validateWorkspace (diagnostics: Diagnostics): Promise<void> {
+    const workspace = Session.workspace
+    if (workspace.isOk()) {
+      const lockfile = workspace.ok().lockfile
+      if (lockfile.isErr()) {
+        diagnostics.add(new UnsatisfiedLocalPrerequisitesDiagnostic(new Error(
+          `A lockfile is required for Playwright checks, but none could be `
+          + `detected.`
+          + '\n\n'
+          + `Cause: ${lockfile.err().message}`,
+        )))
+      }
+    } else if (workspace.isErr()) {
+      diagnostics.add(new UnsatisfiedLocalPrerequisitesDiagnostic(new Error(
+        `A workspace is required for Playwright checks, but none could be `
+        + `detected.`
+        + '\n\n'
+        + `Cause: ${workspace.err().message}`,
+      )))
+    }
+  }
+
   #validateGroupReferences (diagnostics: Diagnostics): void {
     if (this.groupName) {
       diagnostics.add(new DeprecatedPropertyDiagnostic(
@@ -295,6 +320,12 @@ export class PlaywrightCheck extends RuntimeCheck {
     return `${testCommand} --config ${quotedPath}${projectArg}${tagArg}`
   }
 
+  static contextifyCommand (command: string): string {
+    return Session.basePath === Session.contextPath
+      ? command
+      : `env --chdir "${Session.relativePosixPath(Session.contextPath!)}" -- ${command}`
+  }
+
   static async bundleProject (playwrightConfigPath: string, include: string[]) {
     let dir = ''
     try {
@@ -333,12 +364,12 @@ export class PlaywrightCheck extends RuntimeCheck {
       relativePlaywrightConfigPath,
     } = await PlaywrightCheck.bundleProject(this.playwrightConfigPath, this.include ?? [])
 
-    const testCommand = PlaywrightCheck.buildTestCommand(
-      this.testCommand,
+    const testCommand = PlaywrightCheck.contextifyCommand(PlaywrightCheck.buildTestCommand(
+      this.testCommand ?? this.#defaultTestCommand(),
       relativePlaywrightConfigPath,
       this.pwProjects,
       this.pwTags,
-    )
+    ))
 
     return new PlaywrightCheckBundle(this, {
       groupId,
@@ -351,6 +382,10 @@ export class PlaywrightCheck extends RuntimeCheck {
     })
   }
 
+  #defaultTestCommand (): string {
+    return Session.packageManager.execCommand(['playwright', 'test']).unsafeDisplayCommand
+  }
+
   synthesize () {
     return {
       ...super.synthesize(),

packages/cli/src/constructs/project.ts

@@ -25,6 +25,8 @@ import { ConstructDiagnostics, InvalidPropertyValueDiagnostic } from './construc
 import { ProjectBundle, ProjectDataBundle } from './project-bundle'
 import { pathToPosix } from '../services/util'
 import { Workspace } from '../services/check-parser/package-files/workspace'
+import { npmPackageManager, PackageManager } from '../services/check-parser/package-files/package-manager'
+import { Err, Result } from '../services/check-parser/package-files/result'
 
 export interface ProjectProps {
   /**
@@ -230,6 +232,7 @@ export class Session {
 
   static project?: Project
   static basePath?: string
+  static contextPath?: string
   static checkDefaults?: CheckConfigDefaults
   static checkFilter?: CheckFilter
   static browserCheckDefaults?: CheckConfigDefaults
@@ -245,7 +248,8 @@ export class Session {
   static parsers = new Map<string, Parser>()
   static constructExports: ConstructExport[] = []
   static ignoreDirectoriesMatch: string[] = []
-  static workspace?: Workspace
+  static packageManager: PackageManager = npmPackageManager
+  static workspace: Result<Workspace, Error> = Err(new Error(`Workspace support not initialized`))
 
   static async loadFile<T = unknown> (filePath: string): Promise<T> {
     const loader = this.loader
@@ -340,7 +344,7 @@ export class Session {
     const parser = new Parser({
       supportedNpmModules: Object.keys(runtime.dependencies),
       checkUnsupportedModules: Session.verifyRuntimeDependencies,
-      workspace: Session.workspace,
+      workspace: Session.workspace.ok(),
     })
 
     Session.parsers.set(runtime.name, parser)
@@ -352,6 +356,10 @@ export class Session {
     return pathToPosix(path.relative(Session.basePath!, filePath))
   }
 
+  static contextRelativePosixPath (filePath: string): string {
+    return pathToPosix(path.relative(Session.contextPath!, filePath))
+  }
+
   static sharedFileRefs = new Map<string, SharedFileRef>()
   static sharedFiles: SharedFile[] = []
 

packages/cli/src/services/check-parser/package-files/extension.ts

@@ -4,6 +4,10 @@ export type CoreExtension = '.js' | '.mjs' | '.cjs' | '.json'
 
 export const CoreExtensions: CoreExtension[] = ['.js', '.mjs', '.cjs', '.json']
 
+export function isCoreExtension (value: string): value is CoreExtension {
+  return CoreExtensions.includes(value as CoreExtension)
+}
+
 type CoreExtensionMapping = {
   [key in CoreExtension]: string[]
 }
@@ -26,9 +30,13 @@ export const tsCoreExtensionLookupOrder: CoreExtensionMapping = {
   '.json': ['.json'],
 }
 
-export type TSExtension = '.ts' | '.mts' | '.tsx'
+export type TSExtension = '.ts' | '.mts' | '.cts' | '.tsx'
 
-export const TSExtensions: TSExtension[] = ['.ts', '.mts', '.tsx']
+export const TSExtensions: TSExtension[] = ['.ts', '.mts', '.cts', '.tsx']
+
+export function isTSExtension (value: string): value is TSExtension {
+  return TSExtensions.includes(value as TSExtension)
+}
 
 type TSExtensionMapping = {
   [key in TSExtension]: string[]
@@ -37,6 +45,7 @@ type TSExtensionMapping = {
 export const tsExtensionLookupOrder: TSExtensionMapping = {
   '.ts': ['.ts'],
   '.mts': ['.mts'],
+  '.cts': ['.cts'],
   '.tsx': ['.tsx'],
 }