Run eslint + prettier in CI, fix existing errors for both (#48)

* Always run eslint in CI

* Fix lint errors, add Prettier to CI, run prettier over project too

Author: sgb-io

.eslintrc.json

@@ -1,24 +1,18 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-        "@typescript-eslint",
-        "prettier"
-    ],
-    "extends": [
-        "standard-with-typescript",
-        "prettier"
-    ],
-    "parserOptions": {
-        "project": "./tsconfig.json",
-        "ecmaFeatures": {
-            "modules": true
-        },
-        "ecmaVersion": 6,
-        "sourceType": "module"
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "prettier"],
+  "extends": ["standard-with-typescript", "prettier", "prettier/@typescript-eslint", "eslint-config-prettier"],
+  "parserOptions": {
+    "project": "./tsconfig.json",
+    "ecmaFeatures": {
+      "modules": true
     },
-    "rules": {
-        "@typescript-eslint/strict-boolean-expressions": "off",
-        "@typescript-eslint/consistent-type-assertions": "warn"
-    }
-}
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "rules": {
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "@typescript-eslint/consistent-type-assertions": "warn"
+  }
+}

.github/workflows/node.js.yml

@@ -26,5 +26,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm i -g yarn
     - run: yarn
+    - run: yarn lint
+    - run: yarn prettier
     - run: yarn build
     - run: yarn test

.gitignore

@@ -25,4 +25,5 @@ yarn-error.log*
 .nyc_output
 
 # Ignore npm lockfile (we're using yarn)
-package-lock.json
+package-lock.json
+.vscode/settings.json

.prettierignore

@@ -0,0 +1,9 @@
+# Ignore artifacts:
+build
+coverage
+.nyc_output
+bin
+
+# Types
+src/types/
+src/types.ts

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+This changelog is currently manually maintained. Please see commits, PRs and Issue discussions on GitHub for the latest and most correction information.
+
 ### 5.0.0
 
 - Updated `calculateComplexity` signature, file extension and typescript/flow flags added

package.json

@@ -8,7 +8,9 @@
     "lint": "eslint src/*.**",
     "lint:fix": "eslint --fix src/*.**",
     "build": "tsc",
-    "build:watch": "tsc --watch"
+    "build:watch": "tsc --watch",
+    "prettier": "prettier --check src",
+    "prettier:fix": "prettier --write src"
   },
   "author": "Sam Brown (https://github.com/sgb-io)",
   "repository": {
@@ -37,7 +39,7 @@
     "@typescript-eslint/eslint-plugin": "3",
     "@typescript-eslint/parser": "^3.3.0",
     "eslint": "7",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint-config-prettier": "^7.0.0",
     "eslint-config-standard-with-typescript": "^18.0.2",
     "eslint-plugin-import": "2",
     "eslint-plugin-node": "11",

src/analyze.ts

@@ -5,7 +5,7 @@ import {
   CoverageMapping,
   FileWithContents,
   CompleteCodehawkComplexityResult,
-  CodehawkComplexityResult
+  CodehawkComplexityResult,
 } from './types'
 
 export const transpileFileSource = (
@@ -22,16 +22,16 @@ export const transpileFileSource = (
         [
           '@babel/plugin-transform-typescript',
           {
-            isTSX: fileExtension === '.tsx'
-          }
-        ]
+            isTSX: fileExtension === '.tsx',
+          },
+        ],
       ],
     })
     contents = transformed.code || ''
   } else {
     // Assume no other static type systems exist
     // Stripping flow types should be safe, even if it's not strictly flow
-    contents = (enableFlow)
+    contents = enableFlow
       ? flowRemoveTypes(contents, { pretty: true }).toString()
       : contents
   }
@@ -46,12 +46,7 @@ export const calculateComplexity = (
   enableFlow: boolean
 ): CodehawkComplexityResult => {
   return escomplexReporter(
-    transpileFileSource(
-      sourceCode,
-      fileExtension,
-      isTypescript,
-      enableFlow
-    )
+    transpileFileSource(sourceCode, fileExtension, isTypescript, enableFlow)
   )
 }
 
@@ -62,24 +57,31 @@ export const analyzeFile = (
 ): CompleteCodehawkComplexityResult => {
   let report = null
   const relativeFilePath = `${file.path}/${file.filename}`.replace(dirPath, '')
-  const coverageData = projectCoverage.find(c => c.path === relativeFilePath)
+  const coverageData = projectCoverage.find((c) => c.path === relativeFilePath)
 
   let fileCoverage = '0'
 
   if (coverageData) {
     // Coverage can have a bug where 0 things have 100% coverage
-    const linesPct = coverageData.coverage.lines.total === 0 ? 0 : coverageData.coverage.lines.pct
-    const fnPct = coverageData.coverage.functions.total === 0 ? 0 : coverageData.coverage.functions.pct
-    const stmntPct = coverageData.coverage.statements.total === 0 ? 0 : coverageData.coverage.statements.pct
-    const branchPct = coverageData.coverage.branches.total === 0 ? 0 : coverageData.coverage.branches.pct
+    const linesPct =
+      coverageData.coverage.lines.total === 0
+        ? 0
+        : coverageData.coverage.lines.pct
+    const fnPct =
+      coverageData.coverage.functions.total === 0
+        ? 0
+        : coverageData.coverage.functions.pct
+    const stmntPct =
+      coverageData.coverage.statements.total === 0
+        ? 0
+        : coverageData.coverage.statements.pct
+    const branchPct =
+      coverageData.coverage.branches.total === 0
+        ? 0
+        : coverageData.coverage.branches.pct
 
     // Average the four coverage types.
-    fileCoverage = ((
-      linesPct +
-      fnPct +
-      stmntPct +
-      branchPct
-    ) / 4).toFixed(2)
+    fileCoverage = ((linesPct + fnPct + stmntPct + branchPct) / 4).toFixed(2)
   }
 
   const trimmed = file.rawSource.trim()

src/cli-util.ts

@@ -1,4 +1,4 @@
-import { FullyAnalyzedFile } from "./types"
+import { FullyAnalyzedFile } from './types'
 
 const colLengths = {
   filename: 30,
@@ -9,17 +9,16 @@ const colLengths = {
 
 const round = (num: number): number => Math.round(num * 100) / 100
 
-const formatCol = (value: string, limit: number) => {
-  return (value.length > limit)
-      ? value.slice(limit + 3).padStart(limit, '.')
-      : value.padEnd(limit, ' ')
+const formatCol = (value: string, limit: number): string => {
+  return value.length > limit
+    ? value.slice(limit + 3).padStart(limit, '.')
+    : value.padEnd(limit, ' ')
 }
 
 const getScoreNote = (score: number): string => {
   if (score > 60) return 'OK'
 
   if (score > 50) return '(Could be better)'
-
   return '(Needs improvement)'
 }
 
@@ -31,31 +30,36 @@ const formatComplexityScore = (score: number): string => {
 }
 
 const generateTableLines = (flatFileResults: FullyAnalyzedFile[]): string => {
-  return flatFileResults.map((result) => {
-    const { complexityReport, filename, timesDependedOn } = result
+  return flatFileResults
+    .map((result) => {
+      const { complexityReport, filename, timesDependedOn } = result
 
-    if (!complexityReport) {
-      return ''
-    }
+      if (!complexityReport) {
+        return ''
+      }
 
-    const { lineEnd, codehawkScore } = complexityReport
-    const score = formatComplexityScore(codehawkScore)
+      const { lineEnd, codehawkScore } = complexityReport
+      const score = formatComplexityScore(codehawkScore)
 
-    // Convert output into stdout-friendly, padded columns
-    const filenameCol = formatCol(filename, colLengths.filename)
-    const linesCol = formatCol(lineEnd.toString(), colLengths.lines)
-    // Add 1 to the times depended on, assuming that all files are used at least once
-    // (Codehawk reports external uses only)
-    const depsCol = formatCol((timesDependedOn + 1).toString(), colLengths.timesUsed)
-    const maintainabilityCol = formatCol(score, colLengths.maintainability)
+      // Convert output into stdout-friendly, padded columns
+      const filenameCol = formatCol(filename, colLengths.filename)
+      const linesCol = formatCol(lineEnd.toString(), colLengths.lines)
+      // Add 1 to the times depended on, assuming that all files are used at least once
+      // (Codehawk reports external uses only)
+      const depsCol = formatCol(
+        (timesDependedOn + 1).toString(),
+        colLengths.timesUsed
+      )
+      const maintainabilityCol = formatCol(score, colLengths.maintainability)
 
-    return (
-      `| ${filenameCol} | ${linesCol} | ${depsCol} | ${maintainabilityCol} |`
-    )
-  }).join('\n    ') // Newline + 4 spaces
+      return `| ${filenameCol} | ${linesCol} | ${depsCol} | ${maintainabilityCol} |`
+    })
+    .join('\n    ') // Newline + 4 spaces
 }
 
-export const formatResultsAsTable = (flatFileResults: FullyAnalyzedFile[]): string => {
+export const formatResultsAsTable = (
+  flatFileResults: FullyAnalyzedFile[]
+): string => {
   return `
     Codehawk Static Analysis Results
     Top ${flatFileResults.length} file${flatFileResults.length > 1 ? 's' : ''}