@sprucelabs/spruce-cli 28.2.2 → 29.0.0

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

@@ -1,6 +1,8 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import { random, uniq } from 'lodash'
+import FeatureInstallerFactory from '../../../features/FeatureInstallerFactory'
 import UpdateDependenciesAction from '../../../features/node/actions/UpdateDependenciesAction'
+import SkillFeature from '../../../features/skill/SkillFeature'
 import CommandServiceImpl from '../../../services/CommandService'
 import AbstractCliTest from '../../../tests/AbstractCliTest'
 import { NpmPackage } from '../../../types/cli.types'
@@ -10,6 +12,7 @@ export default class UpdateDependencies2Test extends AbstractCliTest {
 
     protected static async beforeEach() {
         await super.beforeEach()
+        FeatureInstallerFactory.setFeature('skill', SpySkillFeature)
         this.action = this.Action('node', 'updateDependencies')
     }
 
@@ -19,8 +22,12 @@ export default class UpdateDependencies2Test extends AbstractCliTest {
 
         this.Service('pkg').set({ path: 'dependencies.axios', value: '0.0.1' })
 
-        const skill = this.featureInstaller.getFeature('skill')
-        skill.packageDependencies.push({
+        debugger
+        const skill = this.featureInstaller.getFeature(
+            'skill'
+        ) as SpySkillFeature
+
+        skill.addPackageDependency({
             name: 'axios',
             version: '0.21.3',
         })
@@ -141,3 +148,9 @@ export default class UpdateDependencies2Test extends AbstractCliTest {
         return name
     }
 }
+
+class SpySkillFeature extends SkillFeature {
+    public addPackageDependency(dependency: NpmPackage) {
+        this._packageDependencies.push(dependency)
+    }
+}

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

@@ -1,4 +1,5 @@
-import { test, assert } from '@sprucelabs/test-utils'
+import { diskUtil, namesUtil, randomUtil } from '@sprucelabs/spruce-skill-utils'
+import { test, assert, generateId } from '@sprucelabs/test-utils'
 import { errorAssert } from '@sprucelabs/test-utils'
 import SkillStoreImpl from '../../features/skill/stores/SkillStore'
 import AbstractCliTest from '../../tests/AbstractCliTest'
@@ -115,6 +116,48 @@ export default class SkillStoreTest extends AbstractCliTest {
         assert.isEqual(namespace, slug)
     }
 
+    @test()
+    protected static async returnsExpectedModuleInGoProject() {
+        const name = await this.initRandomGoProject()
+        await this.assertCurrentNamespaceEquals(name)
+    }
+
+    @test()
+    protected static async canFindGoModuleInSubdirectory() {
+        const name = await this.initRandomGoProject()
+        const newCwd = this.resolvePath(this.cwd, generateId())
+        diskUtil.createDir(newCwd)
+        this.setCwd(newCwd)
+        this.store = this.SkillStore()
+        await this.assertCurrentNamespaceEquals(name)
+    }
+
+    @test()
+    protected static async throwsNotInGoModuleErrorIfNotInGoProject() {
+        const err = await assert.doesThrowAsync(() =>
+            this.store.getGoModuleName()
+        )
+        errorAssert.assertError(err, 'DIRECTORY_NOT_GO_MODULE', {
+            cwd: this.cwd,
+        })
+    }
+
+    private static async assertCurrentNamespaceEquals(name: string) {
+        const actual = await this.store.loadCurrentSkillsNamespace()
+
+        assert.isEqual(
+            actual,
+            namesUtil.toPascal(name),
+            'Expected namespace to match go module name'
+        )
+    }
+
+    private static async initRandomGoProject() {
+        const name = randomUtil.rand(['my-skill', 'superSkill', 'AwesomeSkill'])
+        await this.go.initGoProject(name)
+        return name
+    }
+
     private static SkillStore(): SkillStoreImpl {
         return this.Store('skill', {})
     }

package/src/__tests__/support/EventFaker.ts

@@ -1,9 +1,36 @@
 import { SpruceSchemas } from '@sprucelabs/mercury-types'
+import { Organization } from '@sprucelabs/spruce-core-schemas'
 import { eventFaker } from '@sprucelabs/spruce-test-fixtures'
 import { generateId } from '@sprucelabs/test-utils'
 import { ListPermContractsTargetAndPayload } from '../../features/permission/stores/PermissionStore'
 
 export default class EventFaker {
+    public async fakeCreateOrganization(
+        cb?: (
+            targetAndPayload: CreateOrganizationTargetAndPayload
+        ) => void | Organization
+    ) {
+        await eventFaker.on(
+            'create-organization::v2020_12_25',
+            (targetAndPayload) => {
+                return {
+                    organization:
+                        cb?.(targetAndPayload) ??
+                        this.generateOrganizationValues(),
+                }
+            }
+        )
+    }
+
+    public generateOrganizationValues(): Organization {
+        return {
+            id: generateId(),
+            name: generateId(),
+            slug: generateId(),
+            dateCreated: Date.now(),
+        }
+    }
+
     public async fakeListSkills(cb?: () => void | ListSkill[]) {
         await eventFaker.on('list-skills::v2020_12_25', () => {
             return {
@@ -52,3 +79,5 @@ export default class EventFaker {
 }
 
 export type ListSkill = SpruceSchemas.Mercury.v2020_12_25.ListSkillsSkill
+export type CreateOrganizationTargetAndPayload =
+    SpruceSchemas.Mercury.v2020_12_25.CreateOrganizationEmitTargetAndPayload

package/src/cli/Cli.ts

@@ -7,6 +7,7 @@ import { SpruceSchemas } from '@sprucelabs/mercury-types'
 import {
     HealthCheckResults,
     HEALTH_DIVIDER,
+    SettingsService,
 } from '@sprucelabs/spruce-skill-utils'
 import { templates } from '@sprucelabs/spruce-templates'
 import { DEFAULT_HOST } from '../constants'
@@ -183,19 +184,19 @@ export default class Cli implements CliInterface {
             new TerminalInterface(cwd)) as GraphicsInterface
         let featureInstaller: FeatureInstaller | undefined
 
+        const settings = services.Service(cwd, 'settings')
+
         const writerFactory = new WriterFactory({
             templates,
             ui,
-            settings: services.Service(cwd, 'settings'),
+            settings,
             linter: services.Service(cwd, 'lint'),
         })
 
         const pkg = services.Service(cwd, 'pkg')
 
-        const optionOverrides = this.loadOptionOverrides(pkg)
-        const blockedCommands = this.loadCommandBlocks(
-            services.Service(cwd, 'pkg')
-        )
+        const optionOverrides = this.loadOptionOverrides(pkg, settings)
+        const blockedCommands = this.loadCommandBlocks(pkg)
 
         try {
             const s = pkg.getSkillNamespace()
@@ -287,17 +288,24 @@ export default class Cli implements CliInterface {
         return blocks
     }
 
-    private static loadOptionOverrides(pkg: PkgService): OptionOverrides {
+    private static loadOptionOverrides(
+        pkg: PkgService,
+        settings: SettingsService
+    ): OptionOverrides {
         const mapped: OptionOverrides = {}
+        let overrides: Record<string, string> = {}
 
         if (pkg.doesExist()) {
-            const overrides = pkg.get('skill.commandOverrides')
-
-            Object.keys(overrides ?? {}).forEach((command) => {
-                const options = argParserUtil.parse(overrides[command])
-                mapped[command] = options
-            })
+            overrides = pkg.get('skill.commandOverrides')
         }
+
+        overrides = { ...settings.get('commandOverrides'), ...overrides }
+
+        Object.keys(overrides ?? {}).forEach((command) => {
+            const options = argParserUtil.parse(overrides[command])
+            mapped[command] = options
+        })
+
         return mapped
     }
 

package/src/errors/SpruceError.ts

@@ -281,6 +281,10 @@ export default class SpruceError extends AbstractSpruceError<ErrorOptions> {
                 message = `You already registerd an AI Agent at ${options.promptPath}. If you want to register a new one, delete that file first.`
                 break
 
+            case 'DIRECTORY_NOT_GO_MODULE':
+                message = 'A Directory not go module just happened!'
+                break
+
             default:
                 message = super.friendlyMessage()
         }

package/src/errors/directoryNotGoModule.builder.ts

@@ -0,0 +1,13 @@
+import { buildErrorSchema } from '@sprucelabs/schema'
+
+export default buildErrorSchema({
+    id: 'directoryNotGoModule',
+    name: 'Directory not go module',
+    fields: {
+        cwd: {
+            type: 'text',
+            label: 'Current Working Directory',
+            isRequired: true,
+        },
+    },
+})

package/src/features/AbstractAction.ts

@@ -1,4 +1,5 @@
 import { Schema, SchemaValues, SchemaPartialValues } from '@sprucelabs/schema'
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { Templates } from '@sprucelabs/spruce-templates'
 import { GlobalEmitter } from '../GlobalEmitter'
 import ServiceFactory, {
@@ -111,14 +112,15 @@ export default abstract class AbstractAction<S extends Schema = Schema>
         return validateAndNormalizer.validateAndNormalize(schema, options)
     }
 
+    protected getProjectLanguage() {
+        return diskUtil.detectProjectLanguage(this.cwd)
+    }
+
     protected async resolveVersion(
         userSuppliedVersion: string | null | undefined,
         resolvedDestination: string
     ) {
-        const versions = VersionResolver.Resolver(
-            this.ui,
-            this.serviceFactory.Service(this.cwd, 'pkg')
-        )
+        const versions = VersionResolver.Resolver(this.ui, this.Service('pkg'))
         const version = await versions.resolveVersion(
             resolvedDestination,
             userSuppliedVersion

package/src/features/AbstractFeature.ts

@@ -1,6 +1,7 @@
 import pathUtil from 'path'
 import globby from '@sprucelabs/globby'
 import { Schema, SchemaValues } from '@sprucelabs/schema'
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { Templates } from '@sprucelabs/spruce-templates'
 import { GlobalEmitter } from '../GlobalEmitter'
 import ServiceFactory, {
@@ -34,7 +35,14 @@ export default abstract class AbstractFeature<
 {
     public abstract description: string
     public readonly dependencies: FeatureDependency[] = []
-    public readonly packageDependencies: NpmPackage[] = []
+    protected _packageDependencies: PackageDependency[] = []
+    public get packageDependencies() {
+        const resolved = this._packageDependencies.filter((dep) => {
+            const goDep = dep as GoPackage
+            return !goDep.type || goDep.type === this.getProjectLanguage()
+        })
+        return resolved
+    }
     public readonly optionsSchema?: S
     public readonly fileDescriptions: FileDescription[] = []
 
@@ -114,6 +122,10 @@ export default abstract class AbstractFeature<
         return this.features.getFeature(code)
     }
 
+    public getProjectLanguage() {
+        return diskUtil.detectProjectLanguage(this.cwd)
+    }
+
     public async getAvailableActionCodes(): Promise<string[]> {
         if (!this.actionsDir) {
             return []
@@ -176,3 +188,10 @@ export interface FeatureOptions {
     apiClientFactory: ApiClientFactory
     actionExecuter: ActionExecuter
 }
+
+export type PackageDependency = NpmPackage | GoPackage
+
+export interface GoPackage {
+    type: 'go'
+    name: string
+}

package/src/features/ActionFactory.ts

@@ -43,7 +43,8 @@ export default class ActionFactory {
             )
         }
 
-        let Class: new (options: ActionOptions) => FeatureAction | undefined
+        let Class: (new (options: ActionOptions) => FeatureAction) | undefined =
+            undefined
         let originalError: Error | undefined
 
         const key = ActionFactory.overrideKey(featureCode, actionCode)
@@ -61,7 +62,6 @@ export default class ActionFactory {
             }
         }
 
-        //@ts-ignore
         if (!Class) {
             throw new SpruceError({
                 code: 'GENERIC',

package/src/features/ActionQuestionAsker.ts

@@ -54,7 +54,6 @@ export default class ActionQuestionAskerImpl<
             while (notInstalled.length > 0) {
                 const toInstall = notInstalled.shift()
                 if (!toInstall) {
-                    // for typescript
                     throw new Error('Dependent feature error')
                 }
 

package/src/features/FeatureInstaller.ts

@@ -9,7 +9,10 @@ import ServiceFactory, {
     ServiceMap,
 } from '../services/ServiceFactory'
 import { InternalUpdateHandler, NpmPackage } from '../types/cli.types'
-import AbstractFeature, { FeatureDependency } from './AbstractFeature'
+import AbstractFeature, {
+    FeatureDependency,
+    GoPackage,
+} from './AbstractFeature'
 import {
     InstallFeatureOptions,
     FeatureInstallResponse,
@@ -107,11 +110,14 @@ export class FeatureInstallerImpl implements ServiceProvider, FeatureInstaller {
 
     public getFeatureDependencies<C extends FeatureCode>(
         featureCode: C
-        // trackedFeatures: FeatureDependency[] = []
     ): FeatureDependency[] {
+        if (this.isInGoProject()) {
+            return []
+        }
+
         let deps = this.getFeatureDependenciesIncludingSelf(
             { code: featureCode, isRequired: true },
-            [] // trackedFeatures
+            []
         ).filter((f) => f.code !== featureCode)
 
         deps = this.sortFeatures(deps)
@@ -119,6 +125,10 @@ export class FeatureInstallerImpl implements ServiceProvider, FeatureInstaller {
         return deps
     }
 
+    private isInGoProject() {
+        return diskUtil.detectProjectLanguage(this.cwd) === 'go'
+    }
+
     private getFeatureDependenciesIncludingSelf(
         featureDependency: FeatureDependency,
         trackedFeatures: FeatureDependency[] = []
@@ -415,13 +425,27 @@ export class FeatureInstallerImpl implements ServiceProvider, FeatureInstaller {
 
             didUpdateHandler?.(`Checking node dependency: ${pkg.name}`)
 
-            if (
-                pkg.isDev &&
+            const goPkg = pkg as GoPackage
+            const nodePkg = pkg as NpmPackage
+            const isGoPackage = goPkg.type === 'go'
+
+            const shouldConsider =
+                (isGoPackage && this.isInGoProject()) ||
+                (!isGoPackage && !this.isInGoProject())
+
+            if (!shouldConsider) {
+                return
+            }
+
+            if (isGoPackage) {
+                this.packagesToInstall.push(packageName)
+            } else if (
+                nodePkg.isDev &&
                 this.devPackagesToInstall.indexOf(packageName) === -1
             ) {
                 this.devPackagesToInstall.push(packageName)
             } else if (
-                !pkg.isDev &&
+                !nodePkg.isDev &&
                 this.packagesToInstall.indexOf(packageName) === -1
             ) {
                 this.packagesToInstall.push(packageName)

package/src/features/FeatureInstallerFactory.ts

@@ -120,6 +120,15 @@ export default class FeatureInstallerFactory {
 
         return featureInstaller
     }
+
+    public static setFeature<C extends FeatureCode>(code: C, feature: any) {
+        const index = this.featureCodes.indexOf(code)
+        if (index === -1) {
+            throw new Error(`Feature code "${code}" is not recognized.`)
+        }
+
+        this.features[index] = feature
+    }
 }
 
 interface InstallerWithAllFeaturesOptions {

package/src/features/OverrideActionDecorator.ts

@@ -140,7 +140,7 @@ export default class OverrideActionDecorator implements FeatureAction {
             const overrides = this.optionOverrides?.[commandStr]
             if (overrides) {
                 this.ui?.renderLine(
-                    `Overrides found in package.json of ${namespace}.`
+                    `Overrides found in ${this.parent.getProjectLanguage() === 'go' ? '.spruce/settings.json' : 'package.json'} of ${namespace}.`
                 )
                 this.ui?.renderObject(overrides)
                 options = {

package/src/features/VersionResolver.ts

@@ -54,9 +54,9 @@ export default class VersionResolver {
         fallbackVersion: string
     ) {
         const versions = this.loadVersions(resolvedDestination)
-        const choices = this.buildChoices(versions)
 
         if (versions.length > 0) {
+            const choices = this.buildChoices(versions)
             return await this.ui.prompt({
                 type: 'select',
                 label: 'Version',
@@ -67,6 +67,7 @@ export default class VersionResolver {
                 },
             })
         }
+
         return fallbackVersion
     }
 

package/src/features/agent/AgentFeature.ts

@@ -11,7 +11,7 @@ export default class AgentFeature extends AbstractFeature {
     public dependencies: FeatureDependency[] = [
         { code: 'event', isRequired: true },
     ]
-    public packageDependencies = [
+    public _packageDependencies = [
         {
             name: '@sprucelabs/spruce-agent-plugin',
         },

package/src/features/conversation/ConversationFeature.ts

@@ -15,7 +15,7 @@ export default class ConversationFeature extends AbstractFeature {
     public dependencies: FeatureDependency[] = [
         { code: 'event', isRequired: true },
     ]
-    public packageDependencies: NpmPackage[] = [
+    public _packageDependencies: NpmPackage[] = [
         {
             name: '@sprucelabs/spruce-conversation-plugin@latest',
             isDev: false,

package/src/features/dependencies/DependencyFeature.ts

@@ -13,7 +13,6 @@ export default class DependencyFeature extends AbstractFeature {
             isRequired: true,
         },
     ]
-    public packageDependencies = []
 
     public async isInstalled() {
         return this.features.isInstalled('skill')

package/src/features/deploy/DeployFeature.ts

@@ -15,7 +15,7 @@ export default class DeployFeature extends AbstractFeature {
             isRequired: true,
         },
     ]
-    public packageDependencies = [
+    public _packageDependencies = [
         { name: '@sprucelabs/spruce-deploy-plugin@latest', isDev: false },
     ]
 

package/src/features/error/ErrorFeature.ts

@@ -17,7 +17,7 @@ export default class ErrorFeature extends AbstractFeature {
         { code: 'schema', isRequired: true },
         { code: 'node', isRequired: true },
     ]
-    public packageDependencies: NpmPackage[] = [
+    public _packageDependencies: NpmPackage[] = [
         {
             name: '@sprucelabs/error@latest',
         },

package/src/features/event/EventFeature.ts

@@ -20,7 +20,7 @@ export default class EventFeature extends AbstractFeature {
         { code: 'schema', isRequired: true },
         { code: 'permission', isRequired: true },
     ]
-    public packageDependencies = [
+    public _packageDependencies = [
         {
             name: '@sprucelabs/mercury-client',
         },

package/src/features/eventContract/EventContractFeature.ts

@@ -1,6 +1,6 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { FileDescription } from '../../types/cli.types'
-import AbstractFeature, { FeatureDependency } from '../AbstractFeature'
+import AbstractFeature from '../AbstractFeature'
 import { FeatureCode } from '../features.types'
 
 export default class EventContractFeature extends AbstractFeature {
@@ -8,8 +8,6 @@ export default class EventContractFeature extends AbstractFeature {
     public nameReadable = 'Event Contract'
     public description =
         'Pull core Mercury events down and write to single, portable, dependency-free, strongly typed contract.'
-    public dependencies: FeatureDependency[] = []
-    public packageDependencies = []
 
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
     public readonly fileDescriptions: FileDescription[] = []

package/src/features/node/NodeFeature.ts

@@ -22,7 +22,7 @@ export default class NodeFeature<
     public description = ''
     public dependencies: FeatureDependency[] = []
     public optionsSchema = nodeFeatureOptionsSchema as S
-    public packageDependencies = [...universalDevDependencies]
+    public _packageDependencies = [...universalDevDependencies]
 
     public scripts = {
         ...universalScripts,

package/src/features/onboard/OnboardFeature.ts

@@ -1,9 +1,6 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import createTestOptionsSchema from '#spruce/schemas/spruceCli/v2020_07_22/createTestOptions.schema'
-import AbstractFeature, {
-    FeatureDependency,
-    FeatureOptions,
-} from '../AbstractFeature'
+import AbstractFeature, { FeatureOptions } from '../AbstractFeature'
 import featuresUtil from '../feature.utilities'
 import { FeatureCode } from '../features.types'
 import ScriptLoader from './ScriptLoader'
@@ -13,9 +10,6 @@ export default class OnboardFeature extends AbstractFeature {
     public code: FeatureCode = 'onboard'
     public nameReadable = 'Onboard'
     public description = 'Get building your first skill already!'
-    public dependencies: FeatureDependency[] = []
-    public packageDependencies = []
-
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 
     private onboardingStore?: OnboardingStore

package/src/features/organization/OrganizationFeature.ts

@@ -16,7 +16,6 @@ export default class OrganizationFeature extends AbstractFeature {
             isRequired: true,
         },
     ]
-    public packageDependencies = []
 
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 }

package/src/features/permission/PermissionFeature.ts

@@ -1,7 +1,6 @@
 import { PermissionContractMap } from '@sprucelabs/mercury-types'
 import { diskUtil, NpmPackage } from '@sprucelabs/spruce-skill-utils'
 import AbstractFeature, {
-    FeatureDependency,
     FeatureOptions,
     InstallResults,
 } from '../AbstractFeature'
@@ -12,9 +11,8 @@ export default class PermissionFeature extends AbstractFeature {
     public code: FeatureCode = 'permission'
     public nameReadable = 'permission'
     public description = 'Manage permissions for your skill'
-    public dependencies: FeatureDependency[] = []
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
-    public packageDependencies: NpmPackage[] = [
+    public _packageDependencies: NpmPackage[] = [
         {
             name: '@sprucelabs/spruce-permission-plugin@latest',
         },

package/src/features/person/PersonFeature.ts

@@ -1,14 +1,11 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
-import AbstractFeature, { FeatureDependency } from '../AbstractFeature'
+import AbstractFeature from '../AbstractFeature'
 import { FeatureCode } from '../features.types'
 
 export default class PersonFeature extends AbstractFeature {
     public code: FeatureCode = 'person'
     public nameReadable = 'Person'
     public description = 'Log in, log out, etc.'
-    public dependencies: FeatureDependency[] = []
-    public packageDependencies = []
-
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 
     public isInstalled = async () => {

package/src/features/polish/PolishFeature.ts

@@ -13,7 +13,7 @@ export default class PolishFeature extends AbstractFeature {
             isRequired: false,
         },
     ]
-    public packageDependencies: NpmPackage[] = [
+    public _packageDependencies: NpmPackage[] = [
         {
             name: '@sprucelabs/heartwood-polish',
             isDev: true,

package/src/features/sandbox/SandboxFeature.ts

@@ -14,7 +14,6 @@ export default class SandboxFeature extends AbstractFeature {
             isRequired: true,
         },
     ]
-    public packageDependencies = []
     public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 
     public constructor(options: ActionOptions) {

package/src/features/schema/SchemaFeature.ts

@@ -1,9 +1,9 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
-import { NpmPackage } from '../../types/cli.types'
 import AbstractFeature, {
     FeatureDependency,
     FeatureOptions,
     InstallResults,
+    PackageDependency,
 } from '../AbstractFeature'
 import { FeatureCode } from '../features.types'
 
@@ -14,7 +14,7 @@ export default class SchemaFeature extends AbstractFeature {
         { code: 'skill', isRequired: false },
         { code: 'node', isRequired: true },
     ]
-    public packageDependencies: NpmPackage[] = [
+    public _packageDependencies: PackageDependency[] = [
         {
             name: '@sprucelabs/schema@latest',
         },
@@ -25,6 +25,10 @@ export default class SchemaFeature extends AbstractFeature {
         {
             name: '@sprucelabs/spruce-skill-utils',
         },
+        {
+            type: 'go',
+            name: 'github.com/sprucelabsai-community/spruce-schema/v32/pkg/fields',
+        },
     ]
 
     public code: FeatureCode = 'schema'
@@ -94,6 +98,8 @@ export default class SchemaFeature extends AbstractFeature {
             return {}
         }
 
+        this.Service('settings').markAsInstalled(this.code)
+
         const files = await this.writePlugin()
 
         return {