100% coverage; lint

Author: zachbryant

jest.config.js

@@ -4,10 +4,10 @@ module.exports = {
   coverageReporters: [['text', { skipFull: false, skipEmpty: true }], 'lcov'],
   coverageThreshold: {
     global: {
-      branches: 94,
+      branches: 100,
       functions: 100,
       lines: 100,
-      statements: 98,
+      statements: 100,
     },
   },
   moduleDirectories: ['node_modules', 'src'],

package.json

@@ -35,18 +35,19 @@
     "docs": "eslint-docs",
     "format": "prettier --write src/**/*.{js,ts} tests/**/*.{js,ts}",
     "lint": "eslint --ext .js,.ts src/ tests/",
+    "lint:fix": "yarn lint --fix",
     "prepublishOnly": "MINIFY=1 yarn build",
     "purge": "yarn -s rimraf node_modules lib",
     "test:autofix": "yarn -s jest ./tests/autofix.spec.ts",
     "test:config": "yarn -s jest ./tests/config.spec.ts",
+    "test:enum": "yarn -s jest ./tests/rules/enum/*.spec.ts",
     "test:interface": "yarn -s jest ./tests/rules/interface/*.spec.ts",
     "test:rules": "yarn -s jest ./tests/rules/*/*.spec.ts --collectCoverage=true",
-    "test:enum": "yarn -s jest ./tests/rules/enum/*.spec.ts",
     "test:watch:autofix": "yarn jest --watch ./tests/autofix.spec.ts",
     "test:watch:config": "yarn jest --watch ./tests/config.spec.ts",
+    "test:watch:enum": "yarn jest --watch ./tests/rules/enum/*.spec.ts",
     "test:watch:interface": "yarn jest --watch ./tests/rules/interface/*.spec.ts",
     "test:watch:rules": "yarn jest --watch ./tests/rules/*/*.spec.ts",
-    "test:watch:enum": "yarn jest --watch ./tests/rules/enum/*.spec.ts",
     "test:watch": "yarn -s jest --watch .*.spec.ts",
     "test": "yarn -s jest .*.spec.ts --collectCoverage=true",
     "typecheck": "tsc --noEmit --skipLibCheck",
@@ -74,7 +75,7 @@
     "@types/node": "^18.0.0",
     "@types/tmp": "~0.2.4",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
+    "@typescript-eslint/parser": "~6.13.2",
     "babel-jest": "~29.7.0",
     "babel-plugin-module-resolver": "~5.0.0",
     "chalk": "~5.3.0",

src/config/constants.ts

@@ -1 +1 @@
-export const PLUGIN_NAME = 'typescript-sort-keys'
+export const PLUGIN_NAME = 'typescript-sort-keys'

src/utils/sourcecode/commentHelpers.ts

@@ -1,5 +1,7 @@
-import { AST_NODE_TYPES, AST_TOKEN_TYPES, TSESTree } from '@typescript-eslint/utils'
 import { Node, SourceCode } from 'types'
+
+import { AST_NODE_TYPES, AST_TOKEN_TYPES, TSESTree } from '@typescript-eslint/utils'
+
 import { getLatestNode } from './nodeHelpers'
 import {
   getDeclarationPunctuators,

src/utils/sourcecode/nodeHelpers.ts

@@ -23,6 +23,6 @@ export function getNextNonCommentNode(sourceCode: SourceCode, node: Node) {
   return nextNode ?? undefined
 }
 export function getPreviousNonCommentNode(sourceCode: SourceCode, node: Node) {
-  const nextNode = sourceCode.getTokenBefore(node, { includeComments: false })
-  return nextNode ?? undefined
+  const prevNode = sourceCode.getTokenBefore(node, { includeComments: false })
+  return prevNode ?? undefined
 }

src/utils/sourcecode/punctuationHelpers.ts

@@ -1,6 +1,8 @@
-import { AST_NODE_TYPES, AST_TOKEN_TYPES } from '@typescript-eslint/utils'
 import assert from 'assert'
 import { Node, SourceCode } from 'types'
+
+import { AST_NODE_TYPES, AST_TOKEN_TYPES } from '@typescript-eslint/utils'
+
 import {
   getEarliestNode,
   getLatestNode,
@@ -31,6 +33,7 @@ export function getNodePunctuator(
     includeComments: false,
   })
   // Ensure we don't go beyond the parent into the source code
+
   return punctuator && punctuator.range[1] <= (node.parent?.range[1] || Infinity)
     ? punctuator
     : undefined

tests/autofix.spec.ts

@@ -1,7 +1,9 @@
-import { ESLint } from '@typescript-eslint/utils/ts-eslint'
 import fs from 'fs'
 import path from 'path'
 import tmp from 'tmp'
+
+import { ESLint } from '@typescript-eslint/utils/ts-eslint'
+
 import { Config, getESLint } from './helpers/eslint'
 
 describe('autofix', () => {

tests/helpers/eslint.ts

@@ -1,10 +1,15 @@
+import { Linter } from 'eslint'
+
 import { ESLint } from '@typescript-eslint/utils/ts-eslint'
 
 import plugin from '../../src'
 import recommended from '../../src/config/recommended.config'
 import requiredFirst from '../../src/config/requiredFirst.config'
 import { typescriptConfig } from './configs'
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const parser = require('@typescript-eslint/parser')
+
 export enum Config {
   Recommended,
   RequiredFirst,
@@ -30,3 +35,32 @@ export function getESLint(config: Config, fix = true) {
   })
   return eslint
 }
+
+// For unit testing
+export function getSourceCode(code: string) {
+  const linter = new Linter()
+  linter.defineParser('@typescript-eslint/parser', parser)
+
+  const config = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+    rules: {},
+    settings: {
+      'import/parsers': {
+        '@typescript-eslint/parser': ['.ts', '.tsx'],
+      },
+      'import/resolver': {
+        typescript: {
+          alwaysTryTypes: true,
+        },
+      },
+    },
+  } as Linter.Config
+
+  const messages = linter.verify(code, config)
+
+  return messages[0]?.fatal ? null : linter.getSourceCode()
+}

tests/unit/utils/sourcecode/commentHelpers.spec.ts

@@ -0,0 +1,24 @@
+import { AST_TOKEN_TYPES, TSESTree } from '@typescript-eslint/utils'
+
+import { getCommentsBefore } from '../../../../src/utils/sourcecode'
+import { getSourceCode } from '../../../helpers/eslint'
+
+describe('commentHelpers.spec.ts coverage', () => {
+  it('returns empty array with no prevNode', () => {
+    const code = 'enum U {A = "a", B = "b", C = "c"}'
+    const sourceCode = getSourceCode(code)
+    const result = getCommentsBefore(sourceCode, sourceCode.getNodeByRangeIndex(0))
+    expect(result).toEqual([])
+  })
+
+  it('returns comment of specified type', () => {
+    const code = 'enum U {A = "a", /* b */ B = "b", C = "c"}'
+    const sourceCode = getSourceCode(code)
+    const result: TSESTree.Comment[] = getCommentsBefore(
+      sourceCode,
+      sourceCode.getTokenByRangeStart(code.indexOf('B')),
+      AST_TOKEN_TYPES.Block,
+    )
+    expect(result[0].value).toBe(' b ')
+  })
+})

tests/unit/utils/sourcecode/nodeHelpers.spec.ts

@@ -0,0 +1,48 @@
+import {
+  getEarliestNode,
+  getNextNonCommentNode,
+  getPreviousNonCommentNode,
+} from '../../../../src/utils/sourcecode'
+import { getSourceCode } from '../../../helpers/eslint'
+
+describe('nodeHelpers.spec.ts coverage', () => {
+  const code = 'enum U /**/{/**/A = "a", /**/B = "b", /**/C = "c"}/**/'
+  const sourceCode = getSourceCode(code)
+  const nodes = ['A', 'B', 'C'].map(_ => sourceCode.getNodeByRangeIndex(code.indexOf(_)))
+
+  describe('getEarliestNode', () => {
+    it('returns correct value from out of order array', () => {
+      const nodesReversed = Array.from(nodes).reverse()
+      const result = getEarliestNode(nodesReversed)
+      expect(result).toEqual(nodes[0])
+    })
+  })
+
+  describe('getNextNonCommentNode', () => {
+    it('returns nullish when given final node', () => {
+      const result = getNextNonCommentNode(
+        sourceCode,
+        sourceCode.getNodeByRangeIndex(code.indexOf('}')),
+      )
+      expect(result).toBeFalsy()
+    })
+    it('returns truthy when given middle node', () => {
+      const result = getNextNonCommentNode(sourceCode, nodes[1])
+      expect(result).toBeTruthy()
+    })
+  })
+
+  describe('getPreviousNonCommentNode', () => {
+    it('returns nullish when given first node', () => {
+      const result = getPreviousNonCommentNode(
+        sourceCode,
+        sourceCode.getNodeByRangeIndex(code.indexOf('{')),
+      )
+      expect(result).toBeFalsy()
+    })
+    it('returns truthy when given middle node', () => {
+      const result = getPreviousNonCommentNode(sourceCode, nodes[1])
+      expect(result).toBeTruthy()
+    })
+  })
+})

tests/unit/utils/sourcecode/punctuationHelpers.spec.ts

@@ -0,0 +1,26 @@
+import { getNodePunctuator } from '../../../../src/utils/sourcecode'
+import { getSourceCode } from '../../../helpers/eslint'
+
+describe('punctuationHelpers.spec.ts coverage', () => {
+  describe('getNodePunctuator', () => {
+    it('returns nullish', () => {
+      const code = 'enum U {A = "a"}'
+      const sourceCode = getSourceCode(code)
+      const result = getNodePunctuator(
+        sourceCode,
+        sourceCode.getNodeByRangeIndex(code.indexOf('A')),
+      )
+      expect(result).toBeFalsy()
+    })
+
+    it('returns punctuator when node parent is nullish', () => {
+      const code = 'interface U {A: string; b: string;}'
+      const sourceCode = getSourceCode(code)
+      const node = sourceCode.getNodeByRangeIndex(code.indexOf('A'))
+      node['parent'] = undefined
+
+      const result = getNodePunctuator(sourceCode, node)
+      expect(result).toBeTruthy()
+    })
+  })
+})

tests/unit/utils/sourcecode/textHelpers.spec.ts

@@ -0,0 +1,25 @@
+import {
+  getTextBetweenNodeAndNext,
+  getTextBetweenNodeAndPrevious,
+} from '../../../../src/utils/sourcecode'
+import { getSourceCode } from '../../../helpers/eslint'
+
+describe('textHelpers.spec.ts coverage', () => {
+  const code = 'enum U {A = "a", B = "b"}'
+  const sourceCode = getSourceCode(code)
+  const nodes = ['{', '}'].map(_ => sourceCode.getNodeByRangeIndex(code.indexOf(_)))
+
+  describe('getTextBetweenNodeAndPrevious', () => {
+    it('returns empty string given first node', () => {
+      const result = getTextBetweenNodeAndPrevious(sourceCode, nodes[0])
+      expect(result).toBe('')
+    })
+  })
+
+  describe('getTextBetweenNodeAndNext', () => {
+    it('returns empty string given last node', () => {
+      const result = getTextBetweenNodeAndNext(sourceCode, nodes.at(-1))
+      expect(result).toBe('')
+    })
+  })
+})

yarn.lock

@@ -1678,7 +1678,7 @@
     semver "^7.5.4"
     ts-api-utils "^1.0.1"
 
-"@typescript-eslint/parser@^6.7.4":
+"@typescript-eslint/parser@~6.13.2":
   version "6.13.2"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-6.13.2.tgz#390b79cc9a57a5f904d197a201cc4b6bc4f9afb9"
   integrity sha512-MUkcC+7Wt/QOGeVlM8aGGJZy1XV5YKjTpq9jK6r6/iLsGXhBVaGP5N0UYvFsu9BFlSpwY9kMretzdBH01rkRXg==