@sprucelabs/spruce-cli 18.1.8 → 18.3.0

package/src/schemas/v2020_07_22/actionResponse.builder.ts

@@ -0,0 +1,62 @@
+import { buildSchema } from '@sprucelabs/schema'
+import generatedFileBuilder from './generatedFile.builder'
+
+export default buildSchema({
+	id: 'actionResponse',
+	name: 'Action response',
+	importsWhenLocal: [`import AbstractSpruceError from '@sprucelabs/error'`],
+	fields: {
+		files: {
+			type: 'schema',
+			isArray: true,
+			options: {
+				schema: generatedFileBuilder,
+			},
+		},
+		headline: {
+			type: 'text',
+		},
+		hints: {
+			type: 'text',
+			isArray: true,
+		},
+		summaryLines: {
+			type: 'text',
+			isArray: true,
+		},
+		errors: {
+			type: 'raw',
+			isArray: true,
+			options: {
+				valueType: 'AbstractSpruceError<any>',
+			},
+		},
+		meta: {
+			type: 'raw',
+			options: {
+				valueType: 'Record<string, any>',
+			},
+		},
+		packagesInstalled: {
+			type: 'schema',
+			isArray: true,
+			options: {
+				schema: buildSchema({
+					id: 'npmPackage',
+					fields: {
+						name: {
+							type: 'text',
+							isRequired: true,
+						},
+						version: {
+							type: 'text',
+						},
+						isDev: {
+							type: 'boolean',
+						},
+					},
+				}),
+			},
+		},
+	},
+})

package/src/schemas/v2020_07_22/generatedFile.builder.ts

@@ -0,0 +1,44 @@
+import { buildSchema } from '@sprucelabs/schema'
+
+const generatedFileBuilder = buildSchema({
+	id: 'generatedFile',
+	fields: {
+		name: {
+			type: 'text',
+			isRequired: true,
+		},
+		path: {
+			type: 'text',
+			isRequired: true,
+		},
+		description: {
+			type: 'text',
+		},
+		action: {
+			type: 'select',
+			isRequired: true,
+			options: {
+				choices: [
+					{
+						label: 'Skipped',
+						value: 'skipped',
+					},
+					{
+						label: 'Generated',
+						value: 'generated',
+					},
+					{
+						label: 'Updated',
+						value: 'updated',
+					},
+					{
+						label: 'Deleted',
+						value: 'deleted',
+					},
+				],
+			},
+		},
+	},
+})
+
+export default generatedFileBuilder

package/src/schemas/v2020_07_22/watcherDidDetectChangesEmitPayload.builder.ts

@@ -1,45 +1,5 @@
 import { buildSchema } from '@sprucelabs/schema'
-
-const fieldsSchema = buildSchema({
-	id: 'generatedFileFields',
-	fields: {
-		name: {
-			type: 'text',
-			isRequired: true,
-		},
-		path: {
-			type: 'text',
-			isRequired: true,
-		},
-		description: {
-			type: 'text',
-		},
-		action: {
-			type: 'select',
-			isRequired: true,
-			options: {
-				choices: [
-					{
-						label: 'Skipped',
-						value: 'skipped',
-					},
-					{
-						label: 'Generated',
-						value: 'generated',
-					},
-					{
-						label: 'Updated',
-						value: 'updated',
-					},
-					{
-						label: 'Deleted',
-						value: 'deleted',
-					},
-				],
-			},
-		},
-	},
-})
+import generatedFileBuilder from './generatedFile.builder'
 
 export default buildSchema({
 	id: 'watcherDidDetectChangesEmitPayload',
@@ -51,13 +11,10 @@ export default buildSchema({
 			isArray: true,
 			options: {
 				schemas: [
-					buildSchema({
-						id: 'generatedFile',
-						fields: fieldsSchema.fields,
-					}),
+					generatedFileBuilder,
 					buildSchema({
 						id: 'generatedDir',
-						fields: fieldsSchema.fields,
+						fields: generatedFileBuilder.fields,
 					}),
 				],
 			},

package/src/services/CommandService.ts

@@ -13,7 +13,7 @@ export default class CommandService {
 	public cwd: string
 	private activeChildProcess: ChildProcess | undefined
 	private ignoreCloseErrors = false
-	private static mockResponses: {
+	private static fakeResponses: {
 		command: string | RegExp
 		response: MockResponse
 	}[] = []
@@ -167,7 +167,7 @@ export default class CommandService {
 
 	private getMockResponse(executable: string, args: string[]) {
 		const mockKey = `${executable} ${args.join(' ')}`.trim()
-		const commands = CommandService.mockResponses
+		const commands = CommandService.fakeResponses
 		const match = commands.find((r) =>
 			r.command instanceof RegExp
 				? mockKey.search(r.command) > -1
@@ -178,14 +178,14 @@ export default class CommandService {
 	}
 
 	public static fakeCommand(command: string | RegExp, response: MockResponse) {
-		this.mockResponses.unshift({
+		this.fakeResponses.unshift({
 			command,
 			response,
 		})
 	}
 
-	public static clearMockResponses() {
-		this.mockResponses = []
+	public static clearFakedResponses() {
+		this.fakeResponses = []
 	}
 }
 

package/src/services/PkgService.ts

@@ -93,6 +93,10 @@ export default class PkgService extends BasePkgService {
 		return { executable, args }
 	}
 
+	public getSkillNamespace() {
+		return this.get('skill.namespace')
+	}
+
 	public async uninstall(pkg: string[] | string) {
 		const packages = Array.isArray(pkg) ? pkg : [pkg]
 		const args: string[] = ['uninstall', ...packages]

package/src/tests/AbstractCliTest.ts

@@ -46,10 +46,6 @@ import SkillFixture from './fixtures/SkillFixture'
 import ViewFixture from './fixtures/ViewFixture'
 import testUtil from './utilities/test.utility'
 
-type ExecuterOptions = Partial<ActionExecuterOptions> & {
-	optionOverrides?: OptionOverrides
-}
-
 export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	protected static cliRoot = pathUtil.join(__dirname, '..')
 	protected static homeDir: string
@@ -64,6 +60,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	private static _featureInstaller?: FeatureInstaller
 	private static viewFixture?: ViewFixture
 	private static originalEnv: { [x: string]: string | undefined }
+	private static _writers?: WriterFactory
 
 	protected static async beforeAll() {
 		await super.beforeAll()
@@ -82,6 +79,10 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	protected static async beforeEach() {
 		await super.beforeEach()
 
+		delete this._writers
+
+		ActionFactory.clearActionOverrides()
+
 		//@ts-ignore
 		process.env = { ...this.originalEnv }
 
@@ -106,7 +107,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		ImportService.clearCache()
 		SkillStore.clearCurrentSkill()
 		EventStore.clearCache()
-		CommandService.clearMockResponses()
+		CommandService.clearFakedResponses()
 		MercuryClientFactory.reset()
 		MercuryClientFactory.setIsTestMode(false)
 
@@ -134,11 +135,15 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		if (diskUtil.doesDirExist(this.homeDir) && testUtil.shouldClearCache()) {
 			diskUtil.deleteDir(this.homeDir)
 		}
+
+		if (testUtil.shouldCleanupAfterEach()) {
+			FeatureFixture.deleteOldSkillDirs()
+		}
 	}
 
 	protected static async afterAll() {
 		await super.afterAll()
-		if (testUtil.shouldCleanupTestSkillDirs()) {
+		if (testUtil.shouldCleanupAfterAll()) {
 			FeatureFixture.deleteOldSkillDirs()
 		}
 	}
@@ -252,9 +257,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 
 	protected static getViewFixture() {
 		if (!this.viewFixture) {
-			const writerFactory = this.WriterFactory()
-
-			const viewWriter = writerFactory.Writer('view', { fileDescriptions: [] })
+			const viewWriter = this.writers.Writer('view', { fileDescriptions: [] })
 			this.viewFixture = new ViewFixture(
 				this.cwd,
 				viewWriter,
@@ -265,6 +268,14 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		return this.viewFixture
 	}
 
+	protected static get writers() {
+		if (!this._writers) {
+			this._writers = this.WriterFactory()
+		}
+
+		return this._writers
+	}
+
 	private static WriterFactory() {
 		return new WriterFactory({
 			templates,
@@ -388,8 +399,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		results: FeatureActionResponse
 	) {
 		for (const file of results.files ?? []) {
-			const checker = this.Service('typeChecker')
-			await checker.check(file.path)
+			await this.assertFilePassesTypeChecks(file.path)
 		}
 
 		// await Promise.all(
@@ -400,6 +410,11 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		// )
 	}
 
+	protected static async assertFilePassesTypeChecks(file: string) {
+		const checker = this.Service('typeChecker')
+		await checker.check(file)
+	}
+
 	protected static async connectToApi(options?: ApiClientFactoryOptions) {
 		return this.getMercuryFixture().connectToApi(options)
 	}
@@ -446,10 +461,9 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 
 	protected static ActionExecuter(options?: ExecuterOptions) {
 		const serviceFactory = this.ServiceFactory()
-		const writerFactory = this.WriterFactory()
 
 		const actionFactory = new ActionFactory({
-			writerFactory,
+			writerFactory: this.writers,
 			ui: this.ui,
 			emitter: this.emitter,
 			apiClientFactory: this.getMercuryFixture().getApiClientFactory(),
@@ -492,3 +506,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		void this.ui.sendInput(`${match.value}`)
 	}
 }
+
+type ExecuterOptions = Partial<ActionExecuterOptions> & {
+	optionOverrides?: OptionOverrides
+}

package/src/tests/buildTestCache.ts

@@ -45,6 +45,13 @@ async function run() {
 
 	if (process.env.WILL_BUILD_CACHE_SCRIPT) {
 		term.renderLine('Running pre build cache script')
+		if (process.env.CLEAN_CACHE_SCRIPT) {
+			try {
+				execSync(process.env.CLEAN_CACHE_SCRIPT)
+			} catch {
+				/* Empty */
+			}
+		}
 		execSync(process.env.WILL_BUILD_CACHE_SCRIPT)
 	}
 

package/src/tests/fixtures/FeatureFixture.ts

@@ -58,6 +58,8 @@ export default class FeatureFixture implements ServiceProvider {
 		for (const dir of this.dirsToDelete) {
 			diskUtil.deleteDir(dir)
 		}
+
+		this.dirsToDelete = []
 	}
 
 	public Service<S extends Service>(

package/src/tests/utilities/test.utility.ts

@@ -26,6 +26,19 @@ const testUtil = {
 		return process.env.CLEANUP_TEST_SKILL_DIRS !== 'false'
 	},
 
+	shouldCleanupAfterEach() {
+		return (
+			this.shouldCleanupTestSkillDirs() &&
+			process.env.CLEANUP_TEST_SKILL_DIRS_ON === 'afterEach'
+		)
+	},
+	shouldCleanupAfterAll() {
+		return (
+			this.shouldCleanupTestSkillDirs() &&
+			process.env.CLEANUP_TEST_SKILL_DIRS_ON !== 'afterEach'
+		)
+	},
+
 	getTestRootDir() {
 		return process.env.TEST_CACHE_ROOT_DIR ?? pathUtil.join(os.tmpdir())
 	},

package/build/__tests__/behavioral/permissions/AbstractPermissionsTest.d.ts

@@ -1,8 +0,0 @@
-import CreateAction from '../../../features/permission/actions/CreateAction';
-import AbstractSkillTest from '../../../tests/AbstractSkillTest';
-export default abstract class AbstractPermissionsTest extends AbstractSkillTest {
-    protected static skillCacheKey: string;
-    protected static createAction: CreateAction;
-    protected static beforeEach(): Promise<void>;
-    protected static createPermissionContract(nameReadable: string): Promise<import("../../../features/features.types").FeatureActionResponse>;
-}

package/build/__tests__/behavioral/permissions/AbstractPermissionsTest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AbstractPermissionsTest.js","names":["AbstractPermissionsTest","createAction","Action","nameReadable","execute","nameCamel","namesUtil","toCamel","AbstractSkillTest"],"sources":["../../../../src/__tests__/behavioral/permissions/AbstractPermissionsTest.ts"],"sourcesContent":["import { namesUtil } from '@sprucelabs/spruce-skill-utils'\nimport CreateAction from '../../../features/permission/actions/CreateAction'\nimport AbstractSkillTest from '../../../tests/AbstractSkillTest'\n\nexport default abstract class AbstractPermissionsTest extends AbstractSkillTest {\n\tprotected static skillCacheKey = 'permissions'\n\tprotected static createAction: CreateAction\n\n\tprotected static async beforeEach() {\n\t\tawait super.beforeEach()\n\t\tthis.createAction = this.Action('permission', 'create')\n\t}\n\n\tprotected static async createPermissionContract(nameReadable: string) {\n\t\treturn await this.createAction.execute({\n\t\t\tnameReadable,\n\t\t\tnameCamel: namesUtil.toCamel(nameReadable),\n\t\t})\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAEA;AAAgE;AAAA;AAAA,IAElCA,uBAAuB;EAAA;EAAA;EAAA;IAAA;IAAA;EAAA;EAAA;IAAA;IAAA;MAAA,gGAIpD;QAAA;UAAA;YAAA;cAAA;gBAAA;gBAAA;cAAA;gBAEC,IAAI,CAACC,YAAY,GAAG,IAAI,CAACC,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC;cAAA;cAAA;gBAAA;YAAA;UAAA;QAAA;MAAA,CACvD;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;IAAA;IAAA;MAAA,8GAED,kBAAgDC,YAAoB;QAAA;UAAA;YAAA;cAAA;gBAAA;gBAAA,OACtD,IAAI,CAACF,YAAY,CAACG,OAAO,CAAC;kBACtCD,YAAY,EAAZA,YAAY;kBACZE,SAAS,EAAEC,2BAAS,CAACC,OAAO,CAACJ,YAAY;gBAC1C,CAAC,CAAC;cAAA;gBAAA;cAAA;cAAA;gBAAA;YAAA;UAAA;QAAA;MAAA,CACF;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA,EAd4DK,8BAAiB;AAAA;AAAA,iCAAjDR,uBAAuB,mBACnB,aAAa;AAAA,iCADjBA,uBAAuB"}

package/src/__tests__/behavioral/permissions/AbstractPermissionsTest.ts

@@ -1,20 +0,0 @@
-import { namesUtil } from '@sprucelabs/spruce-skill-utils'
-import CreateAction from '../../../features/permission/actions/CreateAction'
-import AbstractSkillTest from '../../../tests/AbstractSkillTest'
-
-export default abstract class AbstractPermissionsTest extends AbstractSkillTest {
-	protected static skillCacheKey = 'permissions'
-	protected static createAction: CreateAction
-
-	protected static async beforeEach() {
-		await super.beforeEach()
-		this.createAction = this.Action('permission', 'create')
-	}
-
-	protected static async createPermissionContract(nameReadable: string) {
-		return await this.createAction.execute({
-			nameReadable,
-			nameCamel: namesUtil.toCamel(nameReadable),
-		})
-	}
-}