feat(cli): Improve generated application folder structure (#2678)

packages/cli/src/app/templates/app.tpl.ts

@@ -10,7 +10,7 @@ import { koa, rest, bodyParser, errorHandler, parseAuthentication } from '@feath
 ${transports.includes('websockets') ? "import socketio from '@feathersjs/socketio'" : ''}
 
 import type { Application } from './declarations'
-import { configurationSchema } from './schemas/configuration.schema'
+import { configurationSchema } from './configuration'
 import { logErrorHook } from './logger'
 import { services } from './services/index'
 import { channels } from './channels'
@@ -63,7 +63,7 @@ import configuration from '@feathersjs/configuration'
 ${transports.includes('websockets') ? "import socketio from '@feathersjs/socketio'" : ''}
 
 import type { Application } from './declarations'
-import { configurationSchema } from './schemas/configuration.schema'
+import { configurationSchema } from './configuration'
 import { logger, logErrorHook } from './logger'
 import { services } from './services/index'
 import { channels } from './channels'

packages/cli/src/app/templates/configuration.tpl.ts

@@ -7,27 +7,30 @@ const template = ({}: AppGeneratorContext) =>
 import type { Infer } from '@feathersjs/schema'
 import { authenticationSettingsSchema } from '@feathersjs/authentication'
 
-export const configurationSchema = schema({
-  $id: 'ApplicationConfiguration',
-  type: 'object',
-  additionalProperties: false,
-  required: [ 'host', 'port', 'public', 'paginate' ],
-  properties: {
-    host: { type: 'string' },
-    port: { type: 'number' },
-    public: { type: 'string' },
-    authentication: authenticationSettingsSchema,
-    paginate: {
-      type: 'object',
-      additionalProperties: false,
-      required: [ 'default', 'max' ],
-      properties: {
-        default: { type: 'number' },
-        max: { type: 'number' }
+export const configurationSchema = schema(
+  {
+    $id: 'ApplicationConfiguration',
+    type: 'object',
+    additionalProperties: false,
+    required: [ 'host', 'port', 'public', 'paginate' ],
+    properties: {
+      host: { type: 'string' },
+      port: { type: 'number' },
+      public: { type: 'string' },
+      authentication: authenticationSettingsSchema,
+      paginate: {
+        type: 'object',
+        additionalProperties: false,
+        required: [ 'default', 'max' ],
+        properties: {
+          default: { type: 'number' },
+          max: { type: 'number' }
+        }
       }
     }
-  }
-} as const, new Ajv())
+  } as const,
+  new Ajv()
+)
 
 export type ConfigurationSchema = Infer<typeof configurationSchema>
 `
@@ -36,6 +39,6 @@ export const generate = (ctx: AppGeneratorContext) =>
   generator(ctx).then(
     renderSource(
       template,
-      toFile<AppGeneratorContext>(({ lib }) => lib, 'schemas', 'configuration.schema')
+      toFile<AppGeneratorContext>(({ lib }) => lib, 'configuration')
     )
   )

packages/cli/src/app/templates/declarations.tpl.ts

@@ -4,7 +4,7 @@ import { AppGeneratorContext } from '../index'
 const template = ({ framework }: AppGeneratorContext) =>
   `import { HookContext as FeathersHookContext, NextFunction } from '@feathersjs/feathers'
 import { Application as FeathersApplication } from '@feathersjs/${framework}'
-import { ConfigurationSchema } from './schemas/configuration.schema'
+import { ConfigurationSchema } from './configuration'
 
 export { NextFunction }
 

packages/cli/src/authentication/templates/authentication.tpl.ts

@@ -1,5 +1,5 @@
-import { generator, inject, before, toFile } from '@feathershq/pinion'
-import { getSource, renderSource } from '../../commons'
+import { generator, before, toFile } from '@feathershq/pinion'
+import { injectSource, renderSource } from '../../commons'
 import { AuthenticationGeneratorContext } from '../index'
 
 const template = ({ authStrategies, feathers }: AuthenticationGeneratorContext) =>
@@ -39,7 +39,7 @@ export const authentication = (app: Application) => {
 
 const importTemplate = "import { authentication } from './authentication'"
 const configureTemplate = 'app.configure(authentication)'
-const toAppFile = toFile<AuthenticationGeneratorContext>(({ lib, language }) => [lib, `app.${language}`])
+const toAppFile = toFile<AuthenticationGeneratorContext>(({ lib }) => [lib, 'app'])
 
 export const generate = (ctx: AuthenticationGeneratorContext) =>
   generator(ctx)
@@ -49,5 +49,5 @@ export const generate = (ctx: AuthenticationGeneratorContext) =>
         toFile<AuthenticationGeneratorContext>(({ lib }) => lib, 'authentication')
       )
     )
-    .then(inject(getSource(importTemplate), before('import { services } from'), toAppFile))
-    .then(inject(getSource(configureTemplate), before('app.configure(services)'), toAppFile))
+    .then(injectSource(importTemplate, before('import { services } from'), toAppFile))
+    .then(injectSource(configureTemplate, before('app.configure(services)'), toAppFile))

packages/cli/src/authentication/templates/declarations.tpl.ts

@@ -1,8 +1,8 @@
 import { generator, inject, before, toFile, when, append } from '@feathershq/pinion'
 import { AuthenticationGeneratorContext } from '../index'
 
-const importTemplate = ({ upperName, schemaPath }: AuthenticationGeneratorContext) =>
-  `import { ${upperName}Result } from './${schemaPath}'
+const importTemplate = ({ upperName, folder, fileName }: AuthenticationGeneratorContext) =>
+  `import { ${upperName}Result } from './services/${folder.join('/')}/${fileName}.schema'
 `
 
 const paramsTemplate = ({

packages/cli/src/authentication/templates/test.tpl.ts

@@ -2,9 +2,9 @@ import { generator, toFile } from '@feathershq/pinion'
 import { renderSource } from '../../commons'
 import { AuthenticationGeneratorContext } from '../index'
 
-const template = ({ authStrategies, relative, lib }: AuthenticationGeneratorContext) =>
+const template = ({ authStrategies, lib }: AuthenticationGeneratorContext) =>
   `import assert from 'assert';
-import { app } from '${relative}/${lib}/app';
+import { app } from '../${lib}/app';
 
 describe('authentication', () => {
   ${

packages/cli/src/authentication/templates/user.resolver.tpl.ts

@@ -8,7 +8,7 @@ const template = ({
   relative,
   authStrategies,
   type,
-  schemaPath
+  fileName
 }: AuthenticationGeneratorContext) =>
   `import { resolve } from '@feathersjs/schema'
 ${authStrategies.includes('local') ? `import { passwordHash } from '@feathersjs/authentication-local'` : ''}
@@ -18,13 +18,13 @@ import type {
   ${upperName}Patch,
   ${upperName}Result,
   ${upperName}Query,
-} from '../${schemaPath}' 
+} from './${fileName}.schema'
 import {
   ${camelName}DataSchema,
   ${camelName}PatchSchema,
   ${camelName}ResultSchema,
   ${camelName}QuerySchema
-} from '../${schemaPath}'
+} from './${fileName}.schema'
 
 
 // Resolver for the basic data model (e.g. creating new entries)
@@ -98,11 +98,11 @@ export const generate = (ctx: AuthenticationGeneratorContext) =>
   generator(ctx).then(
     renderSource(
       template,
-      toFile(({ lib, folder, kebabName }: AuthenticationGeneratorContext) => [
+      toFile(({ lib, folder, fileName }: AuthenticationGeneratorContext) => [
         lib,
-        'resolvers',
+        'services',
         ...folder,
-        `${kebabName}.resolver`
+        `${fileName}.resolver`
       ]),
       { force: true }
     )

packages/cli/src/authentication/templates/user.schema.tpl.ts

@@ -76,11 +76,11 @@ export const generate = (ctx: AuthenticationGeneratorContext) =>
   generator(ctx).then(
     renderSource(
       template,
-      toFile(({ lib, folder, kebabName }: AuthenticationGeneratorContext) => [
+      toFile(({ lib, folder, fileName }: AuthenticationGeneratorContext) => [
         lib,
-        'schemas',
+        'services',
         ...folder,
-        `${kebabName}.schema`
+        `${fileName}.schema`
       ]),
       { force: true }
     )

packages/cli/src/commons.ts

@@ -1,5 +1,14 @@
 import { PackageJson } from 'type-fest'
-import { Callable, PinionContext, loadJSON, fromFile, getCallable, renderTemplate } from '@feathershq/pinion'
+import {
+  Callable,
+  PinionContext,
+  loadJSON,
+  fromFile,
+  getCallable,
+  renderTemplate,
+  inject,
+  Location
+} from '@feathershq/pinion'
 import * as ts from 'typescript'
 import prettier from 'prettier'
 import path from 'path'
@@ -145,8 +154,7 @@ export const getJavaScript = (typescript: string, options: ts.TranspileOptions =
 }
 
 /**
- * Render a source file template for the language set in the context. Will do nothing
- * it there is no template for the selected language.
+ * Render a source file template for the language set in the context.
  *
  * @param templates The JavaScript and TypeScript template to render
  * @param toFile The target filename without extension (will be added based on language)
@@ -159,10 +167,6 @@ export const renderSource =
     options?: { force: boolean }
   ) =>
   async (ctx: C) => {
-    if (!template) {
-      return ctx
-    }
-
     const { language } = ctx
     const fileName = await getCallable<string, C>(toFile, ctx)
     const content = language === 'js' ? getJavaScript(await getCallable<string, C>(template, ctx)) : template
@@ -172,16 +176,27 @@ export const renderSource =
   }
 
 /**
- * Returns the TypeScript or transpiled JavaScript source code
+ * Inject a source template as the language set in the context.
  *
- * @param template The source template
+ * @param template The source template to render
+ * @param location The location to inject the code to. Must use the target language.
+ * @param target The target file name
+ * @param transpile Set to `false` if the code should not be transpiled to JavaScript
  * @returns
  */
-export const getSource =
-  <C extends PinionContext & { language: 'js' | 'ts' }>(template: Callable<string, C>) =>
-  async <T extends C>(ctx: T) => {
+export const injectSource =
+  <C extends PinionContext & { language: 'js' | 'ts' }>(
+    template: Callable<string, C>,
+    location: Location<C>,
+    target: Callable<string, C>,
+    transpile = true
+  ) =>
+  async (ctx: C) => {
     const { language } = ctx
-    const source = await getCallable<string, C>(template, ctx)
+    const source =
+      language === 'js' && transpile ? getJavaScript(await getCallable<string, C>(template, ctx)) : template
+    const toFile = await getCallable<string, C>(target, ctx)
+    const injector = inject(source, location, `${toFile}.${language}`)
 
-    return language === 'js' ? getJavaScript(source) : source
+    return injector(ctx)
   }

packages/cli/src/connection/templates/knex.tpl.ts

@@ -1,6 +1,6 @@
-import { generator, toFile, inject, before, mergeJSON } from '@feathershq/pinion'
+import { generator, toFile, before, mergeJSON } from '@feathershq/pinion'
 import { ConnectionGeneratorContext } from '../index'
-import { getSource, renderSource } from '../../commons'
+import { injectSource, renderSource } from '../../commons'
 
 const template = ({ database }: ConnectionGeneratorContext) =>
   `import knex from 'knex'
@@ -30,18 +30,18 @@ const config = app.get('${database}')
 ${language === 'js' ? 'export default config' : 'module.exports = config'}
 `
 
-const configurationTemplate = ({ database }: ConnectionGeneratorContext) => `    ${database}: {
-    type: 'object',
-    properties: {
-      client: { type: 'string' },
-      connection: { type: 'string' }
-    }
-  },`
+const configurationTemplate = ({ database }: ConnectionGeneratorContext) => `     ${database}: {
+        type: 'object',
+        properties: {
+          client: { type: 'string' },
+          connection: { type: 'string' }
+        }
+      },`
 
 const importTemplate = ({ database }: ConnectionGeneratorContext) =>
   `import { ${database} } from './${database}'`
 const configureTemplate = ({ database }: ConnectionGeneratorContext) => `app.configure(${database})`
-const toAppFile = toFile<ConnectionGeneratorContext>(({ lib, language }) => [lib, `app.${language}`])
+const toAppFile = toFile<ConnectionGeneratorContext>(({ lib }) => [lib, 'app'])
 
 export const generate = (ctx: ConnectionGeneratorContext) =>
   generator(ctx)
@@ -65,15 +65,12 @@ export const generate = (ctx: ConnectionGeneratorContext) =>
       )
     )
     .then(
-      inject(
+      injectSource(
         configurationTemplate,
         before('authentication: authenticationSettingsSchema'),
-        toFile<ConnectionGeneratorContext>(({ lib, language }) => [
-          lib,
-          'schemas',
-          `configuration.schema.${language}`
-        ])
+        toFile<ConnectionGeneratorContext>(({ lib }) => [lib, 'configuration']),
+        false
       )
     )
-    .then(inject(getSource(importTemplate), before('import { services } from'), toAppFile))
-    .then(inject(getSource(configureTemplate), before('app.configure(services)'), toAppFile))
+    .then(injectSource(importTemplate, before('import { services } from'), toAppFile))
+    .then(injectSource(configureTemplate, before('app.configure(services)'), toAppFile))

packages/cli/src/connection/templates/mongodb.tpl.ts

@@ -1,6 +1,6 @@
-import { generator, toFile, inject, before } from '@feathershq/pinion'
+import { generator, toFile, before } from '@feathershq/pinion'
 import { ConnectionGeneratorContext } from '../index'
-import { getSource, renderSource } from '../../commons'
+import { injectSource, renderSource } from '../../commons'
 
 const template = ({}: ConnectionGeneratorContext) =>
   `import { MongoClient } from 'mongodb'
@@ -22,11 +22,12 @@ export const mongodb = (app: Application) => {
   app.set('mongodbClient', mongoClient)
 }
 `
+
 const configurationTemplate = ({ database }: ConnectionGeneratorContext) =>
-  `    ${database}: { type: 'string' },`
+  `   ${database}: { type: 'string' },`
 const importTemplate = "import { mongodb } from './mongodb'"
 const configureTemplate = 'app.configure(mongodb)'
-const toAppFile = toFile<ConnectionGeneratorContext>(({ lib, language }) => [lib, `app.${language}`])
+const toAppFile = toFile<ConnectionGeneratorContext>(({ lib }) => [lib, 'app'])
 
 export const generate = (ctx: ConnectionGeneratorContext) =>
   generator(ctx)
@@ -37,15 +38,12 @@ export const generate = (ctx: ConnectionGeneratorContext) =>
       )
     )
     .then(
-      inject(
+      injectSource(
         configurationTemplate,
         before('authentication: authenticationSettingsSchema'),
-        toFile<ConnectionGeneratorContext>(({ lib, language }) => [
-          lib,
-          'schemas',
-          `configuration.schema.${language}`
-        ])
+        toFile<ConnectionGeneratorContext>(({ lib }) => [lib, 'configuration']),
+        false
       )
     )
-    .then(inject(getSource(importTemplate), before('import { services } from'), toAppFile))
-    .then(inject(getSource(configureTemplate), before('app.configure(services)'), toAppFile))
+    .then(injectSource(importTemplate, before('import { services } from'), toAppFile))
+    .then(injectSource(configureTemplate, before('app.configure(services)'), toAppFile))