v11

Author: Sertion

CHANGELOG.md

@@ -1,10 +1,14 @@
 # Change Log
 
-## 10.11.0 (May, 09, 2024)
+## 11.0.0 (May xx, 2024)
+* Feature: Will no longer blame files with more lines than `gitblame.maxLineCount` (default `16384`) [#172](https://github.com/Sertion/vscode-gitblame/issues/172)* Thanks to [webextensions](https://github.com/webextensions).
+  * Fun fact: This number was selected as it is the last power of 2 lower than 20000. It has no other significance.
+
+## 10.11.0 (May 09, 2024)
 * Feature: *Copy commit hash on info message click [#171](https://github.com/Sertion/vscode-gitblame/issues/171)* Thanks to [Harsh](https://github.com/harshbhatt).
 * Fix: Updating dependencies
 
-## 10.10.1 (April, 30, 2024)
+## 10.10.1 (April 30, 2024)
 * Bug: *Status Bar block disappears after a change in extension settings [#155](https://github.com/Sertion/vscode-gitblame/issues/155)* Thanks to [ADTC](https://github.com/ADTC).
 * Fix: Updating dependencies
 
@@ -52,7 +56,7 @@
 
 ## 10.3.0 (June 23, 2023)
 * Bug: Spawns many Git processes and uses up CPU ([#144](https://github.com/Sertion/vscode-gitblame/issues/144)) Thanks to [Theo Crandall](https://github.com/thrandale)!
-  * New setting `gitblame.parallelBlames` controlls how many git blame processes that will run in parallel. Defaults to `2`.
+  * New setting `gitblame.parallelBlames` controls how many git blame processes that will run in parallel. Defaults to `2`.
 * Bug: Blame completing can sometimes update the status bar to info from the wrong file
 * Fix: Fewer dev dependencies
 
@@ -121,7 +125,7 @@
 * Fix: CHANGELOG.md link to contributor
 
 ## 8.2.0 (May 13, 2022)
-* Feature: Blame information as soon as it is avalible. This will allow some lines to show blame information while others still are waiting for `git blame`.
+* Feature: Blame information as soon as it is available. This will allow some lines to show blame information while others still are waiting for `git blame`.
 * Feature: Allow blaming symlinked files [#121](https://github.com/Sertion/vscode-gitblame/pull/121) (Thanks to [Angel Fraga Parodi](https://github.com/angelfraga))
 * Bug: Blame info persistent over file change and file close [#115](https://github.com/Sertion/vscode-gitblame/issues/115) (Thanks to [Wenfang Du](https://github.com/wenfangdu) and [Viktor Stenqvist](https://github.com/Yottster))
 * Bug: commit.summary before commit.hash_short causes display bug [#119](https://github.com/Sertion/vscode-gitblame/issues/119) (Thanks to [Cathryne Linenweaver](https://github.com/Cathryne))
@@ -182,7 +186,7 @@
 * Bug: Stuck Waiting for git blame response (6.0.0) [#95](https://github.com/Sertion/vscode-gitblame/issues/95) (Thanks to [Vadzim Dambrouski](https://github.com/pftbest))
 
 ## 6.0.0 (October 14, 2020)
-* Breaking change: Removing setting `gitblame.logNonCritical` as we no longer produce any ciritcal errors
+* Breaking change: Removing setting `gitblame.logNonCritical` as we no longer produce any critical errors
 * Breaking change: The token `${|mod}` now expands to `|mod`, previously `${|mod}`
 * Breaking change: Renamed output channel from "Extension: gitblame" to "gitblame"
 * Bug: "Waiting for git blame response" (5.0.1) [#92](https://github.com/Sertion/vscode-gitblame/issues/92) (Thanks to [Dominik Zogg](https://github.com/dominikzogg) and [Alex Shelmire](https://github.com/shelmire))
@@ -204,15 +208,15 @@
 ## 4.1.0 (July 09, 2020)
 * Feature: Improve time ago estimate [#83](https://github.com/Sertion/vscode-gitblame/pull/83) (Thanks to [Ben Langlois](https://github.com/BenLanglois))
 * Feature: Unable to open '': File is a directory. [#84](https://github.com/Sertion/vscode-gitblame/issues/84) (Thanks to [Matt Fletcher](https://github.com/MaffooBristol))
-* Bug: Refixing [#3](https://github.com/Sertion/vscode-gitblame/issues/3)
+* Bug: Re-fixing [#3](https://github.com/Sertion/vscode-gitblame/issues/3)
 * Fix: Updating dependencies
 * Fix: Updated linters means pushing around code
 
 ## 4.0.1 (May 13, 2020)
 * Bug: Undocumented change to [StatusBarItem api](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem) [#82](https://github.com/Sertion/vscode-gitblame/issues/82) (Thanks to [Mike MacCana](https://github.com/mikemaccana))
 
 ## 4.0.0 (May 01, 2020)
-* Deprication: Removing all depricated message token
+* Deprecation: Removing all deprecated message token
 * Feature: It is now able to limit the length of the summary [#81](https://github.com/Sertion/vscode-gitblame/issues/81) (Thanks to [Diab Neiroukh](https://github.com/lazerl0rd))
 
 ## 3.2.0 (March 09, 2020)
@@ -230,19 +234,19 @@
 * Fix: Updating dependencies
 
 ## 3.0.1 (August 02, 2019)
-* Bug: Removing depricated token from default value for `gitblame.infoMessageFormat` [#57](https://github.com/Sertion/vscode-gitblame/issues/57) (Thanks to [Kyngo](https://github.com/Kyngo))
+* Bug: Removing deprecated token from default value for `gitblame.infoMessageFormat` [#57](https://github.com/Sertion/vscode-gitblame/issues/57) (Thanks to [Kyngo](https://github.com/Kyngo))
 
 ## 3.0.0 (July 27, 2019)
 * Bug: Fixing rare bug where swapping between different file views didn't update the view
-* Deprication: Removing the `.custom` tokens from status bar message
-* Deprication: The `.from` token now is identical to `.ago`
-* Deprication: Removing the `commit.filename` tokens from status bar message
-* Deprication: Removing custom spinner support (`gitblame.progressSpinner`)
-* Deprication: Removing log levels (`gitblame.logLevel`). It is replaced by `gitblame.logNonCritical` (defaults to `true`)
+* Deprecation: Removing the `.custom` tokens from status bar message
+* Deprecation: The `.from` token now is identical to `.ago`
+* Deprecation: Removing the `commit.filename` tokens from status bar message
+* Deprecation: Removing custom spinner support (`gitblame.progressSpinner`)
+* Deprecation: Removing log levels (`gitblame.logLevel`). It is replaced by `gitblame.logNonCritical` (defaults to `true`)
 * Feature: Blame cache is now tied to the open document. Closing the document will clear if from the cache
 * Feature: Move to the new `@types/vscode` and `vscode-test` packages
 * Feature: Move to new build system
-* Fix: Removeing or updating dependencies
+* Fix: Removing or updating dependencies
 
 The removal of the custom-token allows us to remove our dependency on moment. This lowers the extension bundle size from 850 kb to about 100 kb.
 
@@ -293,8 +297,8 @@ There is a new setting called `gitblame.pluralWebPathSubstrings`. It is an array
 * Feature: We now use `vscode.git` to find your git binary.
 * Fix: Change the default info message format to be prefixed by the date instead of the commit hash. It is in ISO 8601 with dashes for separator.
 * Fix: Updating Readme to better guide Bitbucket users to the `isWebPathPlural` setting.
-* Fix: Removed `internalHashLength` setting. We now alsways use the whole hash.
-* Fix: Moved back to using [`fs.watch`](https://nodejs.org/api/fs.html#fs_fs_watch_filename_options_listener) from [`workspace.FileSystemWatcher`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#workspace.createFileSystemWatcher) after getting reposts that file watching is having issues.
+* Fix: Removed `internalHashLength` setting. We now always use the whole hash.
+* Fix: Moved back to using [`fs.watch`](https://nodejs.org/api/fs.html#fs_fs_watch_filename_options_listener) from [`workspace.FileSystemWatcher`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#workspace.createFileSystemWatcher) after getting reports that file watching is having issues.
 * Fix: Better handling of ENOENT in git command runner. [#41](https://github.com/Sertion/vscode-gitblame/pull/41) (Thanks to [Yottster](https://github.com/Yottster))
 * Fix: Moved to strict TypeScript.
 * Fix: Updating dependencies
@@ -305,7 +309,7 @@ There is a new setting called `gitblame.pluralWebPathSubstrings`. It is an array
 
 ## 2.4.3 (August 01, 2018)
 
-* Bug: Showing unedited gitblame info template when running *Show quick Info* on unblameable line (Thanks to [BerndErnst](https://github.com/BerndErnst))
+* Bug: Showing unedited gitblame info template when running *Show quick Info* on un-blameable line (Thanks to [BerndErnst](https://github.com/BerndErnst))
 * Bug: Using a map instead of an object for storing git blame file cache. Now we can blame files named `__proto__` etc.
 
 ## 2.4.2 (April 05, 2018)
@@ -326,7 +330,7 @@ There is a new setting called `gitblame.pluralWebPathSubstrings`. It is an array
 
 ## 2.3.0 (March 24, 2018)
 
-* Feature: Atempting to auto detect if you use a known git web interface [#15](https://github.com/Sertion/vscode-gitblame/issues/15) (Thanks to [@Fidge123](https://github.com/Fidge123), [@sabrehagen](https://github.com/sabrehagen), [@henvic](https://github.com/henvic), and an extra thanks to [@neerolyte](https://github.com/neerolyte))
+* Feature: Attempting to auto detect if you use a known git web interface [#15](https://github.com/Sertion/vscode-gitblame/issues/15) (Thanks to [@Fidge123](https://github.com/Fidge123), [@sabrehagen](https://github.com/sabrehagen), [@henvic](https://github.com/henvic), and an extra thanks to [@neerolyte](https://github.com/neerolyte))
 * Feature: Added `gitblame.statusBarPositionPriority` for moving the status bar view [#25](https://github.com/Sertion/vscode-gitblame/issues/25) (Thanks to [@jvoigt](https://github.com/jvoigt))
 * Fix: Merging `GitBlame` and `GitBlameController` to `GitBlame`
 * Fix: Renaming `GitBlameFile*` to `GitFile*`

README.md

@@ -10,7 +10,7 @@ Features:
 
 ![Feature Usage](https://raw.githubusercontent.com/Sertion/vscode-gitblame/master/images/preview.png)
 
-Git blame adds git blame information to your vscode compatible view. See information about what commit last changed a line and how long ago it was. Click the message to see more information about the commit. It is possible to edit all of these information messages in the settings. There are multiple tokens avalible. These are described below.
+Git blame adds git blame information to your vscode compatible view. See information about what commit last changed a line and how long ago it was. Click the message to see more information about the commit. It is possible to edit all of these information messages in the settings. There are multiple tokens available. These are described below.
 
 Git Blame works very well with WSL but does not work with the web browser based vscode compatible editors.
 
@@ -105,7 +105,7 @@ Message on the current line when no commit can be found. _No available tokens_.
 
 > Default value: `false`
 
-To enable the inline git blame view. Shows blame information at the end of the current line if avalible.
+To enable the inline git blame view. Shows blame information at the end of the current line if available.
 
 ### `gitblame.inlineMessageMargin`
 > Type: `number`

package-lock.json

@@ -2,10 +2,11 @@
   "name": "gitblame",
   "displayName": "Git Blame",
   "description": "See git blame information in the status bar.",
-  "version": "10.11.0",
+  "version": "11.0.0",
   "publisher": "waderyan",
   "engines": {
-    "vscode": "^1.82.0"
+    "vscode": "^1.82.0",
+    "node": "^18.15.0"
   },
   "categories": [
     "Other"
@@ -61,7 +62,11 @@
     "vscode.git"
   ],
   "capabilities": {
-    "virtualWorkspaces": false
+    "virtualWorkspaces": false,
+    "untrustedWorkspaces": {
+      "supported": false,
+      "description": "Git Blame (extension) executes command line tools in the workspace"
+    }
   },
   "contributes": {
     "commands": [
@@ -195,6 +200,11 @@
           "default": 2,
           "description": "Limit allowed parallel git blame process count"
         },
+        "gitblame.maxLineCount": {
+          "type": "number",
+          "default": 16384,
+          "markdownDescription": "Will skip blaming files with **more** lines than this value"
+        },
         "gitblame.revsFile": {
           "type": "array",
           "default": [],

package.json

@@ -1,24 +1,24 @@
 import { type FSWatcher, promises, watch } from "node:fs";
 
-import type { LineAttatchedCommit } from "./util/stream-parsing.js";
+import type { LineAttachedCommit } from "./util/stream-parsing.js";
 
 import { type Disposable, workspace } from "vscode";
 import { Logger } from "../util/logger.js";
 import { getProperty } from "../util/property.js";
 import { type Blame, File } from "./file.js";
 import { Queue } from "./queue.js";
-import { getGitFolder } from "./util/gitcommand.js";
-
-type Files =
-	| undefined
-	| {
-			file: File | undefined;
-			store: Promise<Blame | undefined>;
-			gitRoot: string;
-	  };
+import { getGitFolder } from "./util/git-command.js";
 
 export class Blamer {
-	private readonly files = new Map<string, Promise<Files>>();
+	private readonly metadata = new WeakMap<
+		Promise<Blame | undefined>,
+		| {
+				file: File;
+				gitRoot: string;
+		  }
+		| undefined
+	>();
+	private readonly files = new Map<string, Promise<Blame | undefined>>();
 	private readonly fsWatchers = new Map<string, FSWatcher>();
 	private readonly blameQueue = new Queue<Blame | undefined>(
 		getProperty("parallelBlames"),
@@ -28,43 +28,73 @@ export class Blamer {
 	public constructor() {
 		this.configChange = workspace.onDidChangeConfiguration((e) => {
 			if (e.affectsConfiguration("gitblame")) {
-				this.blameQueue.updateParalell(getProperty("parallelBlames"));
+				this.blameQueue.updateParallel(getProperty("parallelBlames"));
 			}
 		});
 	}
 
-	public async file(fileName: string): Promise<Blame | undefined> {
-		return this.get(fileName);
+	public async prepareFile(fileName: string): Promise<void> {
+		if (this.files.has(fileName)) {
+			return;
+		}
+
+		let resolve: (blame: Promise<Blame | undefined>) => void = () => {};
+		this.files.set(
+			fileName,
+			new Promise<Blame | undefined>((res) => {
+				resolve = res;
+			}),
+		);
+
+		const { file, gitRoot } = await this.create(fileName);
+
+		if (file === undefined) {
+			resolve(Promise.resolve(undefined));
+			return;
+		}
+
+		this.fsWatchers.set(
+			file.fileName,
+			watch(file.fileName, () => {
+				this.remove(file.fileName);
+			}),
+		);
+
+		const blame = this.blameQueue.add(() => file.getBlame());
+		this.metadata.set(blame, { file, gitRoot });
+		resolve(blame);
 	}
 
 	public async getLine(
 		fileName: string,
 		lineNumber: number,
-	): Promise<LineAttatchedCommit | undefined> {
+	): Promise<LineAttachedCommit | undefined> {
+		await this.prepareFile(fileName);
+
 		const commitLineNumber = lineNumber + 1;
-		const blameInfo = await this.get(fileName);
+		const blameInfo = await this.files.get(fileName);
 
 		return blameInfo?.get(commitLineNumber);
 	}
 
-	public async removeFromRepository(gitRepositoryPath: string): Promise<void> {
+	public removeFromRepository(gitRepositoryPath: string): void {
 		for (const [fileName, file] of this.files) {
-			const gitRoot = (await file)?.gitRoot;
-			if (gitRoot === gitRepositoryPath) {
+			const metadata = this.metadata.get(file);
+			if (metadata?.gitRoot === gitRepositoryPath) {
 				this.remove(fileName);
 			}
 		}
 	}
 
-	public async remove(fileName: string): Promise<void> {
-		(await (await this.files.get(fileName))?.file)?.dispose();
-		this.fsWatchers.get(fileName)?.close();
-		this.files.delete(fileName);
-		const fsWatcher = this.fsWatchers.get(fileName);
-		if (fsWatcher) {
-			this.fsWatchers.delete(fileName);
-			fsWatcher.close();
+	public remove(fileName: string): void {
+		const blame = this.files.get(fileName);
+		if (blame) {
+			this.metadata.get(blame)?.file?.dispose();
 		}
+
+		this.files.delete(fileName);
+		this.fsWatchers.get(fileName)?.close();
+		this.fsWatchers.delete(fileName);
 	}
 
 	public dispose(): void {
@@ -74,59 +104,29 @@ export class Blamer {
 		this.configChange.dispose();
 	}
 
-	private async get(fileName: string): Promise<Blame | undefined> {
-		if (this.files.has(fileName)) {
-			return (await this.files.get(fileName))?.store;
-		}
-
-		const setup = this.create(fileName).then(({ file, gitRoot }): Files => {
-			if (file) {
-				this.fsWatchers.set(
-					fileName,
-					watch(fileName, () => {
-						this.remove(fileName);
-					}),
-				);
-				return {
-					file,
-					store: this.blameQueue.add(() => file.getBlame()),
-					gitRoot,
-				};
-			}
-
-			return {
-				file,
-				store: Promise.resolve(undefined),
-				gitRoot,
-			};
-		});
-
-		this.files.set(fileName, setup);
-
-		return (await setup)?.store;
-	}
-
 	private async create(
 		fileName: string,
-	): Promise<{ gitRoot: string; file: File | undefined }> {
+	): Promise<
+		{ gitRoot: string; file: File } | { gitRoot: undefined; file: undefined }
+	> {
 		try {
 			await promises.access(fileName);
 
-			const gitRoot = getGitFolder(fileName);
-			if (await gitRoot) {
+			const gitRoot = await getGitFolder(fileName);
+			if (gitRoot) {
 				return {
-					gitRoot: await gitRoot,
+					gitRoot: gitRoot,
 					file: new File(fileName),
 				};
 			}
 		} catch {
 			// NOOP
 		}
 
-		Logger.info(`Will not blame '${fileName}'. Outside the current workspace.`);
+		Logger.info(`Will not blame '${fileName}'. Not in a git repository.`);
 
 		return {
-			gitRoot: "",
+			gitRoot: undefined,
 			file: undefined,
 		};
 	}