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

@@ -12,15 +12,22 @@ Despite all the recent hype, setting up a new TypeScript (x React) library can b
   - [`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)
+  - [`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)
+  - [`tsdx lint`](#tsdx-lint)
 - [Author](#author)
 - [License](#license)
 
@@ -71,6 +78,10 @@ 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.
+
 ## 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.
@@ -316,6 +327,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 test
+  $ tsdx lint src test --fix
+  $ tsdx lint src test --ignore-pattern test/foobar.ts
+  $ tsdx lint src test --write-file
+```
+
 ## Author
 
 - [Jared Palmer](https://twitter.com/jaredpalmer)

package.json

@@ -22,6 +22,8 @@
   },
   "scripts": {
     "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": [
@@ -31,6 +33,8 @@
   "dependencies": {
     "@babel/core": "^7.2.2",
     "@jaredpalmer/rollup-plugin-preserve-shebang": "^0.1.7",
+    "@typescript-eslint/eslint-plugin": "^1.8.0",
+    "@typescript-eslint/parser": "^1.8.0",
     "ansi-escapes": "^3.1.0",
     "asyncro": "^3.0.0",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
@@ -40,6 +44,10 @@
     "chalk": "^2.4.2",
     "cross-env": "5.0.5",
     "enquirer": "^2.3.0",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.2.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "eslint-plugin-react": "^7.13.0",
     "execa": "^1.0.0",
     "fs-extra": "^7.0.1",
     "jest": "^24.7.1",
@@ -67,27 +75,26 @@
   "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": "^5.0.5",
     "@types/mkdirp": "^0.5.2",
     "@types/ms": "^0.7.30",
     "@types/node": "^11.13.8",
     "@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.1.0",
     "prettier": "^1.17.0",
     "pretty-quick": "^1.10.0",
     "ps-tree": "^1.2.0",
-    "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"
+    "react": "^16.8.6",
+    "shelljs": "^0.8.3"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "pretty-quick --staged"
+      "pre-commit": "pretty-quick --staged --pattern '!test/tests/lint/**'"
     }
   },
   "prettier": {

src/createEslintConfig.ts

@@ -0,0 +1,74 @@
+import fs from 'fs';
+import path from 'path';
+import { CLIEngine } from 'eslint';
+
+interface CreateEslintConfigArgs {
+  rootDir: string;
+  writeFile: boolean;
+}
+export function createEslintConfig({
+  rootDir,
+  writeFile,
+}: CreateEslintConfigArgs): CLIEngine.Options['baseConfig'] {
+  const config = {
+    extends: [
+      'eslint:recommended',
+      'plugin:@typescript-eslint/recommended',
+      'prettier/@typescript-eslint',
+      'plugin:prettier/recommended',
+      'plugin:react/recommended',
+    ],
+    root: true,
+    env: {
+      node: true,
+      es6: true,
+      jest: true,
+      browser: true,
+    },
+    parserOptions: {
+      ecmaVersion: 2017,
+      ecmaFeatures: {
+        impliedStrict: true,
+        jsx: true,
+        experimentalObjectRestSpread: true,
+      },
+      sourceType: 'module',
+    },
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    rules: {
+      'no-console': 'off',
+      'no-empty': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': [2, { args: 'none' }],
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  };
+
+  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/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';
@@ -8,6 +9,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';
@@ -17,13 +19,8 @@ import { paths } from './constants';
 import * as Messages from './messages';
 import { createRollupConfig } from './createRollupConfig';
 import { createJestConfig } from './createJestConfig';
-import {
-  safeVariableName,
-  resolveApp,
-  safePackageName,
-  clearConsole,
-} from './utils';
-import * as Output from './output';
+import { createEslintConfig } from './createEslintConfig';
+import { resolveApp, safePackageName, clearConsole } from './utils';
 import { concatAllArray } from 'jpjs';
 import getInstallCmd from './getInstallCmd';
 import getInstallArgs from './getInstallArgs';
@@ -42,6 +39,7 @@ let appPackageJson: {
   name: string;
   source?: string;
   jest?: any;
+  eslint?: any;
 };
 try {
   appPackageJson = fs.readJSONSync(resolveApp('package.json'));
@@ -370,7 +368,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';
@@ -394,8 +392,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,4 @@
+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,7 @@
+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>;
+};

test/tests/lint/tsdx-lint.test.js

@@ -0,0 +1,34 @@
+/**
+ * @jest-environment node
+ */
+'use strict';
+
+const shell = require('shelljs');
+
+shell.config.silent = true;
+
+describe('tsdx lint', () => {
+  it('should fail to lint a ts file with errors', () => {
+    const testFile = 'test/tests/lint/file-with-lint-errors.ts';
+    const output = shell.exec(`node dist/index.js lint ${testFile}`);
+    expect(output.code).toBe(1);
+  });
+
+  it('should succeed linting a ts file without errors', () => {
+    const testFile = 'test/tests/lint/file-without-lint-error.ts';
+    const output = shell.exec(`node dist/index.js lint ${testFile}`);
+    expect(output.code).toBe(0);
+  });
+
+  it('should fail to lint a tsx file with errors', () => {
+    const testFile = 'test/tests/lint/react-file-with-lint-errors.tsx';
+    const output = shell.exec(`node dist/index.js lint ${testFile}`);
+    expect(output.code).toBe(1);
+  });
+
+  it('should succeed linting a tsx file without errors', () => {
+    const testFile = 'test/tests/lint/react-file-without-lint-error.tsx';
+    const output = shell.exec(`node dist/index.js lint ${testFile}`);
+    expect(output.code).toBe(0);
+  });
+});

tsconfig.json

@@ -3,6 +3,7 @@
   "exclude": ["src/template/**/*"],
   "compilerOptions": {
     "allowJs": true,
+    "jsx": "react",
     "importHelpers": true,
     "esModuleInterop": true,
     "outDir": "dist",