@sprucelabs/spruce-cli 22.1.2 → 22.1.4

package/src/.spruce/schemas/spruceCli/v2020_07_22/syncSchemasOptions.schema.ts

@@ -1,167 +1,168 @@
 import { SchemaRegistry } from '@sprucelabs/schema'
 import { SpruceSchemas } from '../../schemas.types'
 
-const syncSchemasOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.SyncSchemasOptionsSchema =
-    {
-        id: 'syncSchemasOptions',
-        version: 'v2020_07_22',
-        namespace: 'SpruceCli',
-        name: 'Sync schemas action',
-        description: 'Options for schema.sync.',
-        fields: {
-            /** Field types directory. Where field types and interfaces will be generated. */
-            fieldTypesDestinationDir: {
-                label: 'Field types directory',
-                type: 'text',
-                isPrivate: true,
-                hint: 'Where field types and interfaces will be generated.',
-                defaultValue: '#spruce/schemas',
-                options: undefined,
-            },
-            /** Addons lookup directory. Where I'll look for new schema fields to be registered. */
-            addonsLookupDir: {
-                label: 'Addons lookup directory',
-                type: 'text',
-                hint: "Where I'll look for new schema fields to be registered.",
-                defaultValue: 'src/addons',
-                options: undefined,
-            },
-            /** Generate field types. Should I generate field types too? */
-            generateFieldTypes: {
-                label: 'Generate field types',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should I generate field types too?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Schema types destination directory. Where I will generate schema types and interfaces. */
-            schemaTypesDestinationDirOrFile: {
-                label: 'Schema types destination directory',
-                type: 'text',
-                hint: 'Where I will generate schema types and interfaces.',
-                defaultValue: '#spruce/schemas',
-                options: undefined,
-            },
-            /** . Where I should look for your schema builders? */
-            schemaLookupDir: {
-                type: 'text',
-                hint: 'Where I should look for your schema builders?',
-                defaultValue: 'src/schemas',
-                options: undefined,
-            },
-            /** Module import. When other skills use your schemas, will they import them from a module? */
-            moduleToImportFromWhenRemote: {
-                label: 'Module import',
-                type: 'text',
-                hint: 'When other skills use your schemas, will they import them from a module?',
-                options: undefined,
-            },
-            /** Auto install missing dependencies. */
-            shouldInstallMissingDependencies: {
-                label: 'Auto install missing dependencies',
-                type: 'boolean',
-                options: undefined,
-            },
-            /** Enable versioning. Should we use versioning? */
-            shouldEnableVersioning: {
-                label: 'Enable versioning',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should we use versioning?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Global namespace. The name you'll use when accessing these schemas, e.g. SpruceSchemas */
-            globalSchemaNamespace: {
-                label: 'Global namespace',
-                type: 'text',
-                isPrivate: true,
-                hint: "The name you'll use when accessing these schemas, e.g. SpruceSchemas",
-                defaultValue: 'SpruceSchemas',
-                options: undefined,
-            },
-            /** Fetch remote schemas. I will pull in schemas from other features. */
-            shouldFetchRemoteSchemas: {
-                label: 'Fetch remote schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'I will pull in schemas from other features.',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Fetch local schemas. I will look in schemaLookupDir to load local schemas. */
-            shouldFetchLocalSchemas: {
-                label: 'Fetch local schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'I will look in schemaLookupDir to load local schemas.',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Fetch core schemas. Should I pull in core schemas too? */
-            shouldFetchCoreSchemas: {
-                label: 'Fetch core schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should I pull in core schemas too?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Generate core schemas. Used only for updating the @sprucelabs/spruce-core-schemas. Ensures core schemas are generated like local schemas. Also an alias for `--shouldFetchRemoteSchemas=false --shouldFetchCoreSchemas=false --generateStandaloneTypesFile. */
-            shouldGenerateCoreSchemaTypes: {
-                label: 'Generate core schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Used only for updating the @sprucelabs/spruce-core-schemas. Ensures core schemas are generated like local schemas. Also an alias for `--shouldFetchRemoteSchemas=false --shouldFetchCoreSchemas=false --generateStandaloneTypesFile.',
-                options: undefined,
-            },
-            /** Register built schemas. Should the schemas use the SchemaRegistry for tracking? */
-            registerBuiltSchemas: {
-                label: 'Register built schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should the schemas use the SchemaRegistry for tracking?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Delete directory if no schemas. Should I delete the schema directory if no schemas are found? */
-            deleteDestinationDirIfNoSchemas: {
-                label: 'Delete directory if no schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should I delete the schema directory if no schemas are found?',
-                defaultValue: false,
-                options: undefined,
-            },
-            /** Delete orphaned schemas. Should I delete schemas where the builders are missing? */
-            deleteOrphanedSchemas: {
-                label: 'Delete orphaned schemas',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'Should I delete schemas where the builders are missing?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Generate standalone types file. By default, I'll generate a types file that augments core types from @sprucelabs/spruce-core-schemas. Setting this to true will generate a stand alone types file. */
-            generateStandaloneTypesFile: {
-                label: 'Generate standalone types file',
-                type: 'boolean',
-                isPrivate: true,
-                hint: "By default, I'll generate a types file that augments core types from @sprucelabs/spruce-core-schemas. Setting this to true will generate a stand alone types file.",
-                defaultValue: false,
-                options: undefined,
-            },
-            /**  message. */
-            syncingMessage: {
-                label: ' message',
-                type: 'text',
-                isPrivate: true,
-                defaultValue: 'Syncing schemas...',
-                options: undefined,
-            },
-        },
-    }
+
+
+const syncSchemasOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.SyncSchemasOptionsSchema  = {
+	id: 'syncSchemasOptions',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: 'Sync schemas action',
+	description: 'Options for schema.sync.',
+	    fields: {
+	            /** Field types directory. Where field types and interfaces will be generated. */
+	            'fieldTypesDestinationDir': {
+	                label: 'Field types directory',
+	                type: 'text',
+	                isPrivate: true,
+	                hint: 'Where field types and interfaces will be generated.',
+	                defaultValue: "#spruce/schemas",
+	                options: undefined
+	            },
+	            /** Addons lookup directory. Where I'll look for new schema fields to be registered. */
+	            'addonsLookupDir': {
+	                label: 'Addons lookup directory',
+	                type: 'text',
+	                hint: 'Where I\'ll look for new schema fields to be registered.',
+	                defaultValue: "src/addons",
+	                options: undefined
+	            },
+	            /** Generate field types. Should I generate field types too? */
+	            'generateFieldTypes': {
+	                label: 'Generate field types',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should I generate field types too?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Schema types destination directory. Where I will generate schema types and interfaces. */
+	            'schemaTypesDestinationDirOrFile': {
+	                label: 'Schema types destination directory',
+	                type: 'text',
+	                hint: 'Where I will generate schema types and interfaces.',
+	                defaultValue: "#spruce/schemas",
+	                options: undefined
+	            },
+	            /** . Where I should look for your schema builders? */
+	            'schemaLookupDir': {
+	                type: 'text',
+	                hint: 'Where I should look for your schema builders?',
+	                defaultValue: "src/schemas",
+	                options: undefined
+	            },
+	            /** Module import. When other skills use your schemas, will they import them from a module? */
+	            'moduleToImportFromWhenRemote': {
+	                label: 'Module import',
+	                type: 'text',
+	                hint: 'When other skills use your schemas, will they import them from a module?',
+	                options: undefined
+	            },
+	            /** Auto install missing dependencies. */
+	            'shouldInstallMissingDependencies': {
+	                label: 'Auto install missing dependencies',
+	                type: 'boolean',
+	                options: undefined
+	            },
+	            /** Enable versioning. Should we use versioning? */
+	            'shouldEnableVersioning': {
+	                label: 'Enable versioning',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should we use versioning?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Global namespace. The name you'll use when accessing these schemas, e.g. SpruceSchemas */
+	            'globalSchemaNamespace': {
+	                label: 'Global namespace',
+	                type: 'text',
+	                isPrivate: true,
+	                hint: 'The name you\'ll use when accessing these schemas, e.g. SpruceSchemas',
+	                defaultValue: "SpruceSchemas",
+	                options: undefined
+	            },
+	            /** Fetch remote schemas. I will pull in schemas from other features. */
+	            'shouldFetchRemoteSchemas': {
+	                label: 'Fetch remote schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'I will pull in schemas from other features.',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Fetch local schemas. I will look in schemaLookupDir to load local schemas. */
+	            'shouldFetchLocalSchemas': {
+	                label: 'Fetch local schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'I will look in schemaLookupDir to load local schemas.',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Fetch core schemas. Should I pull in core schemas too? */
+	            'shouldFetchCoreSchemas': {
+	                label: 'Fetch core schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should I pull in core schemas too?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Generate core schemas. Used only for updating the @sprucelabs/spruce-core-schemas. Ensures core schemas are generated like local schemas. Also an alias for `--shouldFetchRemoteSchemas=false --shouldFetchCoreSchemas=false --generateStandaloneTypesFile. */
+	            'shouldGenerateCoreSchemaTypes': {
+	                label: 'Generate core schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Used only for updating the @sprucelabs/spruce-core-schemas. Ensures core schemas are generated like local schemas. Also an alias for `--shouldFetchRemoteSchemas=false --shouldFetchCoreSchemas=false --generateStandaloneTypesFile.',
+	                options: undefined
+	            },
+	            /** Register built schemas. Should the schemas use the SchemaRegistry for tracking? */
+	            'registerBuiltSchemas': {
+	                label: 'Register built schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should the schemas use the SchemaRegistry for tracking?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Delete directory if no schemas. Should I delete the schema directory if no schemas are found? */
+	            'deleteDestinationDirIfNoSchemas': {
+	                label: 'Delete directory if no schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should I delete the schema directory if no schemas are found?',
+	                defaultValue: false,
+	                options: undefined
+	            },
+	            /** Delete orphaned schemas. Should I delete schemas where the builders are missing? */
+	            'deleteOrphanedSchemas': {
+	                label: 'Delete orphaned schemas',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'Should I delete schemas where the builders are missing?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Generate standalone types file. By default, I'll generate a types file that augments core types from @sprucelabs/spruce-core-schemas. Setting this to true will generate a stand alone types file. */
+	            'generateStandaloneTypesFile': {
+	                label: 'Generate standalone types file',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'By default, I\'ll generate a types file that augments core types from @sprucelabs/spruce-core-schemas. Setting this to true will generate a stand alone types file.',
+	                defaultValue: false,
+	                options: undefined
+	            },
+	            /**  message. */
+	            'syncingMessage': {
+	                label: ' message',
+	                type: 'text',
+	                isPrivate: true,
+	                defaultValue: "Syncing schemas...",
+	                options: undefined
+	            },
+	    }
+}
 
 SchemaRegistry.getInstance().trackSchema(syncSchemasOptionsSchema)
 

package/src/.spruce/schemas/spruceCli/v2020_07_22/testOptions.schema.ts

@@ -1,66 +1,61 @@
 import { SchemaRegistry } from '@sprucelabs/schema'
 import { SpruceSchemas } from '../../schemas.types'
 
-const testOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.TestOptionsSchema =
-    {
-        id: 'testOptions',
-        version: 'v2020_07_22',
-        namespace: 'SpruceCli',
-        name: 'Test skill',
-        description: 'Test your might! 💪',
-        fields: {
-            /** Report while running. Should I output the test results while they are running? */
-            shouldReportWhileRunning: {
-                label: 'Report while running',
-                type: 'boolean',
-                hint: 'Should I output the test results while they are running?',
-                defaultValue: true,
-                options: undefined,
-            },
-            /** Pattern. I'll filter all tests that match this pattern */
-            pattern: {
-                label: 'Pattern',
-                type: 'text',
-                hint: "I'll filter all tests that match this pattern",
-                options: undefined,
-            },
-            /** Inspect. Pass --inspect related args to test process. */
-            inspect: {
-                label: 'Inspect',
-                type: 'number',
-                hint: 'Pass --inspect related args to test process.',
-                options: undefined,
-            },
-            /** Should wait for manual start?. */
-            shouldHoldAtStart: {
-                label: 'Should wait for manual start?',
-                type: 'boolean',
-                defaultValue: false,
-                options: undefined,
-            },
-            /** Wait until tests are finished. For testing. Returns immediately after executing test so the running process can be managed programatically. */
-            shouldReturnImmediately: {
-                label: 'Wait until tests are finished',
-                type: 'boolean',
-                isPrivate: true,
-                hint: 'For testing. Returns immediately after executing test so the running process can be managed programatically.',
-                defaultValue: false,
-                options: undefined,
-            },
-            /** Watch. */
-            watchMode: {
-                label: 'Watch',
-                type: 'select',
-                options: {
-                    choices: [
-                        { value: 'off', label: 'Off' },
-                        { value: 'standard', label: 'Standard' },
-                        { value: 'smart', label: 'Smart' },
-                    ],
-                },
-            },
-        },
-    }
+
+
+const testOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.TestOptionsSchema  = {
+	id: 'testOptions',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: 'Test skill',
+	description: 'Test your might! 💪',
+	    fields: {
+	            /** Report while running. Should I output the test results while they are running? */
+	            'shouldReportWhileRunning': {
+	                label: 'Report while running',
+	                type: 'boolean',
+	                hint: 'Should I output the test results while they are running?',
+	                defaultValue: true,
+	                options: undefined
+	            },
+	            /** Pattern. I'll filter all tests that match this pattern */
+	            'pattern': {
+	                label: 'Pattern',
+	                type: 'text',
+	                hint: 'I\'ll filter all tests that match this pattern',
+	                options: undefined
+	            },
+	            /** Inspect. Pass --inspect related args to test process. */
+	            'inspect': {
+	                label: 'Inspect',
+	                type: 'number',
+	                hint: 'Pass --inspect related args to test process.',
+	                options: undefined
+	            },
+	            /** Should wait for manual start?. */
+	            'shouldHoldAtStart': {
+	                label: 'Should wait for manual start?',
+	                type: 'boolean',
+	                defaultValue: false,
+	                options: undefined
+	            },
+	            /** Wait until tests are finished. For testing. Returns immediately after executing test so the running process can be managed programatically. */
+	            'shouldReturnImmediately': {
+	                label: 'Wait until tests are finished',
+	                type: 'boolean',
+	                isPrivate: true,
+	                hint: 'For testing. Returns immediately after executing test so the running process can be managed programatically.',
+	                defaultValue: false,
+	                options: undefined
+	            },
+	            /** Watch. */
+	            'watchMode': {
+	                label: 'Watch',
+	                type: 'select',
+	                options: {choices: [{"value":"off","label":"Off"},{"value":"standard","label":"Standard"},{"value":"smart","label":"Smart"}],}
+	            },
+	    }
+}
 
 SchemaRegistry.getInstance().trackSchema(testOptionsSchema)
 

package/src/.spruce/schemas/spruceCli/v2020_07_22/upgradeSkillOptions.schema.ts

@@ -1,36 +1,24 @@
 import { SchemaRegistry } from '@sprucelabs/schema'
 import { SpruceSchemas } from '../../schemas.types'
 
-const upgradeSkillOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.UpgradeSkillOptionsSchema =
-    {
-        id: 'upgradeSkillOptions',
-        version: 'v2020_07_22',
-        namespace: 'SpruceCli',
-        name: 'Upgrade skill action',
-        description:
-            'Upgrade. Everything. Heads up, this can take a few minutes. ⏱',
-        fields: {
-            /** Upgrade mode. */
-            upgradeMode: {
-                label: 'Upgrade mode',
-                type: 'select',
-                defaultValue: 'askForChanged',
-                options: {
-                    choices: [
-                        {
-                            value: 'askForChanged',
-                            label: 'Ask for changed files',
-                        },
-                        { value: 'forceEverything', label: 'Force everything' },
-                        {
-                            value: 'forceRequiredSkipRest',
-                            label: 'Force required (skipping all non-essential)',
-                        },
-                    ],
-                },
-            },
-        },
-    }
+
+
+const upgradeSkillOptionsSchema: SpruceSchemas.SpruceCli.v2020_07_22.UpgradeSkillOptionsSchema  = {
+	id: 'upgradeSkillOptions',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: 'Upgrade skill action',
+	description: 'Upgrade. Everything. Heads up, this can take a few minutes. ⏱',
+	    fields: {
+	            /** Upgrade mode. */
+	            'upgradeMode': {
+	                label: 'Upgrade mode',
+	                type: 'select',
+	                defaultValue: "askForChanged",
+	                options: {choices: [{"value":"askForChanged","label":"Ask for changed files"},{"value":"forceEverything","label":"Force everything"},{"value":"forceRequiredSkipRest","label":"Force required (skipping all non-essential)"}],}
+	            },
+	    }
+}
 
 SchemaRegistry.getInstance().trackSchema(upgradeSkillOptionsSchema)
 

package/src/.spruce/schemas/spruceCli/v2020_07_22/watcherDidDetectChangesEmitPayload.schema.ts

@@ -1,32 +1,25 @@
 import { SchemaRegistry } from '@sprucelabs/schema'
-import generatedDirSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/generatedDir.schema'
-import generatedFileSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/generatedFile.schema'
 import { SpruceSchemas } from '../../schemas.types'
 
-const watcherDidDetectChangesEmitPayloadSchema: SpruceSchemas.SpruceCli.v2020_07_22.WatcherDidDetectChangesEmitPayloadSchema =
-    {
-        id: 'watcherDidDetectChangesEmitPayload',
-        version: 'v2020_07_22',
-        namespace: 'SpruceCli',
-        name: 'Watcher did detect changes emit payload',
-        fields: {
-            /** . */
-            changes: {
-                type: 'schema',
-                isRequired: true,
-                isArray: true,
-                options: {
-                    schemas: [
-                        generatedFileSchema_v2020_07_22,
-                        generatedDirSchema_v2020_07_22,
-                    ],
-                },
-            },
-        },
-    }
+import generatedFileSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/generatedFile.schema'
+import generatedDirSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/generatedDir.schema'
+
+const watcherDidDetectChangesEmitPayloadSchema: SpruceSchemas.SpruceCli.v2020_07_22.WatcherDidDetectChangesEmitPayloadSchema  = {
+	id: 'watcherDidDetectChangesEmitPayload',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: 'Watcher did detect changes emit payload',
+	    fields: {
+	            /** . */
+	            'changes': {
+	                type: 'schema',
+	                isRequired: true,
+	                isArray: true,
+	                options: {schemas: [generatedFileSchema_v2020_07_22, generatedDirSchema_v2020_07_22],}
+	            },
+	    }
+}
 
-SchemaRegistry.getInstance().trackSchema(
-    watcherDidDetectChangesEmitPayloadSchema
-)
+SchemaRegistry.getInstance().trackSchema(watcherDidDetectChangesEmitPayloadSchema)
 
 export default watcherDidDetectChangesEmitPayloadSchema

package/src/features/skill/actions/RegisterAction.ts

@@ -75,11 +75,11 @@ const optionsSchema = buildSchema({
             type: 'text',
             label: 'Namespace',
             isRequired: true,
-            hint: 'The namespace of your skill in-kebab-case',
+            hint: 'The namespace of your skill in-kebab-case.',
         },
         description: {
             type: 'text',
-            label: 'Describe your skill',
+            label: 'Describe your skill.',
         },
     },
 })

package/src/features/vscode/actions/SetupAction.ts

@@ -15,15 +15,19 @@ export default class SetupAction extends AbstractAction<OptionsSchema> {
     private recommendedExtensions: Extension[] = [
         {
             id: 'dbaeumer.vscode-eslint',
-            label: 'ESLint syntax validation and fixing',
+            label: 'ESLint syntax validation and fixing. Formats your code on save for you.',
         },
         {
             id: 'christian-kohler.npm-intellisense',
-            label: 'Intellisense autocompletion of installed npm modules',
+            label: 'Intellisense autocompletion of installed npm modules in your package.json.',
         },
         {
             id: 'mikestead.dotenv',
-            label: '.env support',
+            label: '.env formatting support right in vscode!',
+        },
+        {
+            id: 'YoavBls.pretty-ts-errors',
+            label: 'Pretty TypeScript errors and warnings. Makes them much easier to read.',
         },
     ]
 

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

@@ -12,6 +12,7 @@ export default buildSchema({
             type: 'text',
             isRequired: true,
             label: "What's the name of your skill?",
+            hint: 'This marketing focused, like "8-bit Stories" or "Adventures".',
         },
         description: {
             type: 'text',