@nextcloud/eslint-config 8.2.1 → 8.3.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v8.3.0-beta.0](https://github.com/nextcloud/eslint-config/tree/v8.3.0-beta.0) (2023-05-12)
+
+[Full Changelog](https://github.com/nextcloud/eslint-config/compare/v8.2.1...v8.3.0-beta.0)
+
+**Merged pull requests:**
+- Typescript 5 support
+- Various dependencies upgrades
+
 ## [v8.2.1](https://github.com/nextcloud/eslint-config/tree/v8.2.1) (2023-01-30)
 
 [Full Changelog](https://github.com/nextcloud/eslint-config/compare/v8.2.0...v8.2.1)

package/index.js

@@ -121,7 +121,7 @@ module.exports = {
 	},
 	overrides: [
 		{
-			files: ['**/*.ts'],
+			files: ['**/*.ts', '**/*.tsx'],
 			extends: [
 				'@vue/eslint-config-typescript/recommended',
 				'plugin:import/typescript',
@@ -148,7 +148,7 @@ module.exports = {
 				'import/resolver': {
 					node: {
 						paths: ['src'],
-						extensions: ['.js', '.ts', '.vue'],
+						extensions: ['.(m|c)?js', '.ts', '.tsx', '.vue'],
 					},
 				},
 			},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/eslint-config",
-  "version": "8.2.1",
+  "version": "8.3.0-beta.0",
   "description": "Eslint shared config for nextcloud vue.js apps",
   "main": "index.js",
   "repository": {
@@ -9,7 +9,8 @@
   },
   "scripts": {
     "lint": "eslint -c index.js *.js",
-    "lint:fix": "eslint -c index.js --fix *.js"
+    "lint:fix": "eslint -c index.js --fix *.js",
+    "test": "jest"
   },
   "peerDependencies": {
     "@babel/core": "^7.13.10",
@@ -20,27 +21,30 @@
     "eslint-config-standard": "^17.0.0",
     "eslint-import-resolver-exports": "^1.0.0-beta.4",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-jsdoc": "^43.0.3",
     "eslint-plugin-n": "^15.5.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-vue": "^9.7.0",
-    "typescript": "^4.9.4",
+    "typescript": "^5.0.2",
     "webpack": "^5.4.0"
   },
   "devDependencies": {
     "@babel/core": "^7.13.10",
     "@babel/eslint-parser": "^7.16.5",
     "@nextcloud/eslint-plugin": "^2.0.0",
+    "@types/jest": "^29.4.0",
     "@vue/eslint-config-typescript": "^11.0.2",
     "eslint": "^8.27.0",
-    "eslint-import-resolver-exports": "^1.0.0-beta.4",
     "eslint-config-standard": "^17.0.0",
+    "eslint-import-resolver-exports": "^1.0.0-beta.4",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-jsdoc": "^43.0.3",
     "eslint-plugin-n": "^15.5.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-vue": "^9.7.0",
-    "typescript": "^4.9.4",
+    "jest": "^29.4.1",
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.0.2",
     "webpack": "^5.4.0"
   },
   "keywords": [
@@ -59,5 +63,12 @@
   "engines": {
     "node": "^16.0.0",
     "npm": "^7.0.0 || ^8.0.0"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "setupFilesAfterEnv": [
+      "./tests/setup-jest.ts"
+    ]
   }
 }

package/tests/eslint-config.test.ts

@@ -0,0 +1,31 @@
+import { ESLint } from "eslint"
+import type { Linter } from "eslint"
+import * as path from 'path'
+import * as eslintConfig from '../index.js'
+
+
+const eslint = new ESLint({
+	baseConfig: eslintConfig as unknown as Linter.Config<Linter.RulesRecord>
+})
+
+const lintFile = async (file) => {
+	const real = path.resolve(path.join(__dirname, file))
+	return await eslint.lintFiles(real)
+}
+
+test('some basic issues should fail', async () => {
+	const results = await lintFile('fixtures/example-fail.js')
+	expect(results).toHaveIssueCount(3)
+	expect(results).toHaveIssue('spaced-comment')
+	expect(results).toHaveIssue({ ruleId: 'no-console', line: 3 })
+})
+
+test('TSX is linted', async () => {
+	const ignored = await eslint.isPathIgnored('./fixtures/some.tsx')
+	expect(ignored).toBe(false)
+
+	const results = await lintFile('fixtures/some.tsx')
+	expect(results).toHaveIssue({ruleId: 'jsdoc/check-tag-names', line: 5})
+	expect(results).toHaveIssue({ruleId: '@typescript-eslint/no-unused-vars', line: 7})
+	expect(results).toHaveIssueCount(2)
+})

package/tests/eslint.d.ts

@@ -0,0 +1,11 @@
+export { }
+
+declare global {
+	namespace jest {
+		interface Matchers<R> {
+			toPass(): R;
+			toHaveIssueCount(n: number): R;
+			toHaveIssue(issue: string | {ruleId: string, line?: number}): R;
+		}
+	}
+}

package/tests/fixtures/example-fail.js

@@ -0,0 +1,3 @@
+//should fail because of missing space on this comment
+// and usage of `console` and using a semicolon
+console.log('some');

package/tests/fixtures/some.tsx

@@ -0,0 +1,7 @@
+// TSX
+
+/**
+ * @notExported <- should work
+ * @aaabbbcccddd <- should fail
+ */
+const foo = '' // <- should fail, as unused

package/tests/setup-jest.ts

@@ -0,0 +1,128 @@
+import { ESLint, Linter } from "eslint"
+
+/**
+ * Add some custom matchers for ESLint to jest
+ */
+expect.extend({
+	toPass: assertLintingPassed,
+	toHaveIssueCount: assertHavingNIssues,
+	toHaveIssue: assertHavingIssue
+})
+
+/**
+ * Check if linting a file did not throw any errors or warnings
+ *
+ * @param received Lint result
+ */
+function hasNoIssues(received: ESLint.LintResult) {
+	// dirty type check
+	if (received?.errorCount === undefined) throw new Error('Expected ESLintResult')
+
+	return received.errorCount === 0 && received.warningCount === 0
+}
+
+/**
+ * Check if linting of multiple fils
+ *
+ * @param received 
+ * @returns {}
+ */
+function assertLintingPassed(received: ESLint.LintResult | ESLint.LintResult[]) {
+	// allow single ESLintResult
+	if (!Array.isArray(received)) {
+		received = [received]
+	}
+
+	const errors = [] as {file: string, errors: Linter.LintMessage[]}[]
+	const pass = received.every((result) => {
+		// save issues
+		errors.push({file: result.filePath, errors: result.messages})
+		return hasNoIssues(result)
+	})
+
+	return {
+		pass,
+		message: () => {
+			if (pass) {
+				return 'Expected file to not pass eslint, but got no issues'
+			} else {
+				const errorMessages = errors.map((m) => 
+					`file: ${m.file}\n` + m.errors.map((e) => 'line: ' + e.line + ': ' + (e.ruleId || e.message))
+				)
+				return 'Expected file to pass eslint, got issues:\n' + errorMessages.join('\n')
+			}
+		}
+	}
+}
+
+/**
+ * Count the total amount of issues
+ *
+ * @param received lint result
+ * @returns total amount of issues
+ */
+function countIssues(received: ESLint.LintResult) {
+	return received.errorCount + received.warningCount
+}
+
+/**
+ * Check if exactly the same number of issues is reported
+ *
+ * @param received the lint result
+ * @param expected number of expected issues
+ * @returns jest matcher result
+ */
+function assertHavingNIssues(received: ESLint.LintResult | ESLint.LintResult[], expected: number) {
+	if (!(typeof expected === 'number')) throw new Error('Expected a number as expected value')
+
+	if (!Array.isArray(received)) {
+		received = [received]
+	}
+
+	const issues = received.map(countIssues).reduce((p, c) => p + c)
+	const pass = issues === expected
+
+	return {
+		pass,
+		message: () => pass ? `Expected not to find exactly ${expected} issues.` : `Expected ${expected} issues, found ${issues}`
+	}
+}
+
+/**
+ * Check if result contains the expected issue
+ *
+ * @param received the lint result
+ * @param issue the expected issue
+ * @returns jest matcher result
+ */
+function assertHavingIssue(received: ESLint.LintResult | ESLint.LintResult[], issue: string | {ruleId: string, line?: number}) {
+	if (!Array.isArray(received)) {
+		received = [received]
+	}
+
+	// Should not pass
+	if (assertLintingPassed(received).pass) {
+		return {
+			pass: false,
+			message: () => 'Expected issue, but no linting issues found.'
+		}
+	}
+
+	const name = typeof issue === 'string' ? issue : issue.ruleId
+	const result = received.some((result) => {
+		return result.messages.some((message) => {
+			// ensure name matches
+			if (message.ruleId !== name) return false
+			// if line is requested ignore not matching ones
+			if (typeof issue === 'object' && issue.line !== undefined && issue.line !== message.line) return false
+			// otherwise matched	
+			return true
+		})
+	});
+
+	const onLine = typeof issue === 'string' ? '' : ` on line ${issue.line}`
+	return {
+		pass: result,
+		message: () => result ? `Unexpected error '${name}'${onLine} found.`  : `Expected error '${name}'${onLine} not found.`
+	}
+}