@rvoh/psychic 2.0.3 → 2.0.4

package/dist/cjs/src/cli/index.js

@@ -66,7 +66,7 @@ export default class PsychicCLI {
         program
             .command('generate:resource')
             .alias('g:resource')
-            .description('create a Dream model, migration, controller, serializer, and spec placeholders')
+            .description('Generates a Dream model with corresponding spec factory, serializer, migration, and controller with the inheritance chain leading to that controller, with fleshed out specs for each resourceful action in the controller.')
             .option('--singular', 'generates a "resource" route instead of "resources", along with the necessary controller and spec changes')
             .option('--only <onlyActions>', `comma separated list of resourceful endpionts (e.g. "--only=create,show"); any of:
                               - index
@@ -91,7 +91,7 @@ export default class PsychicCLI {
         program
             .command('generate:controller')
             .alias('g:controller')
-            .description('create a controller')
+            .description('Generates a controller and the inheritance chain leading to that controller, and a spec skeleton for the controller.')
             .argument('<controllerName>', 'the name of the controller to create, including namespaces, e.g. Posts or Api/V1/Posts')
             .argument('[actions...]', 'the names of controller actions to create')
             .action(async (controllerName, actions) => {
@@ -101,7 +101,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:enums')
-            .description('generates an initializer in your app for syncing enums to a particular path.')
+            .description('Generates an initializer in your app for syncing enums to a particular path.')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
             .option('--initializer-filename <initializerFilename>', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
             .action(async (outfile, { initializerName, }) => {
@@ -114,7 +114,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:openapi-redux')
-            .description('generates openapi redux bindings to connect one of your openapi files to one of your clients')
+            .description('Generates openapi redux bindings to connect one of your openapi files to one of your clients.')
             .option('--schema-file <schemaFile>', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./src/openapi/openapi.json')
             .option('--api-file <apiFile>', 'the path to the boilerplate api file that will be used to scaffold your backend endpoints together with, i.e. ../client/app/api.ts')
             .option('--api-import <apiImport>', 'the camelCased name of the export from your api module, i.e. emptyBackendApi')
@@ -136,7 +136,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:openapi-typescript')
-            .description('generates an initializer in your app for converting one of your openapi files to typescript')
+            .description('Generates an initializer in your app for converting one of your openapi files to typescript.')
             .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./src/openapi/openapi.json"')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the openapi types written to. Must end with .d.ts, i.e. "./src/conf/openapi/openapi.types.d.ts"')
             .option('--initializer-filename <initializerFilename>', 'the name you want the file to be in your initializers folder. defaults to `sync-openapi-typescript.ts`')
@@ -150,7 +150,7 @@ export default class PsychicCLI {
         });
         program
             .command('routes')
-            .description('examines your current models, building a type-map of the associations so that the ORM can understand your relational setup. This is commited to your repo, and synced to the dream repo for consumption within the underlying library.')
+            .description('Prints a list of routes defined by the application, including path arguments and the controller/action reached by the route.')
             .action(async () => {
             await initializePsychicApp();
             PsychicBin.printRoutes();
@@ -158,7 +158,7 @@ export default class PsychicCLI {
         });
         program
             .command('sync')
-            .description('sync introspects your database, updating your schema to reflect, and then syncs the new schema with the installed dream node module, allowing it provide your schema to the underlying kysely integration')
+            .description("Generates types from the current state of the database. Generates OpenAPI specs from @OpenAPI decorated controller actions. Additional sync actions may be customized with `on('cli:sync', async () => {})` in conf/app.ts or in an initializer in `conf/initializers/`.")
             .option('--ignore-errors')
             .option('--schema-only')
             .action(async (options) => {
@@ -184,13 +184,13 @@ export default class PsychicCLI {
         });
         program
             .command('sync:routes')
-            .description('reads the routes generated by your app and generates a cache file, which is then used to give autocomplete support to the route helper, amoongst other things.')
+            .description('Reads the routes generated by your app and generates a cache file, which is then used to give autocomplete support to the route helper and other things.')
             .action(async () => {
             await PsychicBin.syncRoutes();
         });
         program
             .command('sync:openapi')
-            .description('syncs openapi.json file to current state of all psychic controllers within the app')
+            .description('Syncs openapi.json file to current state of all psychic controllers within the app')
             .action(async () => {
             await initializePsychicApp();
             await PsychicBin.syncOpenapiJson();

package/dist/esm/src/cli/index.js

@@ -66,7 +66,7 @@ export default class PsychicCLI {
         program
             .command('generate:resource')
             .alias('g:resource')
-            .description('create a Dream model, migration, controller, serializer, and spec placeholders')
+            .description('Generates a Dream model with corresponding spec factory, serializer, migration, and controller with the inheritance chain leading to that controller, with fleshed out specs for each resourceful action in the controller.')
             .option('--singular', 'generates a "resource" route instead of "resources", along with the necessary controller and spec changes')
             .option('--only <onlyActions>', `comma separated list of resourceful endpionts (e.g. "--only=create,show"); any of:
                               - index
@@ -91,7 +91,7 @@ export default class PsychicCLI {
         program
             .command('generate:controller')
             .alias('g:controller')
-            .description('create a controller')
+            .description('Generates a controller and the inheritance chain leading to that controller, and a spec skeleton for the controller.')
             .argument('<controllerName>', 'the name of the controller to create, including namespaces, e.g. Posts or Api/V1/Posts')
             .argument('[actions...]', 'the names of controller actions to create')
             .action(async (controllerName, actions) => {
@@ -101,7 +101,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:enums')
-            .description('generates an initializer in your app for syncing enums to a particular path.')
+            .description('Generates an initializer in your app for syncing enums to a particular path.')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
             .option('--initializer-filename <initializerFilename>', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
             .action(async (outfile, { initializerName, }) => {
@@ -114,7 +114,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:openapi-redux')
-            .description('generates openapi redux bindings to connect one of your openapi files to one of your clients')
+            .description('Generates openapi redux bindings to connect one of your openapi files to one of your clients.')
             .option('--schema-file <schemaFile>', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./src/openapi/openapi.json')
             .option('--api-file <apiFile>', 'the path to the boilerplate api file that will be used to scaffold your backend endpoints together with, i.e. ../client/app/api.ts')
             .option('--api-import <apiImport>', 'the camelCased name of the export from your api module, i.e. emptyBackendApi')
@@ -136,7 +136,7 @@ export default class PsychicCLI {
         });
         program
             .command('setup:sync:openapi-typescript')
-            .description('generates an initializer in your app for converting one of your openapi files to typescript')
+            .description('Generates an initializer in your app for converting one of your openapi files to typescript.')
             .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./src/openapi/openapi.json"')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the openapi types written to. Must end with .d.ts, i.e. "./src/conf/openapi/openapi.types.d.ts"')
             .option('--initializer-filename <initializerFilename>', 'the name you want the file to be in your initializers folder. defaults to `sync-openapi-typescript.ts`')
@@ -150,7 +150,7 @@ export default class PsychicCLI {
         });
         program
             .command('routes')
-            .description('examines your current models, building a type-map of the associations so that the ORM can understand your relational setup. This is commited to your repo, and synced to the dream repo for consumption within the underlying library.')
+            .description('Prints a list of routes defined by the application, including path arguments and the controller/action reached by the route.')
             .action(async () => {
             await initializePsychicApp();
             PsychicBin.printRoutes();
@@ -158,7 +158,7 @@ export default class PsychicCLI {
         });
         program
             .command('sync')
-            .description('sync introspects your database, updating your schema to reflect, and then syncs the new schema with the installed dream node module, allowing it provide your schema to the underlying kysely integration')
+            .description("Generates types from the current state of the database. Generates OpenAPI specs from @OpenAPI decorated controller actions. Additional sync actions may be customized with `on('cli:sync', async () => {})` in conf/app.ts or in an initializer in `conf/initializers/`.")
             .option('--ignore-errors')
             .option('--schema-only')
             .action(async (options) => {
@@ -184,13 +184,13 @@ export default class PsychicCLI {
         });
         program
             .command('sync:routes')
-            .description('reads the routes generated by your app and generates a cache file, which is then used to give autocomplete support to the route helper, amoongst other things.')
+            .description('Reads the routes generated by your app and generates a cache file, which is then used to give autocomplete support to the route helper and other things.')
             .action(async () => {
             await PsychicBin.syncRoutes();
         });
         program
             .command('sync:openapi')
-            .description('syncs openapi.json file to current state of all psychic controllers within the app')
+            .description('Syncs openapi.json file to current state of all psychic controllers within the app')
             .action(async () => {
             await initializePsychicApp();
             await PsychicBin.syncOpenapiJson();

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "author": "RVOHealth",
   "repository": {
     "type": "git",