feat(web-scripts): add checkstyle to lint

Author: Paul Marbach

package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "test": "lerna run test --stream",
     "build": "lerna run build --stream",
-    "lint": "web-scripts lint --ignore-path .gitignore",
+    "lint": "lerna run lint --stream",
     "commit": "web-scripts commit",
     "bootstrap": "lerna bootstrap --use-workspaces",
     "release": "./release.sh"

packages/web-scripts/src/SharedTypes.ts

@@ -28,6 +28,7 @@ export type TestTaskDesc = {
 export type LintTaskDesc = {
   name: 'lint';
   config: string;
+  typecheck: boolean;
 } & TaskDesc;
 
 export type CommitTaskDesc = {

packages/web-scripts/src/Tasks/LintTask.ts

@@ -1,11 +1,26 @@
-import { LintTaskDesc } from '../SharedTypes';
-import { default as spawn } from 'cross-spawn';
+import { default as spawn } from 'cross-spawn-promise';
 import { default as Debug } from 'debug';
+
+import { LintTaskDesc } from '../SharedTypes';
 import { CONSUMING_ROOT } from '../Paths';
-import { SpawnSyncReturns } from 'child_process';
+
 const dbg = Debug('web-scripts:lint'); // eslint-disable-line new-cap
 
-export function lintTask(task: LintTaskDesc): SpawnSyncReturns<Buffer> {
+export async function lintTask(task: LintTaskDesc): Promise<string[]> {
+  const fns = [eslintRun];
+  if (task.typecheck) fns.push(typeCheck);
+
+  return await Promise.all(
+    fns.map(async fn => {
+      dbg('Beginning %s task', fn.name);
+      const stdout = await fn(task);
+      dbg('Finished %s task', fn.name);
+      return stdout;
+    }),
+  );
+}
+
+async function eslintRun(task: LintTaskDesc): Promise<string> {
   const cmd = 'npx';
   const args = [
     '--no-install',
@@ -24,5 +39,14 @@ export function lintTask(task: LintTaskDesc): SpawnSyncReturns<Buffer> {
     ...task.restOptions,
   ];
   dbg('npx args %o', args);
-  return spawn.sync(cmd, args, { stdio: 'inherit' });
+
+  const stdout = await spawn(cmd, args, { stdio: 'inherit' });
+  return (stdout || '').toString();
+}
+
+async function typeCheck(): Promise<string> {
+  const cmd = 'npx';
+  const args = ['tsc', '--noEmit'];
+  const stdout = await spawn(cmd, args, { stdio: 'inherit' });
+  return (stdout || '').toString();
 }

packages/web-scripts/src/index.ts

@@ -73,17 +73,19 @@ program
 program
   .command('lint')
   .allowUnknownOption()
-  .description('Run eslint')
+  .description('Run ESLint and TypeScript to statically analyze your code')
   .option('--config [path]', 'path to ESLint config', ESLINT_CONFIG)
+  .option('--typecheck', 'run a TypeScript type check')
   .action((cmd: Command) => {
-    const { config } = cmd.opts();
+    const { typecheck, config } = cmd.opts();
     const t: LintTaskDesc = {
       name: 'lint',
       config,
+      typecheck,
       restOptions: parseRestOptions(cmd),
     };
 
-    handleSpawnResult(lintTask(t));
+    handlePromiseResult(lintTask(t));
   });
 
 program

packages/web-scripts/src/integration.test.ts

@@ -78,7 +78,7 @@ describe('integration tests', () => {
 
     test(
       'Full integration test',
-      async () => await testScripts(),
+      async () => await testScripts([], ['--typecheck']),
       TEST_SCRIPTS_TIMEOUT,
     );
   });
@@ -163,15 +163,18 @@ describe('integration tests', () => {
     await exec('git init', { cwd: PKG_ROOT });
   }
 
-  async function testScripts(buildArgs: string[] = []) {
+  async function testScripts(
+    buildArgs: string[] = [],
+    lintArgs: string[] = [],
+  ) {
     try {
       rimraf.sync(join(PKG_ROOT, 'cjs'));
       expect(existsSync(join(PKG_ROOT, 'cjs/index.js'))).toBe(false);
       await exec(['yarn build', ...buildArgs].join(' '), { cwd: PKG_ROOT });
       expect(existsSync(join(PKG_ROOT, 'cjs/index.js'))).toBe(true);
 
       await exec('yarn test', { cwd: PKG_ROOT });
-      await exec('yarn lint', { cwd: PKG_ROOT });
+      await exec(['yarn lint', ...lintArgs].join(' '), { cwd: PKG_ROOT });
     } catch (e) {
       // We are not capturing and printing stdout above, where TSC prints its errors. This makes sure it's printed.
       console.log(e.stdout); // eslint-disable-line no-console

yarn.lock

@@ -5794,9 +5794,9 @@ lodash.without@~4.4.0:
   integrity sha1-PNRXSgC2e643OpS3SHcmQFB7eqw=
 
 lodash@4.17.11, lodash@>=4.17.12, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.1:
-  version "4.17.14"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.14.tgz#9ce487ae66c96254fe20b599f21b6816028078ba"
-  integrity sha512-mmKYbW3GLuJeX+iGP+Y7Gp1AiGHGbXHCOh/jZmrawMmsE7MS4znI3RL2FsjbqOyMayHInjOeykW7PEajUk1/xw==
+  version "4.17.15"
+  resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
+  integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
 
 log-symbols@^1.0.2:
   version "1.0.2"
@@ -6161,7 +6161,7 @@ mississippi@^3.0.0:
 
 mixin-deep@>=1.3.2, mixin-deep@^1.2.0:
   version "2.0.1"
-  resolved "https://registry.yarnpkg.com/mixin-deep/-/mixin-deep-2.0.1.tgz#9a6946bef4a368401b784970ae3caaaa6bab02fa"
+  resolved "https://registry.npmjs.org/mixin-deep/-/mixin-deep-2.0.1.tgz#9a6946bef4a368401b784970ae3caaaa6bab02fa"
   integrity sha512-imbHQNRglyaplMmjBLL3V5R6Bfq5oM+ivds3SKgc6oRtzErEnBUUc5No11Z2pilkUvl42gJvi285xTNswcKCMA==
 
 mkdirp@0.x, "mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@~0.5.0, mkdirp@~0.5.1:
@@ -7965,7 +7965,7 @@ set-blocking@^2.0.0, set-blocking@~2.0.0:
 
 set-value@>=3.0.1, set-value@^0.4.3, set-value@^2.0.0:
   version "3.0.1"
-  resolved "https://registry.yarnpkg.com/set-value/-/set-value-3.0.1.tgz#52c82af7653ba69eb1db92e81f5cdb32739b9e95"
+  resolved "https://registry.npmjs.org/set-value/-/set-value-3.0.1.tgz#52c82af7653ba69eb1db92e81f5cdb32739b9e95"
   integrity sha512-w6n3GUPYAWQj4ZyHWzD7K2FnFXHx9OTwJYbWg+6nXjG8sCLfs9DGv+KlqglKIIJx+ks7MlFuwFW2RBPb+8V+xg==
   dependencies:
     is-plain-object "^2.0.4"