@sprucelabs/spruce-cli 19.1.42 → 19.2.0

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

@@ -0,0 +1,54 @@
+import { SchemaValues, buildSchema } from '@sprucelabs/schema'
+import { namesUtil } from '@sprucelabs/spruce-skill-utils'
+import namedTemplateItemBuilder from '../../../schemas/v2020_07_22/namedTemplateItem.builder'
+import actionUtil from '../../../utilities/action.utility'
+import AbstractAction from '../../AbstractAction'
+import { FeatureActionResponse } from '../../features.types'
+
+export default class CreatePluginAction extends AbstractAction<OptionsSchema> {
+	public optionsSchema = optionsSchema
+	public invocationMessage = 'Creating a new view plugin... 🖼️'
+	public commandAliases: string[] = ['create.view.plugin']
+
+	public async execute(
+		options: SchemaValues<OptionsSchema>
+	): Promise<FeatureActionResponse> {
+		const { nameReadable, nameCamel, namePascal } =
+			this.validateAndNormalizeOptions(options)
+
+		const normalizedNameCamel = nameCamel ?? namesUtil.toCamel(nameReadable)
+		const normalizedNamePascal =
+			namePascal ?? namesUtil.toPascal(normalizedNameCamel)
+
+		const writer = this.Writer('view')
+		const files = await writer.writeViewControllerPlugin({
+			cwd: this.cwd,
+			nameCamel: normalizedNameCamel,
+			namePascal: normalizedNamePascal,
+		})
+
+		const sync = await this.Action('view', 'sync').execute({})
+
+		return actionUtil.mergeActionResults({ files }, sync)
+	}
+}
+
+const optionsSchema = buildSchema({
+	id: 'createViewPluginOptions',
+	fields: {
+		nameReadable: {
+			...namedTemplateItemBuilder.fields.nameReadable,
+			label: 'Plugin name',
+		},
+		nameCamel: {
+			...namedTemplateItemBuilder.fields.nameCamel,
+			isRequired: false,
+		},
+		namePascal: {
+			...namedTemplateItemBuilder.fields.namePascal,
+			isRequired: false,
+		},
+	},
+})
+
+type OptionsSchema = typeof optionsSchema

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

@@ -1,21 +1,16 @@
 import globby from '@sprucelabs/globby'
 import { buildSchema, SchemaValues } from '@sprucelabs/schema'
 import { diskUtil, namesUtil } from '@sprucelabs/spruce-skill-utils'
-import { VcTemplateItem } from '../../../../../spruce-templates/build'
+import {
+	VcTemplateItem,
+	ViewControllerPluginItem,
+} from '../../../../../spruce-templates/build'
 import introspectionUtil, {
 	IntrospectionClass,
 } from '../../../utilities/introspection.utility'
 import AbstractAction from '../../AbstractAction'
 import { FeatureActionResponse } from '../../features.types'
 
-const optionsSchema = buildSchema({
-	id: 'syncViewsOptions',
-	description: 'Keep types and generated files based on views in sync.',
-	fields: {},
-})
-
-type OptionsSchema = typeof optionsSchema
-
 export default class SyncAction extends AbstractAction<OptionsSchema> {
 	public optionsSchema: OptionsSchema = optionsSchema
 	public commandAliases = ['sync.views']
@@ -25,9 +20,12 @@ export default class SyncAction extends AbstractAction<OptionsSchema> {
 		_options: SchemaValues<OptionsSchema>
 	): Promise<FeatureActionResponse> {
 		const targetDir = diskUtil.resolvePath(this.cwd, 'src')
-		const matches = await globby(['**/*.svc.ts', '**/*.vc.ts'], {
-			cwd: targetDir,
-		})
+		const matches = await globby(
+			['**/*.svc.ts', '**/*.vc.ts', '**/*.view.plugin.ts'],
+			{
+				cwd: targetDir,
+			}
+		)
 
 		if (matches.length === 0) {
 			return {}
@@ -38,13 +36,17 @@ export default class SyncAction extends AbstractAction<OptionsSchema> {
 
 		const vcTemplateItems: VcTemplateItem[] = []
 		const svcTemplateItems: VcTemplateItem[] = []
+		const viewPluginItems: ViewControllerPluginItem[] = []
 
 		introspect.forEach(({ classes }) => {
 			for (const thisClass of classes) {
-				const { vc, svc } = this.mapIntrospectedClassToTemplateItem(thisClass)
+				const { vc, svc, plugin } =
+					this.mapIntrospectedClassToTemplateItem(thisClass)
 
 				if (vc) {
 					vcTemplateItems.push(vc)
+				} else if (plugin) {
+					viewPluginItems.push(plugin)
 				} else if (svc) {
 					svcTemplateItems.push(svc)
 				}
@@ -56,6 +58,7 @@ export default class SyncAction extends AbstractAction<OptionsSchema> {
 			namespaceKebab: namesUtil.toKebab(namespace),
 			vcTemplateItems,
 			svcTemplateItems,
+			viewPluginItems,
 		})
 
 		return {
@@ -66,6 +69,7 @@ export default class SyncAction extends AbstractAction<OptionsSchema> {
 	private mapIntrospectedClassToTemplateItem(c: IntrospectionClass): {
 		vc?: VcTemplateItem
 		svc?: VcTemplateItem
+		plugin?: ViewControllerPluginItem
 	} {
 		const item = {
 			id: c.staticProperties.id,
@@ -75,13 +79,25 @@ export default class SyncAction extends AbstractAction<OptionsSchema> {
 
 		let vc: VcTemplateItem | undefined
 		let svc: VcTemplateItem | undefined
+		let plugin: ViewControllerPluginItem | undefined
 
 		if (c.classPath.endsWith('.svc.ts')) {
 			svc = item
+		} else if (c.classPath.endsWith('view.plugin.ts')) {
+			const nameCamel = c.classPath.match(/([^/]+).view.plugin.ts$/)![1]
+			plugin = { ...item, nameCamel }
 		} else {
 			vc = item
 		}
 
-		return { svc, vc }
+		return { svc, vc, plugin }
 	}
 }
+
+const optionsSchema = buildSchema({
+	id: 'syncViewsOptions',
+	description: 'Keep types and generated files based on views in sync.',
+	fields: {},
+})
+
+type OptionsSchema = typeof optionsSchema

package/src/features/view/writers/ViewWriter.ts

@@ -1,6 +1,7 @@
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import {
 	VcTemplateItem,
+	ViewControllerPluginItem,
 	ViewsOptions,
 } from '../../../../../spruce-templates/build'
 import SpruceError from '../../../errors/SpruceError'
@@ -24,7 +25,8 @@ export default class ViewWriter extends AbstractWriter {
 	}
 
 	public async writeCombinedViewsFile(cwd: string, options: ViewsOptions) {
-		let { vcTemplateItems, svcTemplateItems, ...rest } = options
+		let { vcTemplateItems, svcTemplateItems, viewPluginItems, ...rest } =
+			options
 
 		const destinationDir = diskUtil.resolveHashSprucePath(cwd, 'views')
 		const destination = diskUtil.resolvePath(destinationDir, 'views.ts')
@@ -39,9 +41,15 @@ export default class ViewWriter extends AbstractWriter {
 			destinationDir
 		)
 
+		viewPluginItems = this.removeFileExtensionsFromTemplateItems(
+			viewPluginItems,
+			destinationDir
+		)
+
 		const contents = this.templates.views({
 			vcTemplateItems,
 			svcTemplateItems,
+			viewPluginItems,
 			...rest,
 		})
 
@@ -54,10 +62,9 @@ export default class ViewWriter extends AbstractWriter {
 		return results
 	}
 
-	private removeFileExtensionsFromTemplateItems(
-		vcTemplateItems: VcTemplateItem[],
-		destinationDir: string
-	): VcTemplateItem[] {
+	private removeFileExtensionsFromTemplateItems<
+		T extends VcTemplateItem | ViewControllerPluginItem,
+	>(vcTemplateItems: T[], destinationDir: string): T[] {
 		return vcTemplateItems.map((i) => ({
 			...i,
 			path: diskUtil
@@ -111,6 +118,39 @@ export default class ViewWriter extends AbstractWriter {
 		return diskUtil.doesFileExist(path)
 	}
 
+	public async writeViewControllerPlugin(options: {
+		cwd: string
+		nameCamel: string
+		namePascal: string
+	}) {
+		const { nameCamel, namePascal, cwd } = options
+
+		const destination = diskUtil.resolvePath(
+			cwd,
+			'src',
+			'viewPlugins',
+			`${nameCamel}.view.plugin.ts`
+		)
+
+		const contents = this.templates.viewControllerPlugin({
+			nameCamel,
+			namePascal,
+		})
+
+		if (diskUtil.doesFileExist(destination)) {
+			throw new SpruceError({
+				code: 'VIEW_PLUGIN_ALREADY_EXISTS',
+				name: nameCamel,
+			})
+		}
+
+		return this.writeFileIfChangedMixinResults(
+			destination,
+			contents,
+			`Your new view plugin!`
+		)
+	}
+
 	public writePlugin(cwd: string) {
 		const destination = diskUtil.resolveHashSprucePath(
 			cwd,