Format code using Prettier

Author: walles

.eslintrc.json

@@ -6,19 +6,18 @@
         "sourceType": "module"
     },
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "prettier"
+    ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier"
     ],
-    "rules": {
-        "@typescript-eslint/naming-convention": "warn",
-        "@typescript-eslint/semi": "warn",
-        "curly": "warn",
-        "eqeqeq": "warn",
-        "no-throw-literal": "warn",
-        "semi": "off"
-    },
     "ignorePatterns": [
         "out",
         "dist",
         "**/*.d.ts"
     ]
-}
+}

.prettierrc

@@ -0,0 +1,3 @@
+{
+    "printWidth": 80
+}

README.md

@@ -30,6 +30,7 @@ A git commit message highlighter being nicer than the built-in one.
 - Make an icon
 - Move all tests under the same top subdirectory
 - `npm test` in CI
+- Validate code formatting in CI
 - Mark commit message subject line in bold, it _is_ a heading after all.
 - Add a print margin. Can we [configure the default setting for our
   language](https://stackoverflow.com/questions/42607666/how-to-add-a-right-margin-to-the-visual-studio-code-editor)?

package-lock.json

@@ -19,6 +19,7 @@
   "publisher": "walles",
   "main": "./out/extension.js",
   "scripts": {
+    "format": "prettier --config .prettierrc 'src/**/*.ts' --write",
     "compile": "tsc -p ./",
     "lint": "eslint src --ext ts",
     "package": "vsce package",
@@ -55,12 +56,15 @@
     "@vscode/test-electron": "^2.2.0",
     "@vscode/vsce": "^2.16.0",
     "eslint": "^8.28.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "glob": "^8.0.3",
     "mocha": "^10.1.0",
+    "prettier": "^2.8.3",
     "typescript": "^4.9.3",
     "vscode-tmgrammar-test": "^0.1.1"
   },
   "engines": {
     "vscode": "^1.74.0"
   }
-}
+}

package.json

@@ -1,82 +1,92 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
-import * as vscode from 'vscode';
+import * as vscode from "vscode";
 
 const maxSubjectLineLength = 72;
-const maxSubjectLineLengthUrl = vscode.Uri.parse("https://www.gitkraken.com/learn/git/best-practices/git-commit-message");
+const maxSubjectLineLengthUrl = vscode.Uri.parse(
+  "https://www.gitkraken.com/learn/git/best-practices/git-commit-message"
+);
 
 /** Subset of vscode.TextLine, for simplifying test writing. */
 export interface TextLineLite {
-	text: string;
+  text: string;
 }
 
 /** Subset of vscode.TextDocument, for simplifying test writing. */
 export interface TextDocumentLite {
-	lineCount: number;
-	lineAt(line: number): TextLineLite;
+  lineCount: number;
+  lineAt(line: number): TextLineLite;
 }
 
 let diagnosticCollection: vscode.DiagnosticCollection;
 
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
 export function activate(context: vscode.ExtensionContext) {
-	console.log('Git Commit Message Plus says hello!');
-
-	diagnosticCollection = vscode.languages.createDiagnosticCollection('git-commit-message');
-	context.subscriptions.push(diagnosticCollection);
-
-	const documentChangeListener = vscode.workspace.onDidChangeTextDocument(event => {
-		const doc = event.document;
-		if (doc.languageId !== 'git-commit') {
-			return;
-		}
-
-		diagnosticCollection.set(doc.uri, getDiagnostics(doc));
-	}, null, context.subscriptions);
-	context.subscriptions.push(documentChangeListener);
-
-	// FIXME: Make sure linting is triggered when we open a commit message, not
-	// just when it changes. I tried to react to onDidOpenTextDocument(), but
-	// documents seem to default to plain-text when loaded so that didn't work.
+  console.log("Git Commit Message Plus says hello!");
+
+  diagnosticCollection =
+    vscode.languages.createDiagnosticCollection("git-commit-message");
+  context.subscriptions.push(diagnosticCollection);
+
+  const documentChangeListener = vscode.workspace.onDidChangeTextDocument(
+    (event) => {
+      const doc = event.document;
+      if (doc.languageId !== "git-commit") {
+        return;
+      }
+
+      diagnosticCollection.set(doc.uri, getDiagnostics(doc));
+    },
+    null,
+    context.subscriptions
+  );
+  context.subscriptions.push(documentChangeListener);
+
+  // FIXME: Make sure linting is triggered when we open a commit message, not
+  // just when it changes. I tried to react to onDidOpenTextDocument(), but
+  // documents seem to default to plain-text when loaded so that didn't work.
 }
 
 // This method is called when your extension is deactivated
 export function deactivate() {
-	console.log('Git Commit Message Plus says good bye!');
+  console.log("Git Commit Message Plus says good bye!");
 }
 
 function getDiagnostics(doc: TextDocumentLite): vscode.Diagnostic[] {
-	if (doc.lineCount < 1) {
-		return [];
-	}
-
-	let returnMe: vscode.Diagnostic[] = [];
-
-	const firstLine = doc.lineAt(0).text;
-	if (firstLine.length > maxSubjectLineLength) {
-		const range = new vscode.Range(new vscode.Position(0, 72), new vscode.Position(0, firstLine.length));
-
-		let diagnostic = new vscode.Diagnostic(
-			range,
-			`Keep the subject line to at most ${maxSubjectLineLength} characters`,
-			vscode.DiagnosticSeverity.Warning
-		);
-		diagnostic.code = {
-			"target": maxSubjectLineLengthUrl,
-			"value": "Git Commit Message Structure"
-		};
-
-		returnMe.push(diagnostic);
-	}
-
-	return returnMe;
+  if (doc.lineCount < 1) {
+    return [];
+  }
+
+  const returnMe: vscode.Diagnostic[] = [];
+
+  const firstLine = doc.lineAt(0).text;
+  if (firstLine.length > maxSubjectLineLength) {
+    const range = new vscode.Range(
+      new vscode.Position(0, 72),
+      new vscode.Position(0, firstLine.length)
+    );
+
+    const diagnostic = new vscode.Diagnostic(
+      range,
+      `Keep the subject line to at most ${maxSubjectLineLength} characters`,
+      vscode.DiagnosticSeverity.Warning
+    );
+    diagnostic.code = {
+      target: maxSubjectLineLengthUrl,
+      value: "Git Commit Message Structure",
+    };
+
+    returnMe.push(diagnostic);
+  }
+
+  return returnMe;
 }
 
 // Exports for testing
 //
 // Ref: https://stackoverflow.com/a/65422568/473672
 export const _private = {
-	getDiagnostics,
-	maxSubjectLineLengthUrl
+  getDiagnostics,
+  maxSubjectLineLengthUrl,
 };

src/extension.ts

@@ -1,23 +1,23 @@
-import * as path from 'path';
+import * as path from "path";
 
-import { runTests } from '@vscode/test-electron';
+import { runTests } from "@vscode/test-electron";
 
 async function main() {
-	try {
-		// The folder containing the Extension Manifest package.json
-		// Passed to `--extensionDevelopmentPath`
-		const extensionDevelopmentPath = path.resolve(__dirname, '../../');
+  try {
+    // The folder containing the Extension Manifest package.json
+    // Passed to `--extensionDevelopmentPath`
+    const extensionDevelopmentPath = path.resolve(__dirname, "../../");
 
-		// The path to test runner
-		// Passed to --extensionTestsPath
-		const extensionTestsPath = path.resolve(__dirname, './suite/index');
+    // The path to test runner
+    // Passed to --extensionTestsPath
+    const extensionTestsPath = path.resolve(__dirname, "./suite/index");
 
-		// Download VS Code, unzip it and run the integration test
-		await runTests({ extensionDevelopmentPath, extensionTestsPath });
-	} catch (err) {
-		console.error('Failed to run tests');
-		process.exit(1);
-	}
+    // Download VS Code, unzip it and run the integration test
+    await runTests({ extensionDevelopmentPath, extensionTestsPath });
+  } catch (err) {
+    console.error("Failed to run tests");
+    process.exit(1);
+  }
 }
 
 main();