feat: add type-check command

Author: thetutlage

commands/TypeCheck.ts

@@ -0,0 +1,50 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { BaseCommand, flags } from '@adonisjs/core/build/standalone'
+import { TSCONFIG_FILE_NAME } from '../config/paths'
+
+/**
+ * TypeCheck project without writing the compiled output to the disk
+ */
+export default class TypeCheck extends BaseCommand {
+  public static commandName = 'type-check'
+  public static description =
+    'Type check TypeScript source without writing the compiled output on disk'
+
+  /**
+   * Path to the TypeScript project configuration file. Defaults to "tsconfig.json"
+   */
+  @flags.string({
+    description: 'Path to the TypeScript project configuration file',
+  })
+  public tsconfig: string = TSCONFIG_FILE_NAME
+
+  /**
+   * Invoked automatically by ace
+   */
+  public async run() {
+    const { Compiler } = await import('../src/Compiler')
+
+    try {
+      const compiler = new Compiler(this.application.appRoot, [], false, this.logger, this.tsconfig)
+      const success = await compiler.typeCheck()
+
+      /**
+       * Set exitCode based upon the typecheck status
+       */
+      if (!success) {
+        this.exitCode = 1
+      }
+    } catch (error) {
+      this.logger.fatal(error)
+      this.exitCode = 1
+    }
+  }
+}

src/Compiler/index.ts

@@ -155,6 +155,31 @@ export class Compiler {
     )
   }
 
+  /**
+   * Typecheck the project without emit
+   */
+  public async typeCheck(): Promise<boolean> {
+    const config = this.ts.parseConfig()
+    if (!config) {
+      return false
+    }
+
+    this.logger.info('type checking typescript source files')
+
+    config.options.noEmit = true
+    const builder = this.ts.tsCompiler.builder(config)
+    const { diagnostics } = builder.build()
+
+    if (diagnostics.length) {
+      this.logger.error('typescript compiler errors')
+      this.ts.renderDiagnostics(diagnostics, builder.host)
+      return false
+    }
+
+    this.logger.success('built successfully')
+    return true
+  }
+
   /**
    * Compile project. See [[Compiler.compileForProduction]] for
    * production build

test/compiler.spec.ts

@@ -794,4 +794,110 @@ test.group('Compiler', (group) => {
 
     assert.deepEqual(hasFiles, [true, true, false])
   }).timeout(0)
+
+  test('typecheck and report typescript errors', async (assert) => {
+    await fs.add(
+      '.adonisrc.json',
+      JSON.stringify({
+        typescript: true,
+        metaFiles: ['public/**/*.(js|css)'],
+      })
+    )
+
+    await fs.add(
+      'tsconfig.json',
+      JSON.stringify({
+        include: ['**/*'],
+        exclude: ['build'],
+        compilerOptions: {
+          rootDir: './',
+          outDir: 'build/dist',
+        },
+      })
+    )
+
+    await fs.add('ace', '')
+    await fs.add('src/foo.ts', "import path from 'path'")
+    await fs.add('public/styles/main.css', '')
+    await fs.add('public/scripts/main.js', '')
+
+    const compiler = new Compiler(fs.basePath, [], false, ui.logger)
+    const isValid = await compiler.typeCheck()
+
+    assert.isFalse(isValid)
+    const hasFiles = await Promise.all(
+      [
+        'build/dist/.adonisrc.json',
+        'build/dist/src/foo.js',
+        'build/dist/public/styles/main.css',
+        'build/dist/public/scripts/main.js',
+      ].map((file) => fs.fsExtra.pathExists(join(fs.basePath, file)))
+    )
+
+    assert.deepEqual(hasFiles, [false, false, false, false])
+
+    assert.deepEqual(ui.testingRenderer.logs, [
+      {
+        message: `${info}  type checking typescript source files`,
+        stream: 'stdout',
+      },
+      {
+        message: `${error}  typescript compiler errors`,
+        stream: 'stderr',
+      },
+    ])
+  }).timeout(0)
+
+  test('complete successfully when typechecking has no errors', async (assert) => {
+    await fs.add(
+      '.adonisrc.json',
+      JSON.stringify({
+        typescript: true,
+        metaFiles: ['public/**/*.(js|css)'],
+      })
+    )
+
+    await fs.add(
+      'tsconfig.json',
+      JSON.stringify({
+        include: ['**/*'],
+        exclude: ['build'],
+        compilerOptions: {
+          rootDir: './',
+          outDir: 'build/dist',
+        },
+      })
+    )
+
+    await fs.add('ace', '')
+    await fs.add('src/foo.ts', "import 'path'")
+    await fs.add('public/styles/main.css', '')
+    await fs.add('public/scripts/main.js', '')
+
+    const compiler = new Compiler(fs.basePath, [], false, ui.logger)
+    const isValid = await compiler.typeCheck()
+
+    assert.isTrue(isValid)
+    const hasFiles = await Promise.all(
+      [
+        'build/dist/.adonisrc.json',
+        'build/dist/src/foo.js',
+        'build/dist/public/styles/main.css',
+        'build/dist/public/scripts/main.js',
+      ].map((file) => fs.fsExtra.pathExists(join(fs.basePath, file)))
+    )
+
+    assert.deepEqual(hasFiles, [false, false, false, false])
+
+    assert.deepEqual(ui.testingRenderer.logs, [
+      {
+        message: `${info}  type checking typescript source files`,
+        stream: 'stdout',
+      },
+      {
+        message: `${success}  built successfully`,
+        stream: 'stdout',
+      },
+    ])
+  }).timeout(0)
 })