Add tsdx lint command

.circleci/config.yml

@@ -24,6 +24,10 @@ jobs:
           name: Build
           command: yarn build
 
+      - run:
+          name: Lint
+          command: yarn lint:post-build
+
       - run:
           name: Run tests
           command: yarn test --runInBand --no-cache --coverage

README.md

@@ -7,22 +7,30 @@ Despite all the recent hype, setting up a new TypeScript (x React) library can b
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Features](#features)
-- [Quick Start](#quick-start)
+- [Features](#Features)
+- [Quick Start](#Quick-Start)
   - [`npm start` or `yarn start`](#npm-start-or-yarn-start)
   - [`npm run build` or `yarn build`](#npm-run-build-or-yarn-build)
   - [`npm test` or `yarn test`](#npm-test-or-yarn-test)
-- [Optimizations](#optimizations)
-  - [Development-only Expressions + Treeshaking](#development-only-expressions--treeshaking)
-  - [Using lodash](#using-lodash)
-- [Inspiration](#inspiration)
-  - [Comparison to Microbundle](#comparison-to-microbundle)
-- [API Reference](#api-reference)
+  - [`npm run lint` or `yarn lint`](#npm-run-lint-or-yarn-lint)
+- [Optimizations](#Optimizations)
+  - [Development-only Expressions + Treeshaking](#Development-only-Expressions--Treeshaking)
+    - [Rollup Treeshaking](#Rollup-Treeshaking)
+    - [Advanced `babel-plugin-dev-expressions`](#Advanced-babel-plugin-dev-expressions)
+      - [`__DEV__`](#DEV)
+      - [`invariant`](#invariant)
+      - [`warning`](#warning)
+  - [Using lodash](#Using-lodash)
+- [Inspiration](#Inspiration)
+  - [Comparison to Microbundle](#Comparison-to-Microbundle)
+- [API Reference](#API-Reference)
   - [`tsdx watch`](#tsdx-watch)
   - [`tsdx build`](#tsdx-build)
   - [`tsdx test`](#tsdx-test)
-- [Author](#author)
-- [License](#license)
+  - [`tsdx lint`](#tsdx-lint)
+- [Hosting extracted Errors](#Hosting-extracted-Errors)
+- [Author](#Author)
+- [License](#License)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -71,6 +79,11 @@ The package is optimized and bundled with Rollup into multiple formats (CommonJS
 Runs the test watcher (Jest) in an interactive mode.
 By default, runs tests related to files changed since the last commit.
 
+### `npm run lint` or `yarn lint`
+
+Runs Eslint.
+If you would like to customize the linting you can add a `eslint` block to your package.json or you can run `yarn lint --write-file` and edit the generated `.eslintrc.js` file to whatever you want.
+
 ## Optimizations
 
 Aside from just bundling your module into different formats, TSDX comes with some optimizations for your convenience. They yield objectively better code and smaller bundle sizes.
@@ -327,6 +340,28 @@ Examples
 
 This runs Jest v24.x in watch mode. See [https://jestjs.io](https://jestjs.io) for options. If you are using the React template, jest uses the flag `--env=jsdom` by default.
 
+### `tsdx lint`
+
+```shell
+Description
+  Run eslint
+
+Usage
+  $ tsdx lint [options]
+
+Options
+  --fix               Fixes fixable errors and warnings
+  --ignore-pattern    Ignore a pattern
+  --write-file        Write the config file locally
+  -h, --help          Displays this message
+
+Examples
+  $ tsdx lint src
+  $ tsdx lint src --fix
+  $ tsdx lint src test --ignore-pattern test/foobar.ts
+  $ tsdx lint src --write-file
+```
+
 ## Hosting extracted Errors
 
 After running `--extractErrors`, you will have a `codes.json` file with all your extracted error codes. You will need to host the decoder somewhere (with the URL that you passed in to `--extractErrors`).

package.json

@@ -23,6 +23,8 @@
   "scripts": {
     "prepare": "tsc -p tsconfig.json",
     "build": "tsc -p tsconfig.json",
+    "lint": "yarn build && yarn lint:post-build",
+    "lint:post-build": "node dist/index.js lint src test --ignore-pattern 'test/tests/lint'",
     "test": "jest --config ./test/jest.config.json"
   },
   "files": [
@@ -35,8 +37,11 @@
     "@babel/plugin-proposal-class-properties": "^7.4.4",
     "@babel/polyfill": "^7.4.4",
     "@babel/preset-env": "^7.4.4",
+    "@typescript-eslint/eslint-plugin": "^1.12.0",
+    "@typescript-eslint/parser": "^1.12.0",
     "ansi-escapes": "^3.2.0",
     "asyncro": "^3.0.0",
+    "babel-eslint": "^10.0.2",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
     "babel-plugin-dev-expression": "^0.2.1",
     "babel-plugin-transform-async-to-promises": "^0.8.11",
@@ -47,6 +52,16 @@
     "chalk": "^2.4.2",
     "cross-env": "5.2.0",
     "enquirer": "^2.3.0",
+    "eslint": "^6.0.1",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-config-react-app": "4.0.1",
+    "eslint-plugin-flowtype": "^3.11.1",
+    "eslint-plugin-import": "^2.18.0",
+    "eslint-plugin-jsx-a11y": "^6.2.3",
+    "eslint-plugin-no-for-of-loops": "^1.0.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "eslint-plugin-react": "^7.14.2",
+    "eslint-plugin-react-hooks": "^1.6.1",
     "execa": "^1.0.0",
     "fs-extra": "^8.0.1",
     "jest": "^24.8.0",
@@ -55,6 +70,7 @@
     "mkdirp": "^0.5.1",
     "ora": "^3.4.0",
     "pascal-case": "^2.0.1",
+    "prettier": "^1.18.2",
     "progress-estimator": "^0.2.2",
     "rollup": "^1.12.0",
     "rollup-plugin-babel": "^4.3.2",
@@ -74,32 +90,30 @@
   "devDependencies": {
     "@types/ansi-escapes": "^4.0.0",
     "@types/camelcase": "^5.2.0",
+    "@types/eslint": "^4.16.6",
     "@types/execa": "^0.9.0",
     "@types/fs-extra": "^8.0.0",
     "@types/jest": "^24.0.15",
     "@types/mkdirp": "^0.5.2",
     "@types/ms": "^0.7.30",
     "@types/node": "^12.0.2",
     "@types/ora": "^3.2.0",
+    "@types/react": "^16.8.17",
     "@types/rollup-plugin-json": "^3.0.2",
     "@types/rollup-plugin-sourcemaps": "^0.4.2",
     "husky": "^2.3.0",
-    "prettier": "^1.17.1",
     "pretty-quick": "^1.10.0",
     "ps-tree": "^1.2.0",
+    "react": "^16.8.6",
     "shelljs": "^0.8.3",
-    "tslint": "^5.16.0",
-    "tslint-config-palmerhq": "^1.0.2",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-react": "^4.0.0",
     "typescript": "^3.4.5"
   },
   "peerDependencies": {
     "typescript": "3"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "pretty-quick --staged"
+      "pre-commit": "pretty-quick --staged --pattern '!test/tests/lint/**' && yarn lint"
     }
   },
   "prettier": {

src/createEslintConfig.ts

@@ -0,0 +1,63 @@
+import fs from 'fs';
+import path from 'path';
+import { CLIEngine } from 'eslint';
+import reactAppConfig from 'eslint-config-react-app';
+
+interface CreateEslintConfigArgs {
+  rootDir: string;
+  writeFile: boolean;
+}
+export function createEslintConfig({
+  rootDir,
+  writeFile,
+}: CreateEslintConfigArgs): CLIEngine.Options['baseConfig'] {
+  /*
+  This config could change to
+  {
+    extends: [
+      'react-app',
+      'prettier/@typescript-eslint', 
+      'plugin:prettier/recommended'
+    ]
+  }
+  after https://github.com/facebook/create-react-app/commit/24489ac0a667af416f1d59dd806dfc2623aabe36 is released
+  eslint-config-react-app defines overrides as an object instead of an array, which is not supported in eslint@6.
+  */
+  const config = {
+    ...reactAppConfig,
+    extends: ['prettier/@typescript-eslint', 'plugin:prettier/recommended'],
+    overrides: undefined,
+    parser: require.resolve('@typescript-eslint/parser'),
+    parserOptions: reactAppConfig.overrides.parserOptions,
+    plugins: [
+      ...reactAppConfig.plugins,
+      ...reactAppConfig.overrides.plugins,
+      'no-for-of-loops',
+    ],
+    rules: {
+      ...reactAppConfig.rules,
+      ...reactAppConfig.overrides.rules,
+    },
+  };
+
+  if (writeFile) {
+    const file = path.join(rootDir, '.eslintrc.js');
+    if (fs.existsSync(file)) {
+      console.error(
+        'Error trying to save the Eslint configuration file:',
+        `${file} already exists.`
+      );
+    } else {
+      try {
+        fs.writeFileSync(
+          file,
+          `module.exports = ${JSON.stringify(config, null, 2)}`
+        );
+      } catch (e) {
+        console.error(e);
+      }
+    }
+  }
+
+  return config;
+}

src/createJestConfig.ts

@@ -1,6 +1,3 @@
-import fs from 'fs';
-import path from 'path';
-
 export function createJestConfig(
   _: (relativePath: string) => void,
   rootDir: string

src/createRollupConfig.ts

@@ -1,3 +1,4 @@
+/* eslint @typescript-eslint/camelcase: 0 */
 import { DEFAULT_EXTENSIONS } from '@babel/core';
 import { safeVariableName, safePackageName, external } from './utils';
 import { paths } from './constants';

src/env.d.ts

@@ -5,6 +5,7 @@ declare module 'ora';
 declare module 'sade';
 declare module 'tiny-glob/sync';
 declare module 'ansi-escapes';
+declare module 'eslint-config-react-app';
 
 // Patch Babel
 // @see line 226 of https://unpkg.com/@babel/core@7.4.4/lib/index.js

src/errors/extractErrors.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-'use strict';
-
 import fs from 'fs-extra';
 import * as babylon from 'babylon';
 import traverse from 'babel-traverse';
@@ -137,8 +135,8 @@ function ErrorProd(code) {
     url += '&args[]=' + encodeURIComponent(arguments[i]);
   }
   return new Error(
-    \`Minified ${prettyName} error #\$\{code\}; visit \$\{url\} for the full message or \` +
-      'use the non-minified dev environment for full errors and additional \' +
+    \`Minified ${prettyName} error #$\{code}; visit $\{url} for the full message or \` +
+      'use the non-minified dev environment for full errors and additional ' +
       'helpful warnings. '
   );
 }

src/index.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint @typescript-eslint/no-var-requires: 0 */
 
 import sade from 'sade';
 import glob from 'tiny-glob/sync';
@@ -15,6 +16,7 @@ import chalk from 'chalk';
 import util from 'util';
 import * as fs from 'fs-extra';
 import jest from 'jest';
+import { CLIEngine } from 'eslint';
 import logError from './logError';
 import path from 'path';
 import mkdirp from 'mkdirp';
@@ -24,8 +26,8 @@ import { paths } from './constants';
 import * as Messages from './messages';
 import { createRollupConfig } from './createRollupConfig';
 import { createJestConfig } from './createJestConfig';
+import { createEslintConfig } from './createEslintConfig';
 import { resolveApp, safePackageName, clearConsole } from './utils';
-import * as Output from './output';
 import { concatAllArray } from 'jpjs';
 import getInstallCmd from './getInstallCmd';
 import getInstallArgs from './getInstallArgs';
@@ -44,6 +46,7 @@ let appPackageJson: {
   name: string;
   source?: string;
   jest?: any;
+  eslint?: any;
 };
 try {
   appPackageJson = fs.readJSONSync(resolveApp('package.json'));
@@ -417,7 +420,7 @@ prog
   .describe(
     'Run jest test runner in watch mode. Passes through all flags directly to Jest'
   )
-  .action(async (opts: any) => {
+  .action(async () => {
     // Do this as the first thing so that any code reading it knows the right env.
     process.env.BABEL_ENV = 'test';
     process.env.NODE_ENV = 'test';
@@ -441,8 +444,48 @@ prog
       })
     );
 
-    const [_skipTheWordTest, ...argsToPassToJestCli] = argv;
+    const [, ...argsToPassToJestCli] = argv;
     jest.run(argsToPassToJestCli);
   });
 
+prog
+  .command('lint')
+  .describe('Run eslint')
+  .example('lint src test')
+  .option('--fix', 'Fixes fixable errors and warnings')
+  .example('lint src test --fix')
+  .option('--ignore-pattern', 'Ignore a pattern')
+  .example('lint src test --ignore-pattern test/foobar.ts')
+  .option('--write-file', 'Write the config file locally')
+  .example('lint src test --write-file')
+  .action(
+    async (opts: {
+      fix: boolean;
+      'ignore-pattern': string;
+      'write-file': boolean;
+      _: string[];
+    }) => {
+      const cli = new CLIEngine({
+        extensions: ['.ts', '.tsx'],
+        fix: opts.fix,
+        ignorePattern: opts['ignore-pattern'],
+        baseConfig: {
+          ...createEslintConfig({
+            rootDir: paths.appRoot,
+            writeFile: opts['write-file'],
+          }),
+          ...appPackageJson.eslint,
+        },
+      });
+      const report = cli.executeOnFiles(opts['_']);
+      if (opts.fix) {
+        CLIEngine.outputFixes(report);
+      }
+      console.log(cli.getFormatter()(report.results));
+      if (report.errorCount) {
+        process.exit(1);
+      }
+    }
+  );
+
 prog.parse(process.argv);

test/tests/lint/file-with-lint-errors.ts

@@ -0,0 +1 @@
+export const foo () => !!'bar';

test/tests/lint/file-with-prettier-lint-errors.ts

@@ -0,0 +1,5 @@
+export const foo  = (   ) => 
+!! ('bar')
+;
+
+

test/tests/lint/file-without-lint-error.ts

@@ -0,0 +1 @@
+export const foo = () => !!'bar';

test/tests/lint/react-file-with-lint-errors.tsx

@@ -0,0 +1,5 @@
+import React from 'react';
+
+export const Foobar = (props: any) => {
+  return <<div {...props}>foobar</div>;
+};

test/tests/lint/react-file-without-lint-error.tsx

@@ -0,0 +1,5 @@
+import React from 'react';
+
+export const Foobar = (props: any) => {
+  return <div {...props}>foobar </div>;
+};