feat: stick lastCompiledAt date to the build .adonisrc.json file

This helps some commands critical on always using the latest code
to have some idea around how stale the code is

Author: thetutlage

package-lock.json

@@ -95,6 +95,7 @@
     "@poppinss/utils": "^2.1.2",
     "chokidar": "^3.3.1",
     "cpy": "^8.0.1",
+    "debounce": "^1.2.0",
     "emittery": "^0.5.1",
     "execa": "^4.0.0",
     "fs-extra": "^8.1.0",

package.json

@@ -10,6 +10,7 @@
 import mem from 'mem'
 import slash from 'slash'
 import copyfiles from 'cpy'
+import debounce from 'debounce'
 import tsStatic from 'typescript'
 import { join, relative } from 'path'
 import { Logger } from '@poppinss/fancy-logs'
@@ -58,6 +59,11 @@ export class Compiler {
    */
   public manifest = new Manifest(this.appRoot, this.logger)
 
+  /**
+   * Same as [[this.writeRcFile]] but waits for 2secs
+   */
+  public touchRcFile = debounce(this.writeRcFile.bind(this), 2000)
+
   /**
    * Returns relative unix path from the project root. Used for
    * display only
@@ -75,6 +81,20 @@ export class Compiler {
     }, 'after')
   }
 
+  /**
+   * write .adonisrc.json file to the build directory
+   */
+  private async writeRcFile (outDir: string) {
+    await outputJSON(
+      join(outDir, RCFILE_NAME),
+      Object.assign({}, this.rcFile.getDiskContents(), {
+        typescript: false,
+        lastCompiledAt: new Date().toISOString(),
+      }),
+      { spaces: 2 },
+    )
+  }
+
   /**
    * Create the http server
    */
@@ -133,11 +153,7 @@ export class Compiler {
    */
   public async copyAdonisRcFile (outDir: string) {
     this.logger.info({ message: `copy ${RCFILE_NAME}`, suffix: this.getRelativeUnixPath(outDir) })
-    await outputJSON(
-      join(outDir, RCFILE_NAME),
-      Object.assign({}, this.rcFile.getDiskContents(), { typescript: false }),
-      { spaces: 2 },
-    )
+    await this.writeRcFile(outDir)
   }
 
   /**
@@ -194,9 +210,10 @@ export class Compiler {
     }
 
     await this.cleanupBuildDirectory(config.options.outDir!)
-    await this.copyAdonisRcFile(config.options.outDir!)
     await this.copyMetaFiles(config.options.outDir!)
     this.buildTypescriptSource(config)
+    await this.copyAdonisRcFile(config.options.outDir!)
+
     await this.manifest.generate()
 
     /**
@@ -224,9 +241,9 @@ export class Compiler {
       : ['package.json', 'yarn.lock']
 
     await this.cleanupBuildDirectory(config.options.outDir!)
-    await this.copyAdonisRcFile(config.options.outDir!)
     await this.copyMetaFiles(config.options.outDir!, pkgFiles)
     this.buildTypescriptSource(config)
+    await this.copyAdonisRcFile(config.options.outDir!)
 
     this.logger.info({ message: 'installing production dependencies', suffix: client })
     await new Installer(config.options.outDir!, client).install()

src/Compiler/index.ts

@@ -48,9 +48,9 @@ export class Watcher {
      * Standard build steps
      */
     await this.compiler.cleanupBuildDirectory(config.options.outDir!)
-    await this.compiler.copyAdonisRcFile(config.options.outDir!)
     await this.compiler.copyMetaFiles(config.options.outDir!)
     this.compiler.buildTypescriptSource(config)
+    await this.compiler.copyAdonisRcFile(config.options.outDir!)
 
     /**
      * Manifest can be generated without blocking the flow
@@ -83,7 +83,7 @@ export class Watcher {
     /**
      * Subsequent source builds
      */
-    watcher.on('subsequent:build', ({ path, skipped, diagnostics }) => {
+    watcher.on('subsequent:build', async ({ path, skipped, diagnostics }) => {
       this.clearScreen()
       this.logger.compile(path)
 
@@ -109,6 +109,8 @@ export class Watcher {
       if (this.compiler.rcFile.isCommandsPath(path)) {
         this.compiler.manifest.generate()
       }
+
+      await this.compiler.touchRcFile(config.options.outDir!)
     })
 
     /**

src/Watcher/index.ts

@@ -56,10 +56,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
     ])
 
     assert.isFalse(require(join(fs.basePath, 'build', '.adonisrc.json')).typescript)
@@ -99,10 +99,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
     ])
   }).timeout(0)
 
@@ -141,10 +141,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
     ])
   }).timeout(0)
 
@@ -182,10 +182,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build/dist))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build/dist))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
     ])
   }).timeout(0)
 
@@ -224,10 +224,10 @@ test.group('Compiler', (group) => {
 
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build/dist))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build/dist))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(red(error)) typescript compiler errors',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
     ])
   }).timeout(0)
 
@@ -267,11 +267,11 @@ test.group('Compiler', (group) => {
 
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build/dist))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build/dist))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(blue(info)) TS emit skipped',
       'underline(red(error)) typescript compiler errors',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build/dist))',
     ])
   }).timeout(0)
 
@@ -321,10 +321,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy public/**/*.(js|css),ace,package.json,package-lock.json dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) installing production dependencies dim(yellow(npm))',
     ])
 
@@ -368,10 +368,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, true, true, true, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy public/**/*.(js|css),ace dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(yellow(warn)) Unable to generate manifest file. Check the following error stack for more info',
     ])
 
@@ -410,10 +410,10 @@ test.group('Compiler', (group) => {
     assert.deepEqual(hasFiles, [true, false, true])
     assert.deepEqual(logger.logs, [
       'underline(blue(info)) cleaning up build directory dim(yellow(build))',
-      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(blue(info)) copy ace dim(yellow(build))',
       'underline(magenta(pending)) compiling typescript source files',
       'underline(green(success)) built successfully',
+      'underline(blue(info)) copy .adonisrc.json dim(yellow(build))',
       'underline(yellow(warn)) Unable to generate manifest file. Check the following error stack for more info',
     ])