eslint: add support for standard-with-typescript ruleset

Author: simschla

lib/src/main/resources/com/diffplug/spotless/npm/eslint-serve.js

@@ -1,57 +1,50 @@
 const {ESLint} = require("eslint");
 
 app.post("/eslint/format", async (req, res) => {
+	try {
+		const format_data = req.body;
 
-	const format_data = req.body;
-
-	const ESLintOverrideConfig = format_data.eslint_override_config;
+		const ESLintOverrideConfig = format_data.eslint_override_config;
 
-	const ESLintOverrideConfigFile = format_data.eslint_override_config_file;
+		const ESLintOverrideConfigFile = format_data.eslint_override_config_file;
 
-	if (!ESLintOverrideConfig && !ESLintOverrideConfigFile) {
-		res.status(501).send("Error while formatting: No config provided");
-		return;
-	}
-
-	const filePath = format_data.file_path;
+		if (!ESLintOverrideConfig && !ESLintOverrideConfigFile) {
+			res.status(501).send("Error while formatting: No config provided");
+			return;
+		}
 
-	if (!filePath) {
-		res.status(501).send("Error while formatting: No file path provided");
-		return;
-	}
+		const filePath = format_data.file_path;
 
-	const ESLintOptions = {
-		fix: true,
-		useEslintrc: false, // would result in (gradle) cache issues
-		resolvePluginsRelativeTo: format_data.node_modules_dir
-		// baseConfig: {
-		// 	parserOptions: {
-		// 		tsconfigRootDir: '../../',
-		// 	}
-		// }
-	};
+		if (!filePath) {
+			res.status(501).send("Error while formatting: No file path provided");
+			return;
+		}
 
-	if (format_data.ts_config_root_dir) {
-		ESLintOptions.baseConfig = {
-			parserOptions: {
-				tsconfigRootDir: format_data.ts_config_root_dir
-			}
+		const ESLintOptions = {
+			fix: true,
+			useEslintrc: false, // would result in (gradle) cache issues
+			resolvePluginsRelativeTo: format_data.node_modules_dir
 		};
-		// res.status(501).send("Resolved ts config root dir: " + format_data.ts_config_root_dir);
-	}
 
+		if (format_data.ts_config_root_dir) {
+			ESLintOptions.baseConfig = {
+				parserOptions: {
+					tsconfigRootDir: format_data.ts_config_root_dir
+				}
+			};
+		}
 
-	if (ESLintOverrideConfigFile) {
-		ESLintOptions.overrideConfigFile = ESLintOverrideConfigFile;
-	}
-	if (ESLintOverrideConfig) {
-		ESLintOptions.overrideConfig = ESLintOverrideConfig;
-	}
 
-	const eslint = new ESLint(ESLintOptions);
+		if (ESLintOverrideConfigFile) {
+			ESLintOptions.overrideConfigFile = ESLintOverrideConfigFile;
+		}
+		if (ESLintOverrideConfig) {
+			ESLintOptions.overrideConfig = ESLintOverrideConfig;
+		}
+
+		const eslint = new ESLint(ESLintOptions);
 
 
-	try {
 		console.log("using options: " + JSON.stringify(ESLintOptions));
 		console.log("format input", format_data.file_content);
 		const lintTextOptions = {

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/TypescriptExtensionTest.java

@@ -164,7 +164,7 @@ void useEslint() throws IOException {
 	@Test
 	void useXoStandardRules() throws IOException {
 		setFile(".eslintrc.js").toResource("npm/eslint/typescript/standard_rules_xo/.eslintrc.js");
-		setFile("tsconfig.json").toResource("npm/eslint/typescript/standard_rules_xo/tsconfig.json"); // needs to be copied to!
+		setFile("tsconfig.json").toResource("npm/eslint/typescript/standard_rules_xo/tsconfig.json");
 		setFile("build.gradle").toLines(
 				"plugins {",
 				"    id 'com.diffplug.spotless'",
@@ -173,11 +173,31 @@ void useXoStandardRules() throws IOException {
 				"spotless {",
 				"    typescript {",
 				"        target 'test.ts'",
-				"        eslint().styleGuide('xo-typescript').configFile('.eslintrc.js')//.tsconfigFile('tsconfig.json')", // TODO TODO maybe can skip the additional config files alltogether, instead provide tsConfigRootDir to eslint-serve.js via call
+				"        eslint().styleGuide('xo-typescript').configFile('.eslintrc.js')",
 				"    }",
 				"}");
 		setFile("test.ts").toResource("npm/eslint/typescript/standard_rules_xo/typescript.dirty");
 		gradleRunner().withArguments("--stacktrace", "spotlessApply").build();
 		assertFile("test.ts").sameAsResource("npm/eslint/typescript/standard_rules_xo/typescript.clean");
 	}
+
+	@Test
+	void useStandardWithTypescriptRules() throws IOException {
+		setFile(".eslintrc.js").toResource("npm/eslint/typescript/standard_rules_standard_with_typescript/.eslintrc.js");
+		setFile("tsconfig.json").toResource("npm/eslint/typescript/standard_rules_standard_with_typescript/tsconfig.json");
+		setFile("build.gradle").toLines(
+				"plugins {",
+				"    id 'com.diffplug.spotless'",
+				"}",
+				"repositories { mavenCentral() }",
+				"spotless {",
+				"    typescript {",
+				"        target 'test.ts'",
+				"        eslint().styleGuide('standard-with-typescript').configFile('.eslintrc.js')",
+				"    }",
+				"}");
+		setFile("test.ts").toResource("npm/eslint/typescript/standard_rules_standard_with_typescript/typescript.dirty");
+		gradleRunner().withArguments("--stacktrace", "spotlessApply").build();
+		assertFile("test.ts").sameAsResource("npm/eslint/typescript/standard_rules_standard_with_typescript/typescript.clean");
+	}
 }

testlib/src/main/resources/npm/eslint/typescript/standard_rules_standard_with_typescript/.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+	env: {
+		browser: true,
+		es2021: true
+	},
+	extends: 'standard-with-typescript',
+	overrides: [
+	],
+	parserOptions: {
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+		project: './tsconfig.json',
+	},
+	rules: {
+	}
+}

testlib/src/main/resources/npm/eslint/typescript/standard_rules_standard_with_typescript/tsconfig.json

@@ -0,0 +1,18 @@
+{
+	"compileOnSave": true,
+	"compilerOptions": {
+		"module": "ES6",
+		"noImplicitAny": true,
+		"outDir": "build/ide/",
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"target": "ES6",
+		"baseUrl": "./",
+		"paths": {
+		},
+		"lib": ["es7", "dom", "es2017"]
+	},
+	"include": [
+		"**/*"
+	]
+}

testlib/src/main/resources/npm/eslint/typescript/standard_rules_standard_with_typescript/typescript.clean

@@ -0,0 +1,7 @@
+export class MyController extends AbstractController implements DisposeAware, CallbackAware {
+  public myValue: string[]
+
+  constructor (private readonly myService: Service, name: string, private readonly field: any) { super(name) }
+
+  // ...
+}

testlib/src/main/resources/npm/eslint/typescript/standard_rules_standard_with_typescript/typescript.dirty

@@ -0,0 +1,10 @@
+export class MyController extends AbstractController implements DisposeAware, CallbackAware {
+
+public myValue:string[];
+
+constructor(private myService:Service,name:string,private field:any){ super(name)   ;}
+
+
+//...
+
+}