@sprucelabs/spruce-cli 24.1.0 → 24.1.1

package/src/__tests__/behavioral/upgrading/UpgradingASkill4.test.ts

@@ -1,13 +1,13 @@
 import fsUtil from 'fs'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { test, assert } from '@sprucelabs/test-utils'
-import CommandService from '../../../services/CommandService'
+import CommandServiceImpl from '../../../services/CommandService'
 import AbstractCliTest from '../../../tests/AbstractCliTest'
 
 export default class UpgradingASkill4Test extends AbstractCliTest {
     protected static async beforeEach() {
         await super.beforeEach()
-        CommandService.fakeCommand(new RegExp(/rebuild/gis), {
+        CommandServiceImpl.fakeCommand(new RegExp(/rebuild/gis), {
             code: 0,
         })
     }
@@ -49,8 +49,8 @@ export default class UpgradingASkill4Test extends AbstractCliTest {
             }
         }
 
-        CommandService.fakeCommand(/yarn clean/, { code: 0 })
-        CommandService.fakeCommand(/yarn build.dev/, { code: 0 })
+        CommandServiceImpl.fakeCommand(/yarn clean/, { code: 0 })
+        CommandServiceImpl.fakeCommand(/yarn build.dev/, { code: 0 })
 
         await this.Action('node', 'upgrade').execute({})
 

package/src/__tests__/behavioral/upgrading/UpgradingASkill5.test.ts

@@ -2,7 +2,7 @@ import { Schema } from '@sprucelabs/schema'
 import { test, assert } from '@sprucelabs/test-utils'
 import ActionFactory from '../../../features/ActionFactory'
 import { FeatureAction } from '../../../features/features.types'
-import CommandService from '../../../services/CommandService'
+import CommandServiceImpl from '../../../services/CommandService'
 import LintService from '../../../services/LintService'
 import ServiceFactory from '../../../services/ServiceFactory'
 import AbstractCliTest from '../../../tests/AbstractCliTest'
@@ -50,7 +50,7 @@ export default class UpgradingASkill5Test extends AbstractCliTest {
     ) {
         await this.FeatureFixture().installCachedFeatures('schemas')
 
-        CommandService.fakeCommand(new RegExp(/yarn/gis), {
+        CommandServiceImpl.fakeCommand(new RegExp(/yarn/gis), {
             code: 0,
         })
 
@@ -93,7 +93,7 @@ export default class UpgradingASkill5Test extends AbstractCliTest {
         let wasMovedBackToDev = false
         let wasMovedBackToProd = false
 
-        CommandService.fakeCommand(new RegExp(/yarn/gis), {
+        CommandServiceImpl.fakeCommand(new RegExp(/yarn/gis), {
             code: 0,
             callback: (_, args) => {
                 if (
@@ -126,7 +126,7 @@ export default class UpgradingASkill5Test extends AbstractCliTest {
 
         ServiceFactory.setFactoryClass('lint', SpyLintService)
 
-        CommandService.fakeCommand(/.*/gi, {
+        CommandServiceImpl.fakeCommand(/.*/gi, {
             code: 0,
             callback: (command, args) => {
                 this.invocationLog.push([command, ...args].join(' '))

package/src/__tests__/behavioral/views/WatchingSkillViews.test.ts

@@ -1,6 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import WatchAction from '../../../features/view/actions/WatchAction'
-import CommandService from '../../../services/CommandService'
+import CommandServiceImpl from '../../../services/CommandService'
 import AbstractSkillTest from '../../../tests/AbstractSkillTest'
 
 export default class WatchingSkillViewsTest extends AbstractSkillTest {
@@ -21,7 +21,7 @@ export default class WatchingSkillViewsTest extends AbstractSkillTest {
     @test()
     protected static async shouldCallBoot() {
         let wasHit = false
-        CommandService.fakeCommand(
+        CommandServiceImpl.fakeCommand(
             'SHOULD_WATCH_VIEWS=true MAXIMUM_LOG_PREFIXES_LENGTH=0 yarn boot',
             {
                 code: 200,

package/src/__tests__/implementation/ActionExecuter2.test.ts

@@ -5,7 +5,7 @@ import {
     FeatureActionResponse,
     FeatureInstallResponse,
 } from '../../features/features.types'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import AbstractSchemaTest from '../../tests/AbstractSchemaTest'
 import testUtil from '../../tests/utilities/test.utility'
 
@@ -273,7 +273,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
     }
 
     private static fakeInstallCommands() {
-        CommandService.fakeCommand(new RegExp(/yarn|npm/gis), {
+        CommandServiceImpl.fakeCommand(new RegExp(/yarn|npm/gis), {
             code: 0,
         })
     }

package/src/__tests__/implementation/ActionExecuter4.test.ts

@@ -1,17 +1,17 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import { errorAssert } from '@sprucelabs/test-utils'
 import { ENABLE_NPM_CACHE_COMMAND } from '../../features/cache/constants'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class ActionExecuter4Test extends AbstractCliTest {
     protected static async beforeEach() {
         await super.beforeEach()
 
-        CommandService.fakeCommand(/which docker/gis, {
+        CommandServiceImpl.fakeCommand(/which docker/gis, {
             code: 0,
         })
-        CommandService.fakeCommand(ENABLE_NPM_CACHE_COMMAND, {
+        CommandServiceImpl.fakeCommand(ENABLE_NPM_CACHE_COMMAND, {
             code: 0,
         })
     }

package/src/__tests__/implementation/FeatureInstaller.test.ts

@@ -1,6 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import FeatureInstaller from '../../features/FeatureInstaller'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class FeatureInstallerTest extends AbstractCliTest {
@@ -28,7 +28,7 @@ export default class FeatureInstallerTest extends AbstractCliTest {
 
     @test()
     protected static async afterPackageInstallIsCalledOncePerFeature() {
-        CommandService.fakeCommand(/yarn/, {
+        CommandServiceImpl.fakeCommand(/yarn/, {
             code: 0,
         })
 

package/src/__tests__/implementation/PkgService.test.ts

@@ -1,6 +1,6 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { test, assert } from '@sprucelabs/test-utils'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import PkgService from '../../services/PkgService'
 import AbstractSkillTest from '../../tests/AbstractSkillTest'
 
@@ -26,7 +26,7 @@ export default class PkgServiceTest extends AbstractSkillTest {
 
     @test()
     protected static async handlesAtLatestInName() {
-        CommandService.fakeCommand(new RegExp(/yarn/gis), {
+        CommandServiceImpl.fakeCommand(new RegExp(/yarn/gis), {
             code: 0,
         })
 
@@ -37,7 +37,7 @@ export default class PkgServiceTest extends AbstractSkillTest {
 
     @test()
     protected static async ifInstallingOnlySpruceModulesShouldNotRunNPMAdd() {
-        CommandService.fakeCommand(
+        CommandServiceImpl.fakeCommand(
             new RegExp(/npm.*?install.*?--no-progress/gis),
             {
                 code: 1,

package/src/__tests__/implementation/StoreFeature.test.ts

@@ -1,5 +1,5 @@
 import { test, assert } from '@sprucelabs/test-utils'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class StoreFeatureTest extends AbstractCliTest {
@@ -7,7 +7,7 @@ export default class StoreFeatureTest extends AbstractCliTest {
     protected static async syncsOnWillExecute() {
         await this.FeatureFixture().installCachedFeatures('stores')
 
-        CommandService.fakeCommand(/yarn/, {
+        CommandServiceImpl.fakeCommand(/yarn/, {
             code: 0,
         })
 

package/src/boot.ts

@@ -7,7 +7,7 @@ import { CLI_HERO } from './constants'
 import { FeatureInstallerImpl } from './features/FeatureInstaller'
 import InFlightEntertainment from './InFlightEntertainment'
 import TerminalInterface from './interfaces/TerminalInterface'
-import CommandService from './services/CommandService'
+import CommandServiceImpl from './services/CommandService'
 
 export async function run(argv: string[] = []): Promise<void> {
     const program = new Command()
@@ -73,7 +73,7 @@ async function setupInFlightEntertainment(ui: TerminalInterface) {
         TerminalInterface.doesSupportColor() &&
         process.env.ENABLE_INSTALL_ENTERTAINMENT !== 'false'
     ) {
-        const command = new CommandService(
+        const command = new CommandServiceImpl(
             diskUtil.resolvePath(__dirname, '../')
         )
         InFlightEntertainment.setup({ command, ui })

package/src/features/skill/actions/BootAction.ts

@@ -1,7 +1,7 @@
 import { SpruceSchemas } from '#spruce/schemas/schemas.types'
 import bootSkillOptionsSchema from '#spruce/schemas/spruceCli/v2020_07_22/bootSkillOptions.schema'
 import SpruceError from '../../../errors/SpruceError'
-import CommandService from '../../../services/CommandService'
+import CommandServiceImpl from '../../../services/CommandService'
 import AbstractAction from '../../AbstractAction'
 import { FeatureActionResponse } from '../../features.types'
 
@@ -64,7 +64,7 @@ export default class BootAction extends AbstractAction<OptionsSchema> {
     }
 
     private async boot(
-        command: CommandService,
+        command: CommandServiceImpl,
         script: string,
         resolve: (value: unknown) => void,
         reject: (reason?: any) => void

package/src/features/test/TestRunner.ts

@@ -7,19 +7,19 @@ import {
 import { buildSchema } from '@sprucelabs/schema'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import SpruceError from '../../errors/SpruceError'
-import CommandService from '../../services/CommandService'
+import CommandServiceImpl from '../../services/CommandService'
 import JestJsonParser from '../../tests/JestJsonParser'
 import { SpruceTestResults } from './test.types'
 
 export default class TestRunner extends AbstractEventEmitter<TestRunnerContract> {
     private cwd: string
-    private commandService: CommandService
+    private commandService: CommandServiceImpl
     private wasKilled = false
     private testResults: SpruceTestResults = { totalTestFiles: 0 }
 
     public constructor(options: {
         cwd: string
-        commandService: CommandService
+        commandService: CommandServiceImpl
     }) {
         super(testRunnerContract)
         this.cwd = options.cwd

package/src/features/test/actions/MigrateAction.ts

@@ -14,11 +14,14 @@ export default class MigrationAction extends AbstractAction<OptionsSchema> {
     public async execute(): Promise<FeatureActionResponse> {
         const testFinder = StaticTestFinderImpl.Finder()
         const testFileMigrator = StaticToInstanceTestFileMigratorImpl.Migrator()
+        const lintService = this.Service('lint')
         const migrator = StaticToInstanceMigratorImpl.Migrator({
             testFinder,
             testFileMigrator,
+            lintService,
         })
 
+        this.ui.startLoading('Migrating tests...')
         const path = diskUtil.resolvePath(this.cwd, 'src', '__tests__')
         const { totalTestsSkipped, totalTestsUpdated } =
             await migrator.run(path)

package/src/features/vscode/services/VsCodeService.ts

@@ -1,7 +1,7 @@
 import semver from 'semver'
-import CommandService from '../../../services/CommandService'
+import CommandServiceImpl from '../../../services/CommandService'
 
-export default class VsCodeService extends CommandService {
+export default class VsCodeService extends CommandServiceImpl {
     /** Returns whether or not vscode is installed */
     public async isInstalled(): Promise<boolean> {
         const isInstalled = false

package/src/services/BuildService.ts

@@ -1,4 +1,4 @@
-import CommandService from './CommandService'
+import CommandServiceImpl from './CommandService'
 import LintService from './LintService'
 
 export default class BuildService {
@@ -10,11 +10,11 @@ export default class BuildService {
         return this.commandService.cwd
     }
 
-    private commandService: CommandService
+    private commandService: CommandServiceImpl
     private lintService: LintService
 
     public constructor(
-        commandService: CommandService,
+        commandService: CommandServiceImpl,
         lintService: LintService
     ) {
         this.commandService = commandService

package/src/services/CommandService.ts

@@ -9,7 +9,7 @@ import SpruceError from '../errors/SpruceError'
 
 process.setMaxListeners(100)
 
-export default class CommandService {
+export default class CommandServiceImpl implements CommandService {
     public cwd: string
     private activeChildProcess: ChildProcess | undefined
     private ignoreCloseErrors = false
@@ -25,17 +25,7 @@ export default class CommandService {
 
     public async execute(
         cmd: string,
-        options?: {
-            ignoreErrors?: boolean
-            args?: string[]
-            shouldStream?: boolean
-            outStream?: Writable
-            onError?: (error: string) => void
-            onData?: (data: string) => void
-            spawnOptions?: SpawnOptions
-            forceColor?: boolean
-            env?: Record<string, any>
-        }
+        options?: ExecuteCommandOptions
     ): Promise<{
         stdout: string
     }> {
@@ -51,7 +41,7 @@ export default class CommandService {
         const { mockResponse, mockKey } = this.getMockResponse(executable, args)
 
         if (mockResponse) {
-            CommandService.commandsRunCapturedByMockResponses.push(mockKey)
+            CommandServiceImpl.commandsRunCapturedByMockResponses.push(mockKey)
             mockResponse.callback?.(executable, args)
 
             if (mockResponse.code !== 0) {
@@ -174,7 +164,7 @@ export default class CommandService {
 
     private getMockResponse(executable: string, args: string[]) {
         const mockKey = `${executable} ${args.join(' ')}`.trim()
-        const commands = CommandService.fakeResponses
+        const commands = CommandServiceImpl.fakeResponses
         const match = commands.find((r) =>
             r.command instanceof RegExp
                 ? mockKey.search(r.command) > -1
@@ -208,3 +198,26 @@ interface FakedCommandResponse {
     stderr?: string
     callback?: FakedCommandCallback
 }
+
+export interface CommandService {
+    execute(
+        cmd: string,
+        options?: ExecuteCommandOptions
+    ): Promise<{
+        stdout: string
+    }>
+    kill(): void
+    pid(): number | undefined
+}
+
+export interface ExecuteCommandOptions {
+    ignoreErrors?: boolean
+    args?: string[]
+    shouldStream?: boolean
+    outStream?: Writable
+    onError?: (error: string) => void
+    onData?: (data: string) => void
+    spawnOptions?: SpawnOptions
+    forceColor?: boolean
+    env?: Record<string, any>
+}

package/src/services/GameService.ts

@@ -1,14 +1,14 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import TerminalInterface from '../interfaces/TerminalInterface'
-import CommandService from './CommandService'
+import CommandServiceImpl from './CommandService'
 
 export default class GameService {
-    private command: CommandService
+    private command: CommandServiceImpl
     private ui: TerminalInterface
     private statusMessage?: string
     private killed = false
 
-    public constructor(command: CommandService, ui: TerminalInterface) {
+    public constructor(command: CommandServiceImpl, ui: TerminalInterface) {
         this.command = command
         this.ui = ui
         this.command.cwd = diskUtil.resolvePath(__dirname, '../../')

package/src/services/ImportService.ts

@@ -3,7 +3,7 @@ import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import fs from 'fs-extra'
 import md5 from 'md5'
 import SpruceError from '../errors/SpruceError'
-import CommandService from './CommandService'
+import CommandServiceImpl from './CommandService'
 
 export default class ImportService {
     public cwd: string
@@ -14,10 +14,10 @@ export default class ImportService {
     private static cachedImports: Record<string, Record<string, any>> = {}
     private static importCacheDir: string =
         diskUtil.createTempDir('import-service')
-    private command: CommandService
+    private command: CommandServiceImpl
     private static isCachingEnabled: boolean
 
-    public constructor(options: { cwd: string; command: CommandService }) {
+    public constructor(options: { cwd: string; command: CommandServiceImpl }) {
         this.cwd = options.cwd
         this.command = options.command
     }

package/src/services/LintService.ts

@@ -2,7 +2,7 @@ import { SchemaError } from '@sprucelabs/schema'
 // import { ESLint } from 'eslint'
 // import fs from 'fs-extra'
 import SpruceError from '../errors/SpruceError'
-import CommandService from './CommandService'
+import { CommandService } from './CommandService'
 
 export default class LintService {
     public cwd: string

package/src/services/PkgService.ts

@@ -4,12 +4,12 @@ import {
     PkgService as BasePkgService,
 } from '@sprucelabs/spruce-skill-utils'
 import isCi from '../utilities/isCi'
-import CommandService from './CommandService'
+import CommandServiceImpl from './CommandService'
 
 export default class PkgService extends BasePkgService {
-    private commandService: CommandService
+    private commandService: CommandServiceImpl
 
-    public constructor(cwd: string, commandService: CommandService) {
+    public constructor(cwd: string, commandService: CommandServiceImpl) {
         super(cwd)
         this.commandService = commandService
     }

package/src/services/ServiceFactory.ts

@@ -9,7 +9,7 @@ import { FeatureCode } from '../features/features.types'
 import SchemaService from '../features/schema/services/SchemaService'
 import VsCodeService from '../features/vscode/services/VsCodeService'
 import BuildService from './BuildService'
-import CommandService from './CommandService'
+import CommandServiceImpl from './CommandService'
 import DependencyService from './DependencyService'
 import ImportService from './ImportService'
 import LintService from './LintService'
@@ -41,14 +41,14 @@ export default class ServiceFactory {
             case 'schema':
                 return new SchemaService({
                     cwd,
-                    command: new CommandService(cwd),
+                    command: new CommandServiceImpl(cwd),
                 }) as ServiceMap[S]
             case 'lint':
                 return new (Class ?? LintService)(cwd, () =>
                     this.Service(cwd, 'command')
                 ) as ServiceMap[S]
             case 'command': {
-                return new CommandService(cwd) as ServiceMap[S]
+                return new CommandServiceImpl(cwd) as ServiceMap[S]
             }
             case 'remote':
                 return new RemoteService(new EnvService(cwd)) as ServiceMap[S]
@@ -68,7 +68,7 @@ export default class ServiceFactory {
             case 'import':
                 return this.buildImportService(cwd) as ServiceMap[S]
             case 'build': {
-                const commandService = new CommandService(cwd)
+                const commandService = new CommandServiceImpl(cwd)
                 return new BuildService(
                     commandService,
                     this.Service(cwd, 'lint')
@@ -86,7 +86,7 @@ export default class ServiceFactory {
     private buildImportService(cwd: string): ImportService {
         return new ImportService({
             cwd,
-            command: new CommandService(cwd),
+            command: new CommandServiceImpl(cwd),
         })
     }
 
@@ -104,7 +104,7 @@ export interface ServiceMap {
     vsCode: VsCodeService
     schema: SchemaService
     lint: LintService
-    command: CommandService
+    command: CommandServiceImpl
     typeChecker: TypeCheckerService
     import: ImportService
     build: BuildService

package/src/tests/AbstractCliTest.ts

@@ -22,7 +22,7 @@ import OnboardingStore from '../features/onboard/stores/OnboardingStore'
 import SkillStore from '../features/skill/stores/SkillStore'
 import CliGlobalEmitter, { GlobalEmitter } from '../GlobalEmitter'
 import SpyInterface from '../interfaces/SpyInterface'
-import CommandService from '../services/CommandService'
+import CommandServiceImpl from '../services/CommandService'
 import ImportService from '../services/ImportService'
 import LintService from '../services/LintService'
 import ServiceFactory, { Service, ServiceMap } from '../services/ServiceFactory'
@@ -114,7 +114,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
         ImportService.clearCache()
         SkillStore.clearCurrentSkill()
         EventStore.clearCache()
-        CommandService.clearFakedResponses()
+        CommandServiceImpl.clearFakedResponses()
         MercuryClientFactory.reset()
         MercuryClientFactory.setIsTestMode(false)
 

package/src/tests/CommandFaker.ts

@@ -1,24 +1,24 @@
 import { assert } from '@sprucelabs/test-utils'
-import CommandService from '../services/CommandService'
+import CommandServiceImpl from '../services/CommandService'
 
 type Command = RegExp | string
 
 export default class CommandFaker {
     public fakeCommand(command: Command, code = 0) {
-        CommandService.fakeCommand(command, {
+        CommandServiceImpl.fakeCommand(command, {
             code,
         })
     }
 
     public on(command: Command, cb: () => void) {
-        CommandService.fakeCommand(command, {
+        CommandServiceImpl.fakeCommand(command, {
             code: 0,
             callback: cb,
         })
     }
 
     public makeCommandThrow(command: Command) {
-        CommandService.fakeCommand(command, {
+        CommandServiceImpl.fakeCommand(command, {
             code: 1,
             callback: () =>
                 assert.fail(`${command} should not have been called`),

package/src/tests/staticToInstanceMigration/StaticToInstanceMigrator.ts

@@ -1,5 +1,6 @@
 import { assertOptions } from '@sprucelabs/schema'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import LintService from '../../services/LintService'
 import StaticTestFinder from './StaticTestFinder'
 import { StaticToInstanceTestFileMigrator } from './StaticToInstanceTestFileMigrator'
 
@@ -13,15 +14,21 @@ export default class StaticToInstanceMigratorImpl
 
     private testFinder: StaticTestFinder
     private testFileMigrator: StaticToInstanceTestFileMigrator
+    private lintService: LintService
 
     protected constructor(options: StaticToInstanceMigratorOptions) {
-        const { testFinder, testFileMigrator } = options
+        const { testFinder, testFileMigrator, lintService } = options
         this.testFinder = testFinder
         this.testFileMigrator = testFileMigrator
+        this.lintService = lintService
     }
 
     public static Migrator(options: StaticToInstanceMigratorOptions) {
-        assertOptions(options, ['testFinder', 'testFileMigrator'])
+        assertOptions(options, [
+            'testFinder',
+            'testFileMigrator',
+            'lintService',
+        ])
         return new (this.Class ?? this)(options)
     }
 
@@ -43,6 +50,8 @@ export default class StaticToInstanceMigratorImpl
             }
         }
 
+        await this.lintService.fix('**/*.ts')
+
         return {
             totalTestsUpdated,
             totalTestsSkipped,
@@ -61,6 +70,7 @@ export default class StaticToInstanceMigratorImpl
 export interface StaticToInstanceMigratorOptions {
     testFinder: StaticTestFinder
     testFileMigrator: StaticToInstanceTestFileMigrator
+    lintService: LintService
 }
 
 export interface StaticToInstanceMigratorResults {