Add linting setup to new projects. (#67)

Robert Jackson · web-flow · commit e3af558b7ec8 · 2019-09-22T12:25:11.000-04:00
Add linting setup to new projects.
diff --git a/commands/global/new.js b/commands/global/new.js
@@ -9,11 +9,12 @@ module.exports.builder = function builder(yargs) {
   });
 };
 
-module.exports.handler = function handler(options) {
+module.exports.handler = async function handler(options) {
   let { projectName } = options;
 
   const fs = require('fs-extra');
   const { stripIndent } = require('common-tags');
+  const latestVersion = require('latest-version');
   const pkg = require('../../package.json');
 
   fs.outputFileSync(
@@ -65,6 +66,7 @@ module.exports.handler = function handler(options) {
       name: projectName,
       version: '0.1.0',
       scripts: {
+        lint: 'eslint --cache .',
         test: 'codemod-cli test',
         'test:coverage': 'codemod-cli test --coverage',
         'update-docs': 'codemod-cli update-docs',
@@ -76,8 +78,13 @@ module.exports.handler = function handler(options) {
         'codemod-cli': `^${pkg.version}`,
       },
       devDependencies: {
-        jest: pkg.devDependencies.jest,
         coveralls: pkg.devDependencies.coveralls,
+        eslint: `^${await latestVersion('eslint')}`,
+        'eslint-config-prettier': `^${await latestVersion('eslint-config-prettier')}`,
+        'eslint-plugin-node': `^${await latestVersion('eslint-plugin-node')}`,
+        'eslint-plugin-prettier': `^${await latestVersion('eslint-plugin-prettier')}`,
+        jest: pkg.devDependencies.jest,
+        prettier: `^${await latestVersion('prettier')}`,
       },
       engines: pkg.engines,
       jest: {
@@ -88,6 +95,50 @@ module.exports.handler = function handler(options) {
       spaces: 2,
     }
   );
+
+  // linting setup
+  fs.outputFileSync(
+    projectName + '/.eslintrc.js',
+    stripIndent`
+      module.exports = {
+        parserOptions: {
+          ecmaVersion: 2018,
+        },
+
+        plugins: ['prettier', 'node'],
+        extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+        env: {
+          node: true,
+        },
+        rules: {},
+        overrides: [
+          {
+            files: ['__tests__/**/*.js'],
+            env: {
+              jest: true,
+            },
+          },
+        ],
+      };` + '\n'
+  );
+  fs.outputFileSync(
+    projectName + '/.eslintignore',
+    stripIndent`
+      !.*
+      __testfixtures__
+    `
+  );
+  fs.outputFileSync(
+    projectName + '/.prettierrc',
+    stripIndent`
+      {
+        "singleQuote": true,
+        "trailingComma": "es5",
+        "printWidth": 100
+      }
+    `
+  );
+
   fs.outputFileSync(
     projectName + '/.travis.yml',
     stripIndent`
@@ -110,6 +161,7 @@ module.exports.handler = function handler(options) {
         - yarn install
 
       script:
+        - yarn lint
         - yarn test:coverage
 
       after_success:
@@ -124,15 +176,14 @@ module.exports.handler = function handler(options) {
 
       require('codemod-cli').runTransform(
         __dirname,
-        process.argv[2]       /* transform name */,
+        process.argv[2] /* transform name */,
         process.argv.slice(3) /* paths or globs */
-      )
-    `,
+      );` + '\n',
     {
       encoding: 'utf8',
       mode: 0o755 /* -rwxr-xr-x */,
     }
   );
-  fs.outputFileSync(projectName + '/.gitignore', '/node_modules');
+  fs.outputFileSync(projectName + '/.gitignore', '/node_modules\n/.eslintcache');
   fs.ensureFileSync(projectName + '/transforms/.gitkeep');
 };
diff --git a/package.json b/package.json
@@ -43,6 +43,7 @@
     "import-cwd": "^3.0.0",
     "import-local": "^2.0.0",
     "jscodeshift": "^0.6.4",
+    "latest-version": "^5.1.0",
     "pkg-up": "^3.1.0",
     "recast": "^0.18.1",
     "yargs": "^13.2.0"
diff --git a/tests/cli-test.js b/tests/cli-test.js
@@ -53,7 +53,10 @@ QUnit.module('codemod-cli', function(hooks) {
       assert.equal(result.code, 0, 'exited with zero');
       assert.deepEqual(walkSync(codemodProject.path()), [
         'ember-qunit-codemod/',
+        'ember-qunit-codemod/.eslintignore',
+        'ember-qunit-codemod/.eslintrc.js',
         'ember-qunit-codemod/.gitignore',
+        'ember-qunit-codemod/.prettierrc',
         'ember-qunit-codemod/.travis.yml',
         'ember-qunit-codemod/README.md',
         'ember-qunit-codemod/bin/',
@@ -65,6 +68,19 @@ QUnit.module('codemod-cli', function(hooks) {
     });
   });
 
+  QUnit.module('linting', function(hooks) {
+    setupProject(hooks);
+
+    hooks.beforeEach(async function() {
+      await execa('yarn');
+    });
+
+    QUnit.test('should pass for a basic project', async function(assert) {
+      let result = await execa('yarn', ['lint']);
+      assert.equal(result.code, 0, 'exited with zero');
+    });
+  });
+
   QUnit.module('update-docs', function(hooks) {
     setupProject(hooks);
 
diff --git a/yarn.lock b/yarn.lock
@@ -2957,7 +2957,7 @@ globby@9.2.0, globby@^9.2.0:
     pify "^4.0.1"
     slash "^2.0.0"
 
-got@9.6.0:
+got@9.6.0, got@^9.6.0:
   version "9.6.0"
   resolved "https://registry.yarnpkg.com/got/-/got-9.6.0.tgz#edf45e7d67f99545705de1f7bbeeeb121765ed85"
   integrity sha512-R7eWptXuGYxwijs0eV+v3o6+XH1IqVK8dJOEecQfTmkncw9AV4dcw/Dhxi8MdlqPthxxpZyizMzyg8RTmEsG+Q==
@@ -4218,6 +4218,13 @@ latest-version@^3.0.0:
   dependencies:
     package-json "^4.0.0"
 
+latest-version@^5.1.0:
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/latest-version/-/latest-version-5.1.0.tgz#119dfe908fe38d15dfa43ecd13fa12ec8832face"
+  integrity sha512-weT+r0kTkRQdCdYCNtkMwWXQTMEswKrFBkm4ckQOMVhhqhIMI1UT2hMj+1iigIhgSZm5gTmrRXBNoGUgaTY1xA==
+  dependencies:
+    package-json "^6.3.0"
+
 lcid@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835"
@@ -5103,6 +5110,16 @@ package-json@^4.0.0:
     registry-url "^3.0.3"
     semver "^5.1.0"
 
+package-json@^6.3.0:
+  version "6.5.0"
+  resolved "https://registry.yarnpkg.com/package-json/-/package-json-6.5.0.tgz#6feedaca35e75725876d0b0e64974697fed145b0"
+  integrity sha512-k3bdm2n25tkyxcjSKzB5x8kfVxlMdgsbPr0GkZcwHsLpba6cBjqCt1KlcChKEvxHIcTB1FVMuwoijZ26xex5MQ==
+  dependencies:
+    got "^9.6.0"
+    registry-auth-token "^4.0.0"
+    registry-url "^5.0.0"
+    semver "^6.2.0"
+
 parallel-transform@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/parallel-transform/-/parallel-transform-1.1.0.tgz#d410f065b05da23081fcd10f28854c29bda33b06"
@@ -5427,7 +5444,7 @@ qunit@^2.9.2:
     node-watch "0.6.0"
     resolve "1.9.0"
 
-rc@^1.0.1, rc@^1.1.6, rc@^1.2.7:
+rc@^1.0.1, rc@^1.1.6, rc@^1.2.7, rc@^1.2.8:
   version "1.2.8"
   resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed"
   integrity sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==
@@ -5579,13 +5596,28 @@ registry-auth-token@^3.0.1:
     rc "^1.1.6"
     safe-buffer "^5.0.1"
 
+registry-auth-token@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-4.0.0.tgz#30e55961eec77379da551ea5c4cf43cbf03522be"
+  integrity sha512-lpQkHxd9UL6tb3k/aHAVfnVtn+Bcs9ob5InuFLLEDqSqeq+AljB8GZW9xY0x7F+xYwEcjKe07nyoxzEYz6yvkw==
+  dependencies:
+    rc "^1.2.8"
+    safe-buffer "^5.0.1"
+
 registry-url@^3.0.3:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/registry-url/-/registry-url-3.1.0.tgz#3d4ef870f73dde1d77f0cf9a381432444e174942"
   integrity sha1-PU74cPc93h138M+aOBQyRE4XSUI=
   dependencies:
     rc "^1.0.1"
 
+registry-url@^5.0.0:
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/registry-url/-/registry-url-5.1.0.tgz#e98334b50d5434b81136b44ec638d9c2009c5009"
+  integrity sha512-8acYXXTI0AkQv6RAOjE3vOaIXZkT9wo4LOFbBKYQEEnnMNBpKqdUrI6S4NT0KPIo/WVvJ5tE/X5LF/TQUf0ekw==
+  dependencies:
+    rc "^1.2.8"
+
 regjsgen@^0.5.0:
   version "0.5.0"
   resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.5.0.tgz#a7634dc08f89209c2049adda3525711fb97265dd"
@@ -5916,6 +5948,11 @@ semver@^6.0.0, semver@^6.1.0, semver@^6.1.1:
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.1.1.tgz#53f53da9b30b2103cd4f15eab3a18ecbcb210c9b"
   integrity sha512-rWYq2e5iYW+fFe/oPPtYJxYgjBm8sC4rmoGdUOgBB7VnwKt6HrL793l2voH1UlsyYZpJ4g0wfjnTEO1s1NP2eQ==
 
+semver@^6.2.0:
+  version "6.3.0"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
+  integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
+
 set-blocking@^2.0.0, set-blocking@~2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7"
