@sprucelabs/spruce-cli 14.29.0 → 14.29.4

package/package.json

@@ -18,7 +18,7 @@
     ]
   },
   "license": "MIT",
-  "version": "14.29.0",
+  "version": "14.29.4",
   "bin": {
     "spruce": "./build/index.js"
   },
@@ -75,20 +75,20 @@
     "@babel/cli": "^7.16.0",
     "@babel/plugin-proposal-decorators": "^7.16.4",
     "@babel/runtime": "^7.16.3",
-    "@jest/reporters": "^27.4.2",
-    "@sprucelabs/error": "^5.0.317",
-    "@sprucelabs/heartwood-view-controllers": "^51.6.51",
-    "@sprucelabs/jest-json-reporter": "^6.0.265",
-    "@sprucelabs/mercury-client": "^17.4.29",
-    "@sprucelabs/mercury-event-emitter": "^17.4.29",
-    "@sprucelabs/mercury-types": "^26.1.992",
-    "@sprucelabs/schema": "^25.4.67",
-    "@sprucelabs/spruce-core-schemas": "^22.6.250",
-    "@sprucelabs/spruce-event-plugin": "^18.1.0",
-    "@sprucelabs/spruce-event-utils": "^17.1.272",
-    "@sprucelabs/spruce-skill-booter": "^18.1.0",
-    "@sprucelabs/spruce-skill-utils": "^22.1.50",
-    "@sprucelabs/spruce-templates": "^14.29.0",
+    "@jest/reporters": "^27.4.4",
+    "@sprucelabs/error": "^5.0.332",
+    "@sprucelabs/heartwood-view-controllers": "^51.14.1",
+    "@sprucelabs/jest-json-reporter": "^6.0.276",
+    "@sprucelabs/mercury-client": "^17.4.85",
+    "@sprucelabs/mercury-event-emitter": "^17.4.85",
+    "@sprucelabs/mercury-types": "^26.1.1050",
+    "@sprucelabs/schema": "^25.4.102",
+    "@sprucelabs/spruce-core-schemas": "^22.6.299",
+    "@sprucelabs/spruce-event-plugin": "^18.3.3",
+    "@sprucelabs/spruce-event-utils": "^17.1.339",
+    "@sprucelabs/spruce-skill-booter": "^18.3.3",
+    "@sprucelabs/spruce-skill-utils": "^22.1.89",
+    "@sprucelabs/spruce-templates": "^14.29.4",
     "@typescript-eslint/eslint-plugin": "^5.6.0",
     "@typescript-eslint/parser": "^5.6.0",
     "cfonts": "^2.10.0",
@@ -119,26 +119,26 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@sprucelabs/data-stores": "^7.2.0",
-    "@sprucelabs/jest-sheets-reporter": "^1.2.268",
-    "@sprucelabs/mercury-core-events": "^1.6.215",
-    "@sprucelabs/resolve-path-aliases": "^1.0.236",
-    "@sprucelabs/spruce-conversation-plugin": "^18.1.0",
-    "@sprucelabs/spruce-deploy-plugin": "^18.1.0",
-    "@sprucelabs/spruce-store-plugin": "^18.1.0",
-    "@sprucelabs/spruce-test-fixtures": "^18.1.0",
-    "@sprucelabs/test": "^7.7.248",
-    "@sprucelabs/test-utils": "^3.0.301",
+    "@sprucelabs/data-stores": "^7.2.1",
+    "@sprucelabs/jest-sheets-reporter": "^1.2.276",
+    "@sprucelabs/mercury-core-events": "^1.6.289",
+    "@sprucelabs/resolve-path-aliases": "^1.0.240",
+    "@sprucelabs/spruce-conversation-plugin": "^18.3.3",
+    "@sprucelabs/spruce-deploy-plugin": "^18.3.3",
+    "@sprucelabs/spruce-store-plugin": "^18.3.3",
+    "@sprucelabs/spruce-test-fixtures": "^18.3.3",
+    "@sprucelabs/test": "^7.7.258",
+    "@sprucelabs/test-utils": "^3.0.320",
     "@types/blessed": "^0.1.19",
     "@types/eslint": "^8.2.1",
     "@types/fs-extra": "^9.0.13",
     "@types/inflection": "^1.13.0",
     "@types/inquirer": "^8.1.3",
     "@types/jsonwebtoken": "^8.5.6",
-    "@types/lodash": "^4.14.177",
+    "@types/lodash": "^4.14.178",
     "@types/md5": "^2.3.1",
     "@types/mkdirp": "^1.0.2",
-    "@types/node": "^16.11.11",
+    "@types/node": "^16.11.12",
     "@types/promise.allsettled": "^1.0.3",
     "@types/ps-node": "^0.1.1",
     "@types/rimraf": "^3.0.2",
@@ -152,21 +152,21 @@
     "concurrently": "^6.4.0",
     "conventional-changelog-sprucelabs": "^1.1.2",
     "dotenv": "^10.0.0",
-    "eslint": "^8.4.0",
-    "eslint-config-spruce": "^10.10.16",
+    "eslint": "^8.4.1",
+    "eslint-config-spruce": "^10.11.0",
     "find-process": "^1.4.7",
-    "jest": "^27.4.3",
-    "jest-circus": "^27.4.2",
+    "jest": "^27.4.4",
+    "jest-circus": "^27.4.4",
     "jest-junit": "^13.0.0",
     "jest-reporters": "^0.0.2",
     "prettier": "^2.5.1",
     "ps-node": "^0.1.6",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.1.0",
+    "ts-jest": "^27.1.1",
     "ts-node": "^10.4.0",
     "tsc-watch": "^4.5.0",
     "tsconfig-paths": "^3.12.0",
-    "typescript": "^4.5.2"
+    "typescript": "^4.5.3"
   },
   "testSkillCache": {
     "everything": [
@@ -597,5 +597,5 @@
       "ora"
     ]
   },
-  "gitHead": "b3d42f18072662e082727a4ac9b60f3ec707db3d"
+  "gitHead": "daab330a93577997638df78ec958e91799938d1f"
 }

package/src/__tests__/behavioral/events/CreatingAListener.test.ts

@@ -265,6 +265,26 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 		)
 	}
 
+	@test()
+	protected static async listeningToAnEventWithNoEmitTargetOrPayloadGeneratesValidListener() {
+		const { listenerPath } =
+			await this.setupSkillsInstallAtOrgRegisterEventContractAndGenerateListener(
+				{
+					isGlobal: true,
+					responsePayloadSchema: {
+						id: 'test',
+						fields: {
+							id: {
+								type: 'id',
+							},
+						},
+					},
+				}
+			)
+
+		await this.Service('typeChecker').check(listenerPath)
+	}
+
 	private static async installEventsAndCreateListener() {
 		const cli = await this.installEventFeature('events')
 

package/src/__tests__/behavioral/{ListeningToAnEventYouCreate.test.ts → events/ListeningToAnEventYouCreate.test.ts}

@@ -1,8 +1,8 @@
 import { eventNameUtil } from '@sprucelabs/spruce-event-utils'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import { test, assert } from '@sprucelabs/test'
-import AbstractEventTest from '../../tests/AbstractEventTest'
-import testUtil from '../../tests/utilities/test.utility'
+import AbstractEventTest from '../../../tests/AbstractEventTest'
+import testUtil from '../../../tests/utilities/test.utility'
 
 export default class ListeningToAnEventYouCreateTest extends AbstractEventTest {
 	@test()

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

@@ -0,0 +1,34 @@
+import { test, assert } from '@sprucelabs/test'
+import CommandService from '../../services/CommandService'
+import LintService from '../../services/LintService'
+import AbstractCliTest from '../../tests/AbstractCliTest'
+
+export default class LintServiceTest extends AbstractCliTest {
+	@test()
+	protected static async throwsWhenLintReturnsMessage() {
+		LintService.enableLinting()
+
+		await this.FeatureFixture().installCachedFeatures('skills')
+
+		CommandService.setMockResponse(/node/, {
+			code: 0,
+			stdout: `[{"filePath":"/Users/taylorromero/Development/SpruceLabs/spruce-appointments-skill/src/.spruce/stores/stores.types.ts","messages":[{"fatal":false,"severity":1,"message":"File ignored by default.  Use a negated ignore pattern (like \\"--ignore-pattern '!<relative/path/to/filename>'\\") to override."}],"errorCount":1,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":[]}]\n`,
+		})
+
+		await assert.doesThrowAsync(() => this.Service('lint').fix('./go'))
+	}
+
+	@test()
+	protected static async worksWhenNoMessagesReturned() {
+		LintService.enableLinting()
+
+		await this.FeatureFixture().installCachedFeatures('skills')
+
+		CommandService.setMockResponse(/node/, {
+			code: 0,
+			stdout: `[{"filePath":"/Users/taylorromero/Development/SpruceLabs/spruce-appointments-skill/src/.spruce/stores/stores.types.ts","messages":[{"fatal":false,"severity":1,"message":"File ignored by default.  Use a negated ignore pattern (like \\"--ignore-pattern '!<relative/path/to/filename>'\\") to override."}],"errorCount":0,"warningCount":1,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":[]}]\n`,
+		})
+
+		await this.Service('lint').fix('./go')
+	}
+}

package/src/errors/SpruceError.ts

@@ -68,12 +68,16 @@ export default class SpruceError extends AbstractSpruceError<ErrorOptions> {
 				break
 
 			case 'LINT_FAILED':
-				message = `Lint failed on pattern ${options.pattern}.`
+				message = options.friendlyMessage
 
-				if (options.originalError) {
-					message += `\n\nOriginal error:${
-						options.originalError.stack ?? options.originalError.message
-					}`
+				if (!message) {
+					message = `Lint failed on pattern ${options.pattern}.`
+
+					if (options.originalError) {
+						message += `\n\nOriginal error:${
+							options.originalError.stack ?? options.originalError.message
+						}`
+					}
 				}
 
 				break

package/src/features/node/NodeFeature.ts

@@ -59,12 +59,13 @@ export default class NodeFeature<
 			return {}
 		})
 	}
+
 	private async handleUpgrade(): Promise<FeatureActionResponse> {
 		try {
 			this.ui.startLoading('Cleaning build...')
 			await this.Service('command').execute('yarn clean.build')
 
-			this.ui.startLoading('Rebuilding...')
+			this.ui.startLoading('Building for development...')
 			await this.Service('command').execute('yarn build.dev')
 
 			return {

package/src/features/store/StoreFeature.ts

@@ -70,7 +70,10 @@ export default class StoreFeature extends AbstractFeature {
 				ui: this.ui,
 				headline: 'Resyncing data stores...',
 			})
-			return this.Action('store', 'sync').execute({})
+
+			const results = await this.Action('store', 'sync').execute({})
+
+			return results
 		}
 
 		return {}

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

@@ -1,4 +1,5 @@
 import { buildSchema } from '@sprucelabs/schema'
+// eslint-disable-next-line spruce/prohibit-import-of-schema-in-builders
 import personSchema from '#spruce/schemas/spruce/v2020_07_22/person.schema'
 
 export default buildSchema({

package/src/services/GameService.ts

@@ -20,6 +20,7 @@ export default class GameService {
 
 	public async play(introductionSentences: string[] = []) {
 		const sentencesToPlay = [...introductionSentences]
+		await this.ui.stopLoading()
 		this.killed = false
 
 		while (sentencesToPlay.length > 0) {

package/src/services/LintService.ts

@@ -6,7 +6,7 @@ import CommandService from './CommandService'
 
 export default class LintService {
 	public cwd: string
-	private command: CommandService
+	private getCommand: () => CommandService
 
 	private static isLintingEnabled = true
 
@@ -18,9 +18,9 @@ export default class LintService {
 		this.isLintingEnabled = true
 	}
 
-	public constructor(cwd: string, commandService: CommandService) {
+	public constructor(cwd: string, commandServiceFactory: () => CommandService) {
 		this.cwd = cwd
-		this.command = commandService
+		this.getCommand = commandServiceFactory
 	}
 
 	public fix = async (pattern: string): Promise<string[]> => {
@@ -37,12 +37,13 @@ export default class LintService {
 
 		let fixedFiles: any = {}
 		const fixedPaths: string[] = []
+
 		try {
 			// const cli = new ESLint({ fix: true, cwd: this.cwd, cache: true })
 			// fixedFiles = await cli.lintFiles([pattern])
 			const script = `"(async function lint() { try { const { ESLint } = require('eslint'); const cli = new ESLint({ fix: true, cwd: '${this.cwd}', }); const result = await cli.lintFiles(['${pattern}']); console.log(JSON.stringify(result)); } catch (err) { console.log(err.toString()); }})()"`
 
-			const { stdout } = await this.command.execute('node', {
+			const { stdout } = await this.getCommand().execute('node', {
 				args: ['-e', script],
 			})
 
@@ -58,9 +59,20 @@ export default class LintService {
 		if (fixedFiles) {
 			for (let i = 0; i < fixedFiles.length; i += 1) {
 				const fixedFile = fixedFiles[i]
-				if (fixedFile && fixedFile.output) {
+
+				if (fixedFile?.output) {
 					await fs.writeFile(fixedFile.filePath, fixedFile.output)
 					fixedPaths.push(fixedFile.filePath)
+				} else if (fixedFile?.messages && fixedFile?.errorCount > 0) {
+					throw new SpruceError({
+						code: 'LINT_FAILED',
+						pattern,
+						friendlyMessage: `Lint error with '${
+							fixedFile.filePath
+						}':\n\n${fixedFile.messages
+							.map((m: any) => m?.message)
+							.join('\n')}`,
+					})
 				}
 			}
 		}

package/src/services/ServiceFactory.ts

@@ -55,8 +55,7 @@ export default class ServiceFactory {
 					command: new CommandService(cwd),
 				}) as ServiceMap[S]
 			case 'lint':
-				return new LintService(
-					cwd,
+				return new LintService(cwd, () =>
 					this.Service(cwd, 'command')
 				) as ServiceMap[S]
 			case 'command': {
@@ -80,7 +79,7 @@ export default class ServiceFactory {
 				const commandService = new CommandService(cwd)
 				return new BuildService(
 					commandService,
-					new LintService(cwd, this.Service(cwd, 'command'))
+					new LintService(cwd, () => this.Service(cwd, 'command'))
 				) as ServiceMap[S]
 			}
 			case 'eventSettings':

package/build/__tests__/behavioral/ListeningToAnEventYouCreate.test.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/__tests__/behavioral/ListeningToAnEventYouCreate.test.ts"],"names":["ListeningToAnEventYouCreateTest","registerCurrentSkillAndInstallToOrg","currentSkill","eventName","version","fqen","eventNameUtil","join","eventNamespace","slug","source","resolveTestPath","destination","resolvePath","diskUtil","copyDir","listenPromise","Action","execute","waitForInput","ui","sendInput","results","assert","isFalsy","errors","match","testUtil","assertFileByNameInGeneratedFiles","files","doesInclude","assertClientIsProperlyTyped","sourceFile","contents","readFile","replace","destinationFile","writeFile","Service","check","AbstractEventTest"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;;;;;;;IAEqBA,+B,WACnB,iB;;;;;;;;;;;;;qHAAD;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAEgC,KAAKC,mCAAL,EAFhC;;AAAA;AAAA;AAESC,gBAAAA,YAFT,yBAESA,YAFT;AAIOC,gBAAAA,SAJP,GAImB,sBAJnB;AAKOC,gBAAAA,OALP,GAKiB,aALjB;AAOOC,gBAAAA,IAPP,GAOcC,gCAAcC,IAAd,CAAmB;AAC/BJ,kBAAAA,SAAS,EAATA,SAD+B;AAE/BK,kBAAAA,cAAc,EAAEN,YAAY,CAACO,IAFE;AAG/BL,kBAAAA,OAAO,EAAPA;AAH+B,iBAAnB,CAPd;AAaOM,gBAAAA,MAbP,GAagB,KAAKC,eAAL,CAAqB,sCAArB,CAbhB;AAcOC,gBAAAA,WAdP,GAcqB,KAAKC,WAAL,CAAiB,KAAjB,CAdrB;AAAA;AAAA,uBAgBOC,2BAASC,OAAT,CAAiBL,MAAjB,EAAyBE,WAAzB,CAhBP;;AAAA;AAkBOI,gBAAAA,aAlBP,GAkBuB,KAAKC,MAAL,CAAY,OAAZ,EAAqB,QAArB,EAA+BC,OAA/B,CAAuC,EAAvC,CAlBvB;AAAA;AAAA,uBAoBO,KAAKC,YAAL,EApBP;;AAAA;AAAA;AAAA,uBAqBO,KAAKC,EAAL,CAAQC,SAAR,CAAkBnB,YAAY,CAACO,IAA/B,CArBP;;AAAA;AAAA;AAAA,uBAuBO,KAAKU,YAAL,EAvBP;;AAAA;AAAA;AAAA,uBAwBO,KAAKC,EAAL,CAAQC,SAAR,CAAkBhB,IAAlB,CAxBP;;AAAA;AAAA;AAAA,uBA0BuBW,aA1BvB;;AAAA;AA0BOM,gBAAAA,OA1BP;;AA4BCC,6BAAOC,OAAP,CAAeF,OAAO,CAACG,MAAvB;;AAEMC,gBAAAA,KA9BP,GA8BeC,kBAASC,gCAAT,WACVzB,SADU,cACGC,OADH,mBAEbkB,OAAO,CAACO,KAFK,CA9Bf;;AAmCCN,6BAAOO,WAAP,CACCJ,KADD,EAECZ,2BAASD,WAAT,CAAqB,WAArB,EAAkCX,YAAY,CAACO,IAA/C,CAFD;;AAnCD;AAAA,uBAwCO,KAAKsB,2BAAL,CAAiC7B,YAAY,CAACO,IAA9C,CAxCP;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;uHA2CA,kBAAiDD,cAAjD;AAAA;AAAA;AAAA;AAAA;AAAA;AACOwB,gBAAAA,UADP,GACoB,KAAKnB,WAAL,CAAiB,6BAAjB,CADpB;AAEOoB,gBAAAA,QAFP,GAEkBnB,2BACfoB,QADe,CACNF,UADM,EAEfG,OAFe,CAEP,oBAFO,EAEe3B,cAFf,CAFlB;AAMO4B,gBAAAA,eANP,GAMyB,KAAKvB,WAAL,CAAiB,yBAAjB,CANzB;;AAOCC,2CAASuB,SAAT,CAAmBD,eAAnB,EAAoCH,QAApC;;AAPD;AAAA,uBASO,KAAKK,OAAL,CAAa,aAAb,EAA4BC,KAA5B,CAAkCH,eAAlC,CATP;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;EA5C4DI,8B","sourcesContent":["import { eventNameUtil } from '@sprucelabs/spruce-event-utils'\nimport { diskUtil } from '@sprucelabs/spruce-skill-utils'\nimport { test, assert } from '@sprucelabs/test'\nimport AbstractEventTest from '../../tests/AbstractEventTest'\nimport testUtil from '../../tests/utilities/test.utility'\n\nexport default class ListeningToAnEventYouCreateTest extends AbstractEventTest {\n\t@test()\n\tprotected static async canListenToEventWeCreated() {\n\t\tconst { currentSkill } = await this.registerCurrentSkillAndInstallToOrg()\n\n\t\tconst eventName = 'register-skill-views'\n\t\tconst version = 'v2021_04_11'\n\n\t\tconst fqen = eventNameUtil.join({\n\t\t\teventName,\n\t\t\teventNamespace: currentSkill.slug,\n\t\t\tversion,\n\t\t})\n\n\t\tconst source = this.resolveTestPath('skill_register_skill_views_event/src')\n\t\tconst destination = this.resolvePath('src')\n\n\t\tawait diskUtil.copyDir(source, destination)\n\n\t\tconst listenPromise = this.Action('event', 'listen').execute({})\n\n\t\tawait this.waitForInput()\n\t\tawait this.ui.sendInput(currentSkill.slug)\n\n\t\tawait this.waitForInput()\n\t\tawait this.ui.sendInput(fqen)\n\n\t\tconst results = await listenPromise\n\n\t\tassert.isFalsy(results.errors)\n\n\t\tconst match = testUtil.assertFileByNameInGeneratedFiles(\n\t\t\t`${eventName}.${version}.listener.ts`,\n\t\t\tresults.files\n\t\t)\n\n\t\tassert.doesInclude(\n\t\t\tmatch,\n\t\t\tdiskUtil.resolvePath('listeners', currentSkill.slug)\n\t\t)\n\n\t\tawait this.assertClientIsProperlyTyped(currentSkill.slug)\n\t}\n\n\tprivate static async assertClientIsProperlyTyped(eventNamespace: string) {\n\t\tconst sourceFile = this.resolvePath('src/client-type-test.ts.hbs')\n\t\tconst contents = diskUtil\n\t\t\t.readFile(sourceFile)\n\t\t\t.replace('{{eventNamespace}}', eventNamespace)\n\n\t\tconst destinationFile = this.resolvePath('src/client-type-test.ts')\n\t\tdiskUtil.writeFile(destinationFile, contents)\n\n\t\tawait this.Service('typeChecker').check(destinationFile)\n\t}\n}\n"],"file":"ListeningToAnEventYouCreate.test.js"}

package/build/__tests__/behavioral/README.md

@@ -1,8 +0,0 @@
-
-# Behavioral tests
-
-These are the tests that matter. They should test everything just under the interface. Interface tests can go into implementation since they'll often change.
-
-If all these pass, we ship.
-
-

package/build/__tests__/implementation/README.md

@@ -1,5 +0,0 @@
-# Implementation Tests
-
-These tests help you build whatever you're building to solve the behavioral tests.
-
-Implementation tests can safely be deleted when they break when you are changing the implementation. At that point, you can create new ones.

package/build/components/README.md

@@ -1,5 +0,0 @@
-# Components
-
-Components are ways to collect lots of input form a user that you can reuse in multiple Commands.
-
-Commands and components are the only places you should be asking for input.

package/src/__tests__/behavioral/README.md

@@ -1,8 +0,0 @@
-
-# Behavioral tests
-
-These are the tests that matter. They should test everything just under the interface. Interface tests can go into implementation since they'll often change.
-
-If all these pass, we ship.
-
-

package/src/__tests__/implementation/README.md

@@ -1,5 +0,0 @@
-# Implementation Tests
-
-These tests help you build whatever you're building to solve the behavioral tests.
-
-Implementation tests can safely be deleted when they break when you are changing the implementation. At that point, you can create new ones.

package/src/components/README.md

@@ -1,5 +0,0 @@
-# Components
-
-Components are ways to collect lots of input form a user that you can reuse in multiple Commands.
-
-Commands and components are the only places you should be asking for input.