@sprucelabs/spruce-cli/src/features/view/ViewFeature.ts

Command line interface for building Spruce skills.

import { diskUtil } from '@sprucelabs/spruce-skill-utils'
import { NpmPackage } from '../../types/cli.types'
import AbstractFeature, { FeatureDependency } from '../AbstractFeature'
import { ActionOptions, FeatureCode } from '../features.types'

export default class ViewFeature extends AbstractFeature {
    public nameReadable = 'views'
    public description = 'Views: Create views using the Heartwood framework.'
    public code: FeatureCode = 'view'
    public actionsDir = diskUtil.resolvePath(__dirname, 'actions')

    public readonly packageDependencies: NpmPackage[] = [
        {
            name: '@sprucelabs/heartwood-view-controllers@latest',
        },
        {
            name: '@sprucelabs/spruce-view-plugin@latest',
        },
    ]

    public dependencies: FeatureDependency[] = [
        {
            code: 'node',
            isRequired: true,
        },
        {
            code: 'schema',
            isRequired: true,
        },
        {
            code: 'event',
            isRequired: true,
        },
    ]

    public constructor(options: ActionOptions) {
        super(options)

        void this.emitter.on('feature.did-execute', async (payload) => {
            const { featureCode, actionCode } = payload
            const isInstalled = await this.features.isInstalled('view')

            if (
                isInstalled &&
                featureCode === 'node' &&
                actionCode === 'upgrade'
            ) {
                const files = await this.handleDidExecuteUpgrade()
                return {
                    files,
                }
            }
            return {}
        })

        void this.emitter.on(
            'test.register-abstract-test-classes',
            async () => {
                return {
                    abstractClasses: [
                        {
                            name: 'AbstractViewControllerTest',
                            label: 'AbstractViewControllerTest',
                            import: '@sprucelabs/spruce-view-plugin',
                            featureCode: 'view',
                        },
                    ],
                }
            }
        )
    }

    private async handleDidExecuteUpgrade() {
        const files = await this.Writer('view').writePlugin(this.cwd)
        const results = await this.Action('view', 'sync').execute({})

        return [...files, ...(results?.files ?? [])]
    }

    public async afterPackageInstall() {
        const files = await this.Writer('view').writePlugin(this.cwd)

        this.Service('dependency').add({
            id: '**',
            namespace: 'heartwood',
        })

        return { files }
    }
}

declare module '../../features/features.types' {
    interface FeatureMap {
        view: ViewFeature
    }

    interface FeatureOptionsMap {
        view: undefined
    }
}