@sprucelabs/spruce-cli 18.2.0 → 18.3.1

package/src/__tests__/behavioral/tests/CreatingATest.test.ts

@@ -19,8 +19,8 @@ export default class CreatingBehavioralTestsTest extends AbstractTestTest {
 		const candidates = await testFeature.buildParentClassCandidates()
 
 		assert.doesInclude(candidates, {
-			label: 'AbstractSpruceFixtureTest (requires install)',
-			name: 'AbstractSpruceFixtureTest',
+			label: 'AbstractStoreTest (requires install)',
+			name: 'AbstractStoreTest',
 		})
 	}
 

package/src/__tests__/behavioral/{SettingUpASkillForTesting.test.ts → tests/SettingUpASkillForTesting.test.ts}

@@ -1,6 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
-import AbstractSkillTest from '../../tests/AbstractSkillTest'
-import { DEMO_NUMBER } from '../../tests/constants'
+import AbstractSkillTest from '../../../tests/AbstractSkillTest'
+import { DEMO_NUMBER } from '../../../tests/constants'
 
 export default class SettingUpASkillForTestingTest extends AbstractSkillTest {
 	protected static skillCacheKey = 'tests'

package/src/__tests__/behavioral/{TestReporterSettingsRemembered.test.ts → tests/TestReporterSettingsRemembered.test.ts}

@@ -1,6 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
-import TestAction from '../../features/test/actions/TestAction'
-import AbstractTestTest from '../../tests/AbstractTestTest'
+import TestAction from '../../../features/test/actions/TestAction'
+import AbstractTestTest from '../../../tests/AbstractTestTest'
 
 export default class TestReporterSettingsRememberedTest extends AbstractTestTest {
 	@test()

package/src/__tests__/behavioral/{TestingDataStores.test.ts → tests/TestingDataStores.test.ts}

@@ -1,8 +1,8 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { test, assert } from '@sprucelabs/test-utils'
-import LintService from '../../services/LintService'
-import AbstractSkillTest from '../../tests/AbstractSkillTest'
-import testUtil from '../../tests/utilities/test.utility'
+import LintService from '../../../services/LintService'
+import AbstractSkillTest from '../../../tests/AbstractSkillTest'
+import testUtil from '../../../tests/utilities/test.utility'
 
 export default class TestingDataStoresTest extends AbstractSkillTest {
 	protected static skillCacheKey = 'storesWithTests'

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

@@ -33,7 +33,10 @@ export default class UpgradingANodeModuleTest extends AbstractCliTest {
 
 	@test()
 	protected static async upgradingWritesExpectedFiles() {
+		CommandService.fakeCommand(/build/gis, { code: 0 })
+
 		const shouldNotBeFound = ['src/.spruce/skill.ts', 'src/.spruce/features']
+		diskUtil.deleteDir(this.resolveHashSprucePath('features'))
 
 		const results = await this.Action('node', 'upgrade').execute({})
 

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

@@ -8,6 +8,7 @@ import AbstractCliTest from '../../../tests/AbstractCliTest'
 import testUtil from '../../../tests/utilities/test.utility'
 export default class UpgradingASkill3Test extends AbstractCliTest {
 	private static originalErrorSyncExecute: any
+
 	protected static async beforeEach() {
 		if (!this.originalErrorSyncExecute) {
 			this.originalErrorSyncExecute = SyncAction.prototype.execute
@@ -23,7 +24,7 @@ export default class UpgradingASkill3Test extends AbstractCliTest {
 
 	@test()
 	protected static async doesNotAddResolvePathAliasesToDependenciesAfterUpgrade() {
-		CommandService.clearMockResponses()
+		CommandService.clearFakedResponses()
 		await this.FeatureFixture().installCachedFeatures('views')
 
 		await this.Action('node', 'upgrade').execute({})
@@ -35,7 +36,7 @@ export default class UpgradingASkill3Test extends AbstractCliTest {
 
 	@test()
 	protected static async featuresNotEnabledDontInstall() {
-		CommandService.clearMockResponses()
+		CommandService.clearFakedResponses()
 		await this.FeatureFixture().installCachedFeatures('schemas')
 
 		const results = await this.Action('node', 'upgrade').execute({})

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

@@ -7,7 +7,7 @@ import AbstractCliTest from '../../../tests/AbstractCliTest'
 export default class UpgradingASkill4Test extends AbstractCliTest {
 	protected static async beforeEach() {
 		await super.beforeEach()
-		CommandService.fakeCommand(new RegExp(/yarn rebuild/gis), {
+		CommandService.fakeCommand(new RegExp(/rebuild/gis), {
 			code: 0,
 		})
 	}

package/src/__tests__/behavioral/{RegisteringSkillViewOnBoot.test.ts → views/RegisteringSkillViewOnBoot.test.ts}

@@ -1,6 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
-import AbstractSkillTest from '../../tests/AbstractSkillTest'
-import { DEMO_NUMBER_VIEWS_ON_BOOT } from '../../tests/constants'
+import AbstractSkillTest from '../../../tests/AbstractSkillTest'
+import { DEMO_NUMBER_VIEWS_ON_BOOT } from '../../../tests/constants'
 
 export default class RegisteringSkillViewOnBootTest extends AbstractSkillTest {
 	protected static skillCacheKey = 'views'

package/src/__tests__/behavioral/{WatchingSkillViews.test.ts → views/WatchingSkillViews.test.ts}

@@ -1,7 +1,7 @@
 import { test, assert } from '@sprucelabs/test-utils'
-import WatchAction from '../../features/view/actions/WatchAction'
-import CommandService from '../../services/CommandService'
-import AbstractSkillTest from '../../tests/AbstractSkillTest'
+import WatchAction from '../../../features/view/actions/WatchAction'
+import CommandService from '../../../services/CommandService'
+import AbstractSkillTest from '../../../tests/AbstractSkillTest'
 
 export default class WatchingSkillViewsTest extends AbstractSkillTest {
 	protected static skillCacheKey = 'views'

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

@@ -31,7 +31,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 
 	@test()
 	protected static async shouldEmitExecutionEvents() {
-		this.setupMockCommands()
+		this.fakeInstallCommands()
 
 		const executer = this.Action('skill', 'create', {
 			shouldAutoHandleDependencies: true,
@@ -129,7 +129,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 
 	@test()
 	protected static async shouldReturnProperSummary() {
-		this.setupMockCommands()
+		this.fakeInstallCommands()
 
 		const executer = this.Action('skill', 'create', {
 			shouldAutoHandleDependencies: true,
@@ -148,7 +148,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 
 	@test()
 	protected static async shouldAskInstallDependentFeatures() {
-		this.setupMockCommands()
+		this.fakeInstallCommands()
 
 		const executer = this.Action('schema', 'create', {
 			shouldAutoHandleDependencies: true,
@@ -169,7 +169,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 
 	@test()
 	protected static async shouldAddListenerWithoutBreakingOnSkill() {
-		this.setupMockCommands()
+		this.fakeInstallCommands()
 
 		await this.FeatureFixture().installCachedFeatures('schemas')
 
@@ -180,7 +180,14 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 
 		await this.waitForInput()
 
+		await this.ui.sendInput('Y')
+		await this.waitForInput()
+		await this.ui.sendInput('\n')
+
+		await this.waitForInput()
+
 		await this.ui.sendInput('skill')
+
 		await this.ui.sendInput('will-boot')
 
 		const results = await promise
@@ -264,8 +271,8 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 		return { promise }
 	}
 
-	private static setupMockCommands() {
-		CommandService.fakeCommand(new RegExp(/npm.*?install .*?/gis), {
+	private static fakeInstallCommands() {
+		CommandService.fakeCommand(new RegExp(/yarn|npm/gis), {
 			code: 0,
 		})
 	}

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

@@ -1,4 +1,4 @@
-import { test, assert } from '@sprucelabs/test-utils'
+import { test, assert, generateId } from '@sprucelabs/test-utils'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class GlobalEmitterTest extends AbstractCliTest {
@@ -7,4 +7,25 @@ export default class GlobalEmitterTest extends AbstractCliTest {
 		//@ts-ignore
 		assert.isTrue(this.emitter.shouldEmitSequentally)
 	}
+
+	@test()
+	protected static async didExecuteAcceptsInstalledPackages() {
+		await this.emitter.on('feature.did-execute', () => {
+			return {
+				packagesInstalled: [
+					{
+						isDev: true,
+						name: generateId(),
+						version: generateId(),
+					},
+				],
+			}
+		})
+
+		await this.emitter.emitAndFlattenResponses('feature.did-execute', {
+			actionCode: generateId(),
+			featureCode: 'permission',
+			results: {},
+		})
+	}
 }

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

@@ -109,8 +109,7 @@ export default class SkillStoreTest extends AbstractCliTest {
 
 		errorAssert.assertError(err, 'GENERIC')
 
-		const pkg = this.Service('pkg')
-		const namespace = pkg.get('skill.namespace')
+		const namespace = this.Service('pkg').getSkillNamespace()
 		assert.isEqual(namespace, slug)
 	}
 

package/src/features/AbstractAction.ts

@@ -69,8 +69,8 @@ export default abstract class AbstractAction<S extends Schema = Schema>
 		options: SchemaValues<S>
 	): Promise<FeatureActionResponse>
 
-	protected Action(featureCode: string, actionCode: string) {
-		return this.actionExecuter.Action(featureCode as any, actionCode)
+	protected Action(featureCode: FeatureCode, actionCode: string) {
+		return this.actionExecuter.Action(featureCode, actionCode)
 	}
 
 	public Service<S extends Service>(type: S, cwd?: string): ServiceMap[S] {

package/src/features/AbstractFeature.ts

@@ -47,15 +47,15 @@ export default abstract class AbstractFeature<
 	public cwd: string
 	public scripts: Record<string, any> = {}
 	public actionsDir: string | undefined
-	protected actionFactory?: ActionFactory
+	protected actions?: ActionFactory
 	protected templates: Templates
 	protected emitter: GlobalEmitter
-	protected featureInstaller: FeatureInstaller
+	protected features: FeatureInstaller
 	protected ui: GraphicsInterface
 
 	private serviceFactory: ServiceFactory
 	private storeFactory: StoreFactory
-	private writerFactory: WriterFactory
+	private writers: WriterFactory
 	private apiClientFactory: ApiClientFactory
 	private actionExecuter: ActionExecuter
 	private actionCodes?: string[]
@@ -64,16 +64,16 @@ export default abstract class AbstractFeature<
 		this.cwd = options.cwd
 		this.serviceFactory = options.serviceFactory
 		this.templates = options.templates
-		this.actionFactory = options.actionFactory
+		this.actions = options.actionFactory
 		this.storeFactory = options.storeFactory
-		this.writerFactory = new WriterFactory({
+		this.writers = new WriterFactory({
 			templates: this.templates,
 			ui: options.ui,
 			settings: this.Service('settings'),
 			linter: this.Service('lint'),
 		})
 		this.emitter = options.emitter
-		this.featureInstaller = options.featureInstaller
+		this.features = options.featureInstaller
 		this.ui = options.ui
 		this.apiClientFactory = options.apiClientFactory
 		this.actionExecuter = options.actionExecuter
@@ -103,7 +103,7 @@ export default abstract class AbstractFeature<
 		code: C,
 		options?: Partial<WriterOptions>
 	): WriterMap[C] {
-		return this.writerFactory.Writer(code, {
+		return this.writers.Writer(code, {
 			fileDescriptions: this.fileDescriptions,
 			linter: this.Service('lint'),
 			...options,
@@ -111,7 +111,7 @@ export default abstract class AbstractFeature<
 	}
 
 	public getFeature<Code extends FeatureCode>(code: Code) {
-		return this.featureInstaller.getFeature(code)
+		return this.features.getFeature(code)
 	}
 
 	public async getAvailableActionCodes(): Promise<string[]> {

package/src/features/ActionExecuter.ts

@@ -17,7 +17,7 @@ import {
 export default class ActionExecuter {
 	private emitter: GlobalEmitter
 	private ui: GraphicsInterface
-	private actionFactory: ActionFactory
+	private actions: ActionFactory
 	private featureInstallerFactory: () => FeatureInstaller
 	private shouldAutoHandleDependencies: boolean
 	private shouldThrowOnListenerError: boolean
@@ -26,7 +26,7 @@ export default class ActionExecuter {
 		this.featureInstallerFactory = options.featureInstallerFactory
 		this.emitter = options.emitter
 		this.ui = options.ui
-		this.actionFactory = options.actionFactory
+		this.actions = options.actionFactory
 		this.shouldAutoHandleDependencies =
 			options.shouldAutoHandleDependencies ?? true
 
@@ -122,7 +122,7 @@ export default class ActionExecuter {
 			executeResults = await originalExecute({
 				...answers,
 			})
-		} catch (err) {
+		} catch (err: any) {
 			executeResults.errors = [err]
 		}
 
@@ -169,8 +169,7 @@ export default class ActionExecuter {
 	): FeatureAction {
 		const featureInstaller = this.getFeatureInstaller()
 
-		const actionFactory = this.actionFactory
-		const action = actionFactory.Action({
+		const action = this.actions.Action({
 			featureCode,
 			actionCode,
 			actionExecuter: this,

package/src/features/ActionFactory.ts

@@ -14,20 +14,11 @@ import ActionExecuter from './ActionExecuter'
 import FeatureInstaller from './FeatureInstaller'
 import OverrideActionDecorator from './OverrideActionDecorator'
 
-export interface FeatureActionFactoryOptions
-	extends Omit<
-		ActionOptions,
-		'parent' | 'actionExecuter' | 'featureInstaller'
-	> {
-	emitter: GlobalEmitter
-	blockedCommands?: BlockedCommands
-	optionOverrides?: OptionOverrides
-}
-
 export default class ActionFactory {
 	private actionOptions: FeatureActionFactoryOptions
 	private blockedCommands?: BlockedCommands
 	private optionOverrides?: OptionOverrides
+	private static overrides: Record<string, ActionConstructor> = {}
 
 	public constructor(options: FeatureActionFactoryOptions) {
 		const { blockedCommands, optionOverrides, ...actionOptions } = options
@@ -53,19 +44,23 @@ export default class ActionFactory {
 			)
 		}
 
-		const classPath = diskUtil.resolvePath(
-			feature.actionsDir,
-			`${namesUtil.toPascal(actionCode)}Action`
-		)
-
 		let Class: new (options: ActionOptions) => AbstractAction | undefined
 		let originalError: Error | undefined
 
-		try {
-			Class = require(classPath).default
-			// eslint-disable-next-line no-empty
-		} catch (err: any) {
-			originalError = err
+		const key = ActionFactory.overrideKey(featureCode, actionCode)
+		if (ActionFactory.overrides[key]) {
+			Class = ActionFactory.overrides[key]
+		} else {
+			const classPath = diskUtil.resolvePath(
+				feature.actionsDir,
+				`${namesUtil.toPascal(actionCode)}Action`
+			)
+			try {
+				Class = require(classPath).default
+				// eslint-disable-next-line no-empty
+			} catch (err: any) {
+				originalError = err
+			}
 		}
 
 		//@ts-ignore
@@ -109,4 +104,33 @@ export default class ActionFactory {
 
 		return actionDecorator as FeatureAction<S>
 	}
+
+	public static setActionClass(
+		featureCode: FeatureCode,
+		action: string,
+		ExecuteTrackingAction: ActionConstructor
+	) {
+		this.overrides[ActionFactory.overrideKey(featureCode, action)] =
+			ExecuteTrackingAction
+	}
+
+	private static overrideKey(featureCode: string, action: string) {
+		return `${featureCode}${action}`
+	}
+
+	public static clearActionOverrides() {
+		this.overrides = {}
+	}
+}
+
+export interface FeatureActionFactoryOptions
+	extends Omit<
+		ActionOptions,
+		'parent' | 'actionExecuter' | 'featureInstaller'
+	> {
+	emitter: GlobalEmitter
+	blockedCommands?: BlockedCommands
+	optionOverrides?: OptionOverrides
 }
+
+type ActionConstructor = new (options: ActionOptions) => AbstractAction

package/src/features/ActionQuestionAsker.ts

@@ -15,23 +15,6 @@ import {
 	FeatureMap,
 } from './features.types'
 
-type FeatureCommandExecuteOptions<
-	F extends FeatureCode,
-	S extends Schema | undefined = FeatureMap[F]['optionsSchema']
-> = S extends Schema ? SchemaPartialValues<S> : undefined
-
-type FeatureDependencyWithFeature = FeatureDependency & {
-	feature: AbstractFeature
-}
-
-function s(array: any[]) {
-	return array.length === 1 ? '' : ''
-}
-
-function areIs(array: any[]) {
-	return array.length === 1 ? 'is' : 'are'
-}
-
 export default class ActionOptionAsker<F extends FeatureCode = FeatureCode> {
 	private ui: GraphicsInterface
 	private featureInstaller: FeatureInstaller
@@ -388,3 +371,20 @@ export default class ActionOptionAsker<F extends FeatureCode = FeatureCode> {
 		return `Before you can run \`${this.getCommandName()}\`, ${message} Don't worry, I'll walk you through it!`
 	}
 }
+
+type FeatureCommandExecuteOptions<
+	F extends FeatureCode,
+	S extends Schema | undefined = FeatureMap[F]['optionsSchema']
+> = S extends Schema ? SchemaPartialValues<S> : undefined
+
+type FeatureDependencyWithFeature = FeatureDependency & {
+	feature: AbstractFeature
+}
+
+function s(array: any[]) {
+	return array.length === 1 ? '' : ''
+}
+
+function areIs(array: any[]) {
+	return array.length === 1 ? 'is' : 'are'
+}

package/src/features/conversation/ConversationFeature.ts

@@ -42,7 +42,7 @@ export default class ConversationFeature extends AbstractFeature {
 		actionCode: string
 		featureCode: string
 	}) {
-		const isInstalled = await this.featureInstaller.isInstalled('conversation')
+		const isInstalled = await this.features.isInstalled('conversation')
 
 		if (
 			payload.featureCode === 'node' &&

package/src/features/dependencies/DependencyFeature.ts

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

package/src/features/deploy/actions/HerokuAction.ts

@@ -41,7 +41,7 @@ export default class DeployAction extends AbstractAction<OptionsSchema> {
 		let results: FeatureActionResponse = {}
 
 		try {
-			await this.assertRegisteredSkill()
+			this.assertRegisteredSkill()
 			await this.assertDependencies()
 			await this.assertLoggedInToHeroku()
 			await this.setupGitRepo()
@@ -51,7 +51,7 @@ export default class DeployAction extends AbstractAction<OptionsSchema> {
 			results = actionUtil.mergeActionResults(results, procResults)
 
 			await this.assertNoPendingGitChanges()
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/error/ErrorFeature.ts

@@ -43,7 +43,7 @@ export default class ErrorFeature extends AbstractFeature {
 		)
 
 		void this.emitter.on('skill.will-write-directory-template', async () => {
-			const isInstalled = await this.featureInstaller.isInstalled('error')
+			const isInstalled = await this.features.isInstalled('error')
 			if (isInstalled) {
 				return {
 					filesToSkip: ['options.types.ts'],
@@ -55,7 +55,7 @@ export default class ErrorFeature extends AbstractFeature {
 	}
 
 	public async afterPackageInstall(): Promise<InstallResults> {
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 
 		if (!isSkillInstalled) {
 			return {}
@@ -74,9 +74,9 @@ export default class ErrorFeature extends AbstractFeature {
 	}) {
 		const { featureCode, actionCode } = payload
 
-		const isInstalled = await this.featureInstaller.isInstalled('error')
+		const isInstalled = await this.features.isInstalled('error')
 
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 
 		if (isInstalled && featureCode === 'node' && actionCode === 'upgrade') {
 			const results = await this.Action('error', 'sync').execute({})

package/src/features/event/EventFeature.ts

@@ -12,22 +12,13 @@ import { FeatureActionResponse, FeatureCode } from '../features.types'
 import EventContractBuilder from './builders/EventContractBuilder'
 import EventStore from './stores/EventStore'
 
-declare module '../../features/features.types' {
-	interface FeatureMap {
-		event: EventFeature
-	}
-
-	interface FeatureOptionsMap {
-		event: undefined
-	}
-}
-
 export default class EventFeature extends AbstractFeature {
 	public code: FeatureCode = 'event'
 	public nameReadable = 'Events'
 	public description = 'Connect to the Mercury Event Engine.'
 	public dependencies: FeatureDependency[] = [
 		{ code: 'schema', isRequired: true },
+		{ code: 'permission', isRequired: true },
 	]
 	public packageDependencies = [
 		{
@@ -74,7 +65,7 @@ export default class EventFeature extends AbstractFeature {
 
 	public async afterPackageInstall() {
 		diskUtil.createDir(diskUtil.resolvePath(this.cwd, 'src', 'events'))
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 		if (isSkillInstalled) {
 			return await this.Action('event', 'sync.listeners').execute({})
 		}
@@ -101,7 +92,7 @@ export default class EventFeature extends AbstractFeature {
 			settings.clearListenerCache()
 		}
 
-		const isInstalled = await this.featureInstaller.isInstalled('event')
+		const isInstalled = await this.features.isInstalled('event')
 		const isRemoteRelevant =
 			isInstalled &&
 			(featureCode === 'event' ||
@@ -128,7 +119,7 @@ export default class EventFeature extends AbstractFeature {
 		actionCode: string
 	}) {
 		const { featureCode, actionCode } = payload
-		const isInstalled = await this.featureInstaller.isInstalled('event')
+		const isInstalled = await this.features.isInstalled('event')
 
 		let results = {}
 
@@ -178,7 +169,7 @@ export default class EventFeature extends AbstractFeature {
 	}
 
 	private async handleDidFetchSchemas(payload: { schemas?: Schema[] | null }) {
-		const isInstalled = await this.featureInstaller.isInstalled(this.code)
+		const isInstalled = await this.features.isInstalled(this.code)
 
 		const lastSync = this.Service('eventSettings').getLastSyncOptions()
 
@@ -225,3 +216,13 @@ export default class EventFeature extends AbstractFeature {
 		return false
 	}
 }
+
+declare module '../../features/features.types' {
+	interface FeatureMap {
+		event: EventFeature
+	}
+
+	interface FeatureOptionsMap {
+		event: undefined
+	}
+}

package/src/features/event/actions/CreateAction.ts

@@ -102,7 +102,7 @@ export default class CreateAction extends AbstractAction<OptionsSchema> {
 				{ files, meta: { fqen } },
 				syncResponse
 			)
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/event/actions/ListenAction.ts

@@ -148,7 +148,7 @@ export default class ListenAction extends AbstractAction<OptionsSchema> {
 			}
 
 			return response
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}