@sprucelabs/spruce-cli 28.2.3 → 29.0.0

package/src/features/test/TestReporter.ts

@@ -54,7 +54,7 @@ export default class TestReporter {
     private minWidth = 50
     private isRpTraining: boolean
     private trainingTokenPopup?: PopupWidget
-    private shouldStripCwdFromErrors = false
+    private shouldStripCwdFromErrors = true
     // private orientationWhenErrorLogWasShown: TestReporterOrientation =
     // 'landscape'
 

package/src/features/view/ViewFeature.ts

@@ -9,7 +9,7 @@ export default class ViewFeature extends AbstractFeature {
     public code: FeatureCode = 'view'
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 
-    public readonly packageDependencies: NpmPackage[] = [
+    public readonly _packageDependencies: NpmPackage[] = [
         {
             name: '@sprucelabs/heartwood-view-controllers@latest',
         },

package/src/packageManager/NodePackageManager.ts

@@ -0,0 +1,115 @@
+import pathUtil from 'path'
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import { CommandService } from '../services/CommandService'
+import PkgService, { AddOptions } from '../services/PkgService'
+import isCi from '../utilities/isCi'
+import {
+    PackageManager,
+    PackageManagerConstructorOptions,
+} from './packageManager.types'
+
+export default class NodePackageManager implements PackageManager {
+    private pkgService: PkgService
+    private cwd: string
+    private commandService: CommandService
+
+    public constructor(options: PackageManagerConstructorOptions) {
+        const { pkgService, commandService, cwd } = options
+        this.pkgService = pkgService
+        this.commandService = commandService
+        this.cwd = cwd
+    }
+
+    public async installDependencies(
+        pkg?: string[] | string,
+        options?: AddOptions
+    ) {
+        const shouldCleanupLockFiles = options?.shouldCleanupLockFiles !== false
+        const deleteLockFile = shouldCleanupLockFiles
+            ? () => this.pkgService.deleteLockFile()
+            : () => {}
+
+        if (!pkg) {
+            await this.commandService.execute('yarn', { args: ['install'] })
+            deleteLockFile()
+            return { totalInstalled: -1, totalSkipped: -1 }
+        }
+
+        deleteLockFile()
+
+        const packages = Array.isArray(pkg) ? pkg : [pkg]
+        const toInstall = []
+        const labsModules: string[] = []
+
+        let totalInstalled = 0
+        let totalSkipped = 0
+
+        for (const thisPackage of packages) {
+            const isInstalled =
+                !options?.shouldForceInstall &&
+                this.pkgService.isInstalled(thisPackage)
+            if (thisPackage.startsWith('@sprucelabs/') || !isInstalled) {
+                toInstall.push(this.pkgService.stripLatest(thisPackage))
+                totalInstalled++
+            } else {
+                totalSkipped++
+            }
+        }
+
+        if (totalInstalled > 0) {
+            const { executable, args } = this.buildCommandAndArgs(
+                toInstall,
+                options
+            )
+
+            const isInWorkspace = this.pkgService.get('workspaces')?.length > 0
+            if (isInWorkspace) {
+                args.push('-W')
+            }
+
+            await this.commandService.execute(executable, {
+                args,
+            })
+        } else if (
+            !diskUtil.doesDirExist(pathUtil.join(this.cwd, 'node_modules'))
+        ) {
+            await this.commandService.execute('yarn', { args: ['install'] })
+        }
+
+        deleteLockFile()
+
+        return {
+            totalInstalled: totalInstalled + labsModules.length,
+            totalSkipped,
+        }
+    }
+
+    public async uninstallDependencies(pkg: string[] | string) {
+        const packages = Array.isArray(pkg) ? pkg : [pkg]
+        const args: string[] = ['uninstall', ...packages]
+        await this.commandService.execute('npm', {
+            args,
+        })
+
+        await this.installDependencies()
+    }
+
+    private buildCommandAndArgs(
+        toInstall: string[],
+        options: AddOptions | undefined
+    ) {
+        const args: any[] = [
+            isCi() && '--cache-folder',
+            isCi() && diskUtil.createRandomTempDir(),
+            'add',
+            ...toInstall,
+        ].filter((a) => !!a)
+
+        if (options?.isDev) {
+            args.push('-D')
+        }
+
+        const executable = 'yarn'
+        return { executable, args }
+    }
+}

package/src/packageManager/packageManager.types.ts

@@ -0,0 +1,21 @@
+import { CommandService } from '../services/CommandService'
+import PkgService, { AddOptions } from '../services/PkgService'
+
+export interface PackageManager {
+    installDependencies(
+        pkg?: string[] | string,
+        options?: AddOptions
+    ): Promise<{
+        totalInstalled: number
+        totalSkipped: number
+    }>
+    uninstallDependencies?(dependencies: string[] | string): Promise<void>
+    isInstalled?(pkg: string): boolean
+    deleteLockFile?(): void
+}
+
+export interface PackageManagerConstructorOptions {
+    pkgService: PkgService
+    commandService: CommandService
+    cwd: string
+}

package/src/services/GoPackageManager.ts

@@ -0,0 +1,45 @@
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import {
+    PackageManager,
+    PackageManagerConstructorOptions,
+} from '../packageManager/packageManager.types'
+import { CommandService } from './CommandService'
+
+export class GoPackageManager implements PackageManager {
+    private commandService: CommandService
+    public constructor(options: PackageManagerConstructorOptions) {
+        const { commandService } = options
+        this.commandService = commandService
+    }
+
+    public async installDependencies(pkg?: string[] | string) {
+        const first = Array.isArray(pkg) ? pkg[0] : pkg
+        if (first) {
+            await this.commandService.execute('go', {
+                args: ['get', first],
+                env: this.buildEnv(),
+            })
+            return {
+                totalInstalled: 1,
+                totalSkipped: 0,
+            }
+        }
+
+        return {
+            totalInstalled: 0,
+            totalSkipped: 0,
+        }
+    }
+
+    private buildEnv() {
+        const cwd = this.commandService.getCwd()
+        const goCacheDir = diskUtil.resolvePath(cwd, '.go-cache')
+
+        diskUtil.createDir(goCacheDir)
+
+        return {
+            HOME: process.env.HOME ?? cwd,
+            GOCACHE: process.env.GOCACHE ?? goCacheDir,
+        }
+    }
+}

package/src/services/PkgService.ts

@@ -1,114 +1,39 @@
-import pathUtil from 'path'
 import {
     diskUtil,
     PkgService as BasePkgService,
 } from '@sprucelabs/spruce-skill-utils'
-import isCi from '../utilities/isCi'
+import NodePackageManager from '../packageManager/NodePackageManager'
+import { PackageManager } from '../packageManager/packageManager.types'
 import CommandServiceImpl from './CommandService'
+import { GoPackageManager } from './GoPackageManager'
 
 export default class PkgService extends BasePkgService {
-    private commandService: CommandServiceImpl
+    private packageManager: PackageManager
 
     public constructor(cwd: string, commandService: CommandServiceImpl) {
         super(cwd)
-        this.commandService = commandService
+        const PackageManagerClass =
+            diskUtil.detectProjectLanguage(cwd) === 'go'
+                ? GoPackageManager
+                : NodePackageManager
+
+        this.packageManager = new PackageManagerClass({
+            cwd,
+            commandService,
+            pkgService: this,
+        })
     }
 
     public async install(pkg?: string[] | string, options?: AddOptions) {
-        const shouldCleanupLockFiles = options?.shouldCleanupLockFiles !== false
-        const deleteLockFile = shouldCleanupLockFiles
-            ? this.deleteLockFile.bind(this)
-            : () => {}
-
-        if (!pkg) {
-            await this.commandService.execute('yarn', { args: ['install'] })
-            deleteLockFile()
-            return { totalInstalled: -1, totalSkipped: -1 }
-        }
-
-        deleteLockFile()
-
-        const packages = Array.isArray(pkg) ? pkg : [pkg]
-        const toInstall = []
-        const labsModules: string[] = []
-
-        let totalInstalled = 0
-        let totalSkipped = 0
-
-        for (const thisPackage of packages) {
-            const isInstalled =
-                !options?.shouldForceInstall && this.isInstalled(thisPackage)
-            if (thisPackage.startsWith('@sprucelabs/') || !isInstalled) {
-                toInstall.push(this.stripLatest(thisPackage))
-                totalInstalled++
-            } else {
-                totalSkipped++
-            }
-        }
-
-        if (totalInstalled > 0) {
-            const { executable, args } = PkgService.buildCommandAndArgs(
-                toInstall,
-                options
-            )
-
-            const isInWorkspace = this.get('workspaces')?.length > 0
-            if (isInWorkspace) {
-                args.push('-W')
-            }
-
-            await this.commandService.execute(executable, {
-                args,
-            })
-        } else if (
-            !diskUtil.doesDirExist(pathUtil.join(this.cwd, 'node_modules'))
-        ) {
-            await this.commandService.execute('yarn', { args: ['install'] })
-        }
-
-        deleteLockFile()
-
-        this._parsedPkg = undefined
-
-        return {
-            totalInstalled: totalInstalled + labsModules.length,
-            totalSkipped,
-        }
-    }
-
-    public static buildCommandAndArgs(
-        toInstall: string[],
-        options: AddOptions | undefined
-    ) {
-        const args: any[] = [
-            isCi() && '--cache-folder',
-            isCi() && diskUtil.createRandomTempDir(),
-            'add',
-            ...toInstall,
-        ].filter((a) => !!a)
-
-        if (options?.isDev) {
-            args.push('-D')
-        }
-
-        const executable = 'yarn'
-        return { executable, args }
+        return this.packageManager.installDependencies(pkg, options)
     }
 
     public getSkillNamespace() {
-        return this.get('skill.namespace')
+        return this.get('skill.namespace') as string
     }
 
     public async uninstall(pkg: string[] | string) {
-        const packages = Array.isArray(pkg) ? pkg : [pkg]
-        const args: string[] = ['uninstall', ...packages]
-        await this.commandService.execute('npm', {
-            args,
-        })
-
-        this._parsedPkg = undefined
-
-        await this.install()
+        return this.packageManager.uninstallDependencies?.(pkg)
     }
 }
 

package/src/templateItemBuilders/SchemaTemplateItemBuilder.ts

@@ -14,12 +14,6 @@ import SpruceError from '../errors/SpruceError'
 import { SchemasByNamespace } from '../features/schema/stores/SchemaStore'
 import schemaUtil from '../features/schema/utilities/schema.utility'
 
-interface SchemaWithDependencies {
-    schema: Schema
-    dependencies: SchemaIdWithVersion[]
-    isNested: boolean
-}
-
 export default class SchemaTemplateItemBuilder {
     private schemasByKey: Record<string, SchemaWithDependencies> = {}
     private localNamespace: string
@@ -251,3 +245,9 @@ export default class SchemaTemplateItemBuilder {
         return undefined
     }
 }
+
+interface SchemaWithDependencies {
+    schema: Schema
+    dependencies: SchemaIdWithVersion[]
+    isNested: boolean
+}

package/src/tests/AbstractCliTest.ts

@@ -38,6 +38,7 @@ import CommandFaker from './CommandFaker'
 import FeatureFixture, {
     FeatureFixtureOptions,
 } from './fixtures/FeatureFixture'
+import GoFixture from './fixtures/GoFixture'
 import MercuryFixture from './fixtures/MercuryFixture'
 import OrganizationFixture from './fixtures/OrganizationFixture'
 import PersonFixture from './fixtures/PersonFixture'
@@ -58,6 +59,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
     private static skillFixture?: SkillFixture
     private static _featureInstaller?: FeatureInstaller
     private static viewFixture?: ViewFixture
+    private static goFixture?: GoFixture
     private static originalEnv: Record<string, string | undefined>
     private static _writers?: WriterFactory
     protected static eventFaker: EventFaker
@@ -99,16 +101,13 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 
         AuthService.homeDir = this.homeDir
 
-        this._emitter = undefined
-        this._featureInstaller = undefined
-
         OnboardingStore.overrideCwd(diskUtil.createRandomTempDir())
 
         this.ui.reset()
         this.ui.invocations = []
         this.ui.setCursorPosition({ x: 0, y: 0 })
 
-        this.clearFixtures()
+        this.setCwd(this.cwd)
 
         ImportService.clearCache()
         SkillStoreImpl.clearCurrentSkill()
@@ -166,13 +165,20 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
         }
     }
 
-    private static clearFixtures() {
+    protected static clearFixtures() {
+        this._featureInstaller = undefined
         this._emitter = undefined
         this.mercuryFixture = undefined
         this.organizationFixture = undefined
         this.personFixture = undefined
         this.skillFixture = undefined
         this.viewFixture = undefined
+        this.goFixture = undefined
+    }
+
+    protected static setCwd(cwd: string) {
+        this.clearFixtures()
+        this.cwd = cwd
     }
 
     protected static freshTmpDir() {
@@ -267,6 +273,14 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
         return this.personFixture
     }
 
+    protected static get go() {
+        if (!this.goFixture) {
+            this.goFixture = new GoFixture(this.Service('command'))
+        }
+
+        return this.goFixture
+    }
+
     protected static getViewFixture() {
         if (!this.viewFixture) {
             const viewWriter = this.writers.Writer('view', {

package/src/tests/fixtures/FeatureFixture.ts

@@ -47,7 +47,9 @@ export default class FeatureFixture implements ServiceProvider {
 
     public static deleteOldSkillDirs() {
         for (const dir of this.dirsToDelete) {
-            diskUtil.deleteDir(dir)
+            try {
+                diskUtil.deleteDir(dir)
+            } catch {}
         }
 
         this.dirsToDelete = []

package/src/tests/fixtures/GoFixture.ts

@@ -0,0 +1,39 @@
+import os from 'os'
+import { generateId } from '@sprucelabs/test-utils'
+import { CommandService } from '../../services/CommandService'
+
+export default class GoFixture {
+    private cmdService: CommandService
+    public constructor(cmdService: CommandService) {
+        this.cmdService = cmdService
+    }
+
+    public async initGoProject(name?: string) {
+        const moduleName = `github.com/${generateId()}/${name ?? generateId()}`
+        await this.cmdService.execute(`go mod init ${moduleName}`, {
+            env: this.buildEnv(),
+        })
+        return moduleName
+    }
+
+    public setCwd(dir: string) {
+        this.cmdService.setCwd(dir)
+    }
+
+    public async exec(command: string, arg1: string) {
+        return this.cmdService.execute(`go`, {
+            args: [command, arg1],
+            env: this.buildEnv(),
+        })
+    }
+
+    private buildEnv() {
+        return {
+            HOME: os.homedir(),
+        }
+    }
+
+    public async vet() {
+        await this.exec('vet', './...')
+    }
+}

package/src/widgets/terminalKit/TkTextWidget.ts

@@ -154,7 +154,7 @@ export default class TkTextWidget extends TkBaseWidget implements TextWidget {
             return segment
         }
 
-        if ('{}[]'.includes(segment)) {
+        if ('{}[]()'.includes(segment)) {
             // Terminal-kit drops single-character chunks when parsing ANSI
             // sequences, so pad with a zero-width space to keep braces visible.
             return `${segment}​`

package/src/writers/AbstractWriter.ts

@@ -24,12 +24,21 @@ export default abstract class AbstractWriter {
     protected isLintEnabled = true
 
     public constructor(options: WriterOptions) {
-        this.templates = options.templates
-        this.ui = options.term
-        this.upgradeMode = options.upgradeMode
-        this.fileDescriptions = options.fileDescriptions
-        this.linter = options.linter
-        this.settings = options.settings
+        const {
+            templates,
+            term,
+            upgradeMode,
+            fileDescriptions,
+            linter,
+            settings,
+        } = options
+
+        this.templates = templates
+        this.ui = term
+        this.upgradeMode = upgradeMode
+        this.fileDescriptions = fileDescriptions
+        this.linter = linter
+        this.settings = settings
     }
 
     protected async lint(file: string) {