Merge pull request #42 from vitonsky/37-comments-in-tsconfig-break-the-linter

feat: parse json configs even with comments

Author: vitonsky

package-lock.json

@@ -46,5 +46,8 @@
 		"ts-jest": "^29.1.2",
 		"tslib": "^2.6.2",
 		"typescript": "^5.4.3"
+	},
+	"dependencies": {
+		"comment-json": "^4.2.3"
 	}
 }

package.json

@@ -1,5 +1,6 @@
 'use strict';
 
+import { parse as parseJsonWithComments } from 'comment-json';
 import { Rule } from 'eslint';
 import fs from 'fs';
 import path from 'path';
@@ -34,11 +35,12 @@ function findAlias(
 			: null;
 
 	if (configFile) {
-		const tsconfig = JSON.parse(
+		const tsconfig = parseJsonWithComments(
 			fs.readFileSync(path.join(baseDir, configFile)).toString('utf8'),
 		);
 
-		const paths: Record<string, string[]> = tsconfig?.compilerOptions?.paths ?? {};
+		const paths: Record<string, string[]> =
+			(tsconfig as any)?.compilerOptions?.paths ?? {};
 		for (const [alias, aliasPaths] of Object.entries(paths)) {
 			// TODO: support full featured glob patterns instead of trivial cases like `@utils/*` and `src/utils/*`
 			const matchedPath = aliasPaths.find((dirPath) => {

src/rules/alias.ts

@@ -29,6 +29,7 @@
 		"allowJs": true,
 		"resolveJsonModule": true,
 		"skipLibCheck": true,
+		// Test comment, that must not break a parsing of config file
 		"baseUrl": ".",
 		"paths": {
 			"@foo/*": ["src/foo/*"],