fix(cli): Generator fixes to work with the new guide (#2674)

daffl · web-flow · commit b773fa5dbd7f · 2022-06-21T23:01:39.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/src/app/templates/app.test.tpl.ts b/packages/cli/src/app/templates/app.test.tpl.ts
@@ -18,8 +18,8 @@ describe('Feathers application tests', () => {
     server = await app.listen(port)
   })
 
-  after(done => {
-    server.close(done)
+  after(async () => {
+    await app.teardown()
   })
 
   it('starts and shows the index page', async () => {
diff --git a/packages/cli/src/app/templates/channels.tpl.ts b/packages/cli/src/app/templates/channels.tpl.ts
@@ -24,8 +24,8 @@ export const channels = (app: Application) => {
     // connection can be undefined if there is no
     // real-time connection, e.g. when logging in via REST
     if(connection) {
-      // Obtain the logged in user from the connection
-      // const user = connection.user
+      // Obtain the logged in user
+      // const user = authResult.user
       
       // The connection is no longer anonymous, remove it
       app.channel('anonymous').leave(connection)
@@ -52,8 +52,6 @@ export const channels = (app: Application) => {
     // Here you can add event publishers to channels set up in \`channels.js\`
     // To publish only for a specific event use \`app.publish(eventname, () => {})\`
 
-    console.log('Publishing all events to all authenticated users. See \`channels.js\` and https://docs.feathersjs.com/api/channels.html for more information.') // eslint-disable-line
-
     // e.g. to publish all service events to all authenticated users use
     return app.channel('authenticated')
   })
diff --git a/packages/cli/src/app/templates/client.tpl.ts b/packages/cli/src/app/templates/client.tpl.ts
@@ -3,7 +3,8 @@ import { renderSource } from '../../commons'
 import { AppGeneratorContext } from '../index'
 
 const template = ({}: AppGeneratorContext) =>
-  `import { feathers, type Service, type TransportConnection } from '@feathersjs/feathers'
+  `import { feathers } from '@feathersjs/feathers'
+import type { Service, TransportConnection, Params } from '@feathersjs/feathers'
 
 // A mapping of client side services
 export interface ServiceTypes {
diff --git a/packages/cli/src/app/templates/tsconfig.json.tpl.ts b/packages/cli/src/app/templates/tsconfig.json.tpl.ts
@@ -13,11 +13,12 @@ export const generate = (ctx: AppGeneratorContext) =>
           compilerOptions: {
             target: 'es2020',
             module: 'commonjs',
-            outDir: './dist',
+            outDir: './lib',
             rootDir: `./${lib}`,
             strict: true,
             esModuleInterop: true
           },
+          include: [lib],
           exclude: ['test']
         }),
         toFile('tsconfig.json')
diff --git a/packages/cli/src/authentication/templates/knex.tpl.ts b/packages/cli/src/authentication/templates/knex.tpl.ts
@@ -39,21 +39,24 @@ export async function down(knex: Knex): Promise<void> {
 `
 
 export const generate = (ctx: AuthenticationGeneratorContext) =>
-  generator(ctx).then(
-    when(
-      (ctx) => getDatabaseAdapter(ctx.feathers.database) === 'knex',
-      renderSource(
-        migrationTemplate,
-        toFile(
-          toFile<AuthenticationGeneratorContext>('migrations', () => {
-            const now = new Date()
-            const migrationDate =
-              `${now.getUTCFullYear()}${now.getUTCMonth()}${now.getUTCDay()}` +
-              `${now.getUTCHours()}${now.getUTCMinutes()}${now.getUTCSeconds() + 1}`
+  generator(ctx)
+    // We need to wait a second otherwise the migration filenames won't be in the right order
+    .then(
+      (ctx) => new Promise<AuthenticationGeneratorContext>((resolve) => setTimeout(() => resolve(ctx), 1100))
+    )
+    .then(
+      when(
+        (ctx) => getDatabaseAdapter(ctx.feathers.database) === 'knex',
+        renderSource(
+          migrationTemplate,
+          toFile(
+            toFile<AuthenticationGeneratorContext>('migrations', () => {
+              // Probably not great but it works to align with the Knex migration file format
+              const migrationDate = new Date().toISOString().replace(/\D/g, '').substring(0, 14)
 
-            return `${migrationDate}_authentication`
-          })
+              return `${migrationDate}_authentication`
+            })
+          )
         )
       )
     )
-  )
diff --git a/packages/cli/src/connection/templates/knex.tpl.ts b/packages/cli/src/connection/templates/knex.tpl.ts
@@ -57,7 +57,7 @@ export const generate = (ctx: ConnectionGeneratorContext) =>
         {
           scripts: {
             migrate: 'knex migrate:latest',
-            'migrate:create': 'knex migrate:create',
+            'migrate:make': 'knex migrate:make',
             test: 'cross-env NODE_ENV=test npm run migrate && npm run mocha'
           }
         },
diff --git a/packages/cli/src/service/type/knex.tpl.ts b/packages/cli/src/service/type/knex.tpl.ts
@@ -51,10 +51,8 @@ export const generate = (ctx: ServiceGeneratorContext) =>
       renderSource(
         migrationTemplate,
         toFile<ServiceGeneratorContext>('migrations', ({ kebabName }) => {
-          const now = new Date()
-          const migrationDate =
-            `${now.getUTCFullYear()}${now.getUTCMonth()}${now.getUTCDay()}` +
-            `${now.getUTCHours()}${now.getUTCMinutes()}${now.getUTCSeconds()}`
+          // Probably not great but it works to align with the Knex migration file format
+          const migrationDate = new Date().toISOString().replace(/\D/g, '').substring(0, 14)
 
           return `${migrationDate}_${kebabName}`
         })
diff --git a/packages/cli/test/generators.test.ts b/packages/cli/test/generators.test.ts
@@ -35,7 +35,6 @@ describe('@feathersjs/cli', () => {
 
       before(async () => {
         cwd = await mkdtemp(path.join(os.tmpdir(), name + '-'))
-        console.log(cwd)
         context = await generate(
           getContext<AppGeneratorContext>(
             {
@@ -115,6 +114,14 @@ describe('@feathersjs/cli', () => {
         assert.ok(customServiceContext)
         assert.strictEqual(testResult, 0)
       })
+
+      it('compiles successfully', async () => {
+        if (language === 'ts' && framework === 'koa') {
+          const testResult = await context.pinion.exec('npm', ['run', 'compile'], { cwd })
+
+          assert.strictEqual(testResult, 0)
+        }
+      })
     })
   }
 })
diff --git a/packages/knex/package.json b/packages/knex/package.json
@@ -39,6 +39,7 @@
     "*.js"
   ],
   "scripts": {
+    "prepublish": "npm run compile",
     "compile": "shx rm -rf lib/ && tsc",
     "test": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
   },

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ export const generate = (ctx: ConnectionGeneratorContext) =>`
`57`	`57`	`{`
`58`	`58`	`scripts: {`
`59`	`59`	`migrate: 'knex migrate:latest',`
`60`		`- 'migrate:create': 'knex migrate:create',`
	`60`	`+ 'migrate:make': 'knex migrate:make',`
`61`	`61`	`test: 'cross-env NODE_ENV=test npm run migrate && npm run mocha'`
`62`	`62`	`}`
`63`	`63`	`},`