@sprucelabs/spruce-cli 19.0.0 → 19.1.1

package/src/features/store/stores/StoreStore.ts

@@ -1,5 +1,5 @@
+import globby from '@sprucelabs/globby'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
-import globby from 'globby'
 import SpruceError from '../../../errors/SpruceError'
 import AbstractStore from '../../../stores/AbstractStore'
 import introspectionUtil from '../../../utilities/introspection.utility'

package/src/features/test/TestReporter.ts

@@ -12,31 +12,6 @@ import WidgetFactory from '../../widgets/WidgetFactory'
 import { SpruceTestResults, TestRunnerStatus } from './test.types'
 import TestLogItemGenerator from './TestLogItemGenerator'
 
-interface TestReporterOptions {
-	handleStartStop?: () => void
-	handleRestart?: () => void
-	handleQuit?: () => void
-	onRequestOpenTestFile?: () => void
-	handleRerunTestFile?: (fileName: string) => void
-	handleOpenTestFile?: (fileName: string) => void
-	handleFilterPatternChange?: (pattern?: string) => void
-	handleToggleDebug?: () => void
-	handletoggleStandardWatch?: () => void
-	handleToggleSmartWatch?: () => void
-	filterPattern?: string
-	isDebugging?: boolean
-	watchMode?: WatchMode
-	status?: TestRunnerStatus
-	cwd?: string
-}
-
-type TestReporterResults = SpruceTestResults & {
-	customErrors: string[]
-}
-
-export type TestReporterOrientation = 'landscape' | 'portrait'
-export type WatchMode = 'off' | 'standard' | 'smart'
-
 export default class TestReporter {
 	private started = false
 	private table?: any
@@ -831,3 +806,28 @@ export default class TestReporter {
 function buildPatternButtonText(pattern: string | undefined): string {
 	return pattern ? ' x ' : ' - '
 }
+
+interface TestReporterOptions {
+	handleStartStop?: () => void
+	handleRestart?: () => void
+	handleQuit?: () => void
+	onRequestOpenTestFile?: () => void
+	handleRerunTestFile?: (fileName: string) => void
+	handleOpenTestFile?: (fileName: string) => void
+	handleFilterPatternChange?: (pattern?: string) => void
+	handleToggleDebug?: () => void
+	handletoggleStandardWatch?: () => void
+	handleToggleSmartWatch?: () => void
+	filterPattern?: string
+	isDebugging?: boolean
+	watchMode?: WatchMode
+	status?: TestRunnerStatus
+	cwd?: string
+}
+
+type TestReporterResults = SpruceTestResults & {
+	customErrors: string[]
+}
+
+export type TestReporterOrientation = 'landscape' | 'portrait'
+export type WatchMode = 'off' | 'standard' | 'smart'

package/src/features/test/test.types.ts

@@ -1,7 +1,14 @@
 export type TestResultStatus = 'running' | 'passed' | 'failed'
 export interface SpruceTestFileTest {
 	name: string
-	status: 'passed' | 'failed' | 'skipped' | 'pending' | 'todo' | 'disabled'
+	status:
+		| 'passed'
+		| 'failed'
+		| 'skipped'
+		| 'pending'
+		| 'todo'
+		| 'disabled'
+		| 'focused'
 	errorMessages?: string[]
 	duration: number
 }

package/src/features/view/actions/SyncAction.ts

@@ -1,6 +1,6 @@
+import globby from '@sprucelabs/globby'
 import { buildSchema, SchemaValues } from '@sprucelabs/schema'
 import { diskUtil, namesUtil } from '@sprucelabs/spruce-skill-utils'
-import globby from 'globby'
 import { VcTemplateItem } from '../../../../../spruce-templates/build'
 import introspectionUtil, {
 	IntrospectionClass,

package/src/features/view/actions/WatchAction.ts

@@ -16,10 +16,12 @@ export default class WatchAction extends AbstractAction<OptionsSchema> {
 	public optionsSchema: OptionsSchema = optionsSchema
 	public invocationMessage = 'Watching views... 🤩'
 	private skillName!: string
+	private skillNamespace!: string
 
 	public async execute(): Promise<FeatureActionResponse> {
-		const skill = await this.Store('skill').loadCurrentSkill()
-		this.skillName = skill.name
+		const skill = this.Service('auth').getCurrentSkill()
+		this.skillName = skill?.name ?? 'Unknown'
+		this.skillNamespace = skill?.slug ?? 'heartwood'
 
 		this.resetUi()
 		const commands = this.Service('command')
@@ -50,7 +52,10 @@ export default class WatchAction extends AbstractAction<OptionsSchema> {
 
 	private getPreviewUrl() {
 		const remote = this.Service('remote').getRemote() as any
-		return heartwoodRemoteUtil.buildUrl(remote) + '/#views/heartwood.watch'
+		return (
+			heartwoodRemoteUtil.buildUrl(remote) +
+			`/#views/${this.skillNamespace}.root`
+		)
 	}
 
 	private resetUi() {

package/src/index.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { run } from './cli'
+import { run } from './boot'
 import TerminalInterface from './interfaces/TerminalInterface'
 
 require('dotenv').config()

package/src/interfaces/SpyInterface.ts

@@ -40,6 +40,8 @@ export default class SpyInterface implements GraphicsInterface {
 			: undefined
 	}
 
+	public setTitle(_title: string): void {}
+
 	private shouldRenderTestLogs() {
 		return process.env.SHOULD_RENDER_TEST_LOGS === 'true'
 	}

package/src/interfaces/TerminalInterface.ts

@@ -1,5 +1,6 @@
 import path from 'path'
 import AbstractSpruceError from '@sprucelabs/error'
+import globby from '@sprucelabs/globby'
 import {
 	FieldFactory,
 	FieldDefinitionValueType,
@@ -15,7 +16,6 @@ import Table from 'cli-table3'
 // @ts-ignore No definition available
 import emphasize from 'emphasize'
 import fs from 'fs-extra'
-import globby from 'globby'
 import inquirer from 'inquirer'
 import _ from 'lodash'
 import { filter } from 'lodash'
@@ -287,6 +287,10 @@ export default class TerminalInterface implements GraphicsInterface {
 		}
 	}
 
+	public setTitle(title: string): void {
+		process.stdout.write('\x1b]2;' + title + '\x07')
+	}
+
 	public renderHero(message: string, effects?: GraphicsTextEffect[]) {
 		const shouldStripVowels = process.stdout.columns < 80
 

package/src/tests/AbstractCliTest.ts

@@ -1,13 +1,12 @@
 import pathUtil from 'path'
+import globby from '@sprucelabs/globby'
 import { MercuryClientFactory } from '@sprucelabs/mercury-client'
 import { SchemaRegistry } from '@sprucelabs/schema'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { templates } from '@sprucelabs/spruce-templates'
 import AbstractSpruceTest, { assert } from '@sprucelabs/test-utils'
 import fs from 'fs-extra'
-import globby from 'globby'
 import * as uuid from 'uuid'
-import { CliBootOptions } from '../cli'
 import AbstractAction from '../features/AbstractAction'
 import { FeatureOptions } from '../features/AbstractFeature'
 import ActionExecuter, {
@@ -33,7 +32,7 @@ import StoreFactory, {
 	StoreMap,
 } from '../stores/StoreFactory'
 import { ApiClientFactoryOptions } from '../types/apiClient.types'
-import { OptionOverrides } from '../types/cli.types'
+import { CliBootOptions, OptionOverrides } from '../types/cli.types'
 import WriterFactory from '../writers/WriterFactory'
 import CommandFaker from './CommandFaker'
 import FeatureFixture, {

package/src/tests/AbstractSchemaTest.ts

@@ -6,8 +6,8 @@ import {
 	SchemaHealthCheckItem,
 } from '@sprucelabs/spruce-skill-utils'
 import { assert } from '@sprucelabs/test-utils'
-import { CliBootOptions } from '../cli'
 import { FeatureCode } from '../features/features.types'
+import { CliBootOptions } from '../types/cli.types'
 import AbstractCliTest from './AbstractCliTest'
 
 export default abstract class AbstractSchemaTest extends AbstractCliTest {

package/src/tests/AbstractSkillTest.ts

@@ -1,4 +1,4 @@
-import { CliInterface } from '../cli'
+import { CliInterface } from '../types/cli.types'
 import AbstractCliTest from './AbstractCliTest'
 
 export default abstract class AbstractSkillTest extends AbstractCliTest {

package/src/tests/JestJsonParser.ts

@@ -208,7 +208,10 @@ export default class JestJsonParser {
 	private pullTestsFromTestFileResult(
 		testResult: OnTestFileResult['testResult']
 	): SpruceTestFile['tests'] {
-		return testResult.testResults.map((test) => this.testCaseResultToTest(test))
+		return testResult.testResults.map((test) =>
+			//@ts-ignore - remove with next upgrade
+			this.testCaseResultToTest(test)
+		)
 	}
 
 	private testCaseResultToTest(test: AssertionResult): {

package/src/tests/fixtures/FeatureFixture.ts

@@ -1,6 +1,6 @@
 import pathUtil from 'path'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
-import Cli, { CliBootOptions, CliInterface } from '../../cli'
+import Cli from '../../cli/Cli'
 import FeatureInstaller from '../../features/FeatureInstaller'
 import { InstallFeature } from '../../features/features.types'
 import { GlobalEmitter } from '../../GlobalEmitter'
@@ -10,31 +10,20 @@ import ServiceFactory, {
 	ServiceMap,
 } from '../../services/ServiceFactory'
 import { ApiClientFactory } from '../../types/apiClient.types'
-import { GraphicsInterface } from '../../types/cli.types'
+import {
+	CliBootOptions,
+	CliInterface,
+	GraphicsInterface,
+} from '../../types/cli.types'
 import testUtil from '../utilities/test.utility'
 
-export interface CachedCli {
-	cli: CliInterface
-	cwd: string
-}
-
-export interface FeatureFixtureOptions {
-	cwd: string
-	serviceFactory: ServiceFactory
-	ui: GraphicsInterface
-	shouldGenerateCacheIfMissing?: boolean
-	apiClientFactory: ApiClientFactory
-	emitter?: GlobalEmitter
-	featureInstaller?: FeatureInstaller
-}
-
 export default class FeatureFixture implements ServiceProvider {
 	private cwd: string
 	private installedSkills: Record<string, CachedCli> = {}
 	private serviceFactory: ServiceFactory
 	private static linkedUtils = false
 	private static dirsToDelete: string[] = []
-	private term: GraphicsInterface
+	private ui: GraphicsInterface
 	private generateCacheIfMissing = false
 	private apiClientFactory: ApiClientFactory
 	private emitter?: GlobalEmitter
@@ -47,7 +36,7 @@ export default class FeatureFixture implements ServiceProvider {
 
 		this.cwd = options.cwd
 		this.serviceFactory = options.serviceFactory
-		this.term = options.ui
+		this.ui = options.ui
 		this.generateCacheIfMissing = !!options.shouldGenerateCacheIfMissing
 		this.apiClientFactory = options.apiClientFactory
 		this.emitter = options.emitter
@@ -74,7 +63,7 @@ export default class FeatureFixture implements ServiceProvider {
 
 		const cli = await Cli.Boot({
 			cwd: this.cwd,
-			graphicsInterface: this.term,
+			graphicsInterface: this.ui,
 			apiClientFactory: this.apiClientFactory,
 			emitter: this.emitter,
 			featureInstaller: this.featureInstaller,
@@ -282,3 +271,18 @@ export default class FeatureFixture implements ServiceProvider {
 		}
 	}
 }
+
+export interface CachedCli {
+	cli: CliInterface
+	cwd: string
+}
+
+export interface FeatureFixtureOptions {
+	cwd: string
+	serviceFactory: ServiceFactory
+	ui: GraphicsInterface
+	shouldGenerateCacheIfMissing?: boolean
+	apiClientFactory: ApiClientFactory
+	emitter?: GlobalEmitter
+	featureInstaller?: FeatureInstaller
+}

package/src/tests/fixtures/MercuryFixture.ts

@@ -1,4 +1,4 @@
-import Cli from '../../cli'
+import Cli from '../../cli/Cli'
 import { DEFAULT_HOST } from '../../constants'
 import ServiceFactory from '../../services/ServiceFactory'
 import {

package/src/types/cli.types.ts

@@ -1,8 +1,14 @@
+import { MercuryEventEmitter } from '@sprucelabs/mercury-types'
+import { HealthCheckResults } from '@sprucelabs/spruce-skill-utils'
+import { CommanderStatic } from 'commander'
 import { SpruceSchemas } from '#spruce/schemas/schemas.types'
+import FeatureInstaller from '../features/FeatureInstaller'
 import {
 	FeatureAction,
 	FeatureActionResponse,
 } from '../features/features.types'
+import { GlobalEmitter, GlobalEventContract } from '../GlobalEmitter'
+import { ApiClient, ApiClientFactory } from './apiClient.types'
 import { GraphicsInterface as IGraphicsInterface } from './graphicsInterface.types'
 export { NpmPackage } from '@sprucelabs/spruce-skill-utils'
 
@@ -14,6 +20,7 @@ export interface GraphicsInterface extends IGraphicsInterface {
 	clear(): void
 	waitForEnter(message?: string): Promise<void>
 	sendInput(message: string): Promise<void>
+	setTitle(title: string): void
 }
 
 export type GeneratedFile = SpruceSchemas.SpruceCli.v2020_07_22.GeneratedFile
@@ -60,3 +67,26 @@ export interface OptionOverrides {
 export interface BlockedCommands {
 	[command: string]: string
 }
+
+export interface HealthOptions {
+	shouldRunOnSourceFiles?: boolean
+}
+
+export interface CliInterface extends MercuryEventEmitter<GlobalEventContract> {
+	installFeatures: FeatureInstaller['install']
+	getFeature: FeatureInstaller['getFeature']
+	checkHealth(options?: HealthOptions): Promise<HealthCheckResults>
+}
+
+export interface CliBootOptions {
+	cwd?: string
+	homeDir?: string
+	program?: CommanderStatic['program']
+	graphicsInterface?: GraphicsInterface
+	emitter?: GlobalEmitter
+	apiClientFactory?: ApiClientFactory
+	featureInstaller?: FeatureInstaller
+	host?: string
+}
+
+export type PromiseCache = Record<string, Promise<ApiClient>>