Merge pull request #107 from geriyoco/main

🚀 v1.2.0

Author: fanurs

.vscodeignore

@@ -3,7 +3,7 @@
 .vscode-test-web/**
 out/**
 node_modules/**
-src/**
+src/**/*.ts
 .gitignore
 .yarnrc
 webpack.config.js

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [1.2.0] - 2022-09-21
+### Added
+- Telemetry for feature insights. We strive to be transparent at what we collect. See [telemetry.json](telemetry.json) for all the events we collect. Following the [Microsoft Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement), we do not collect any Personally Identifiable Information (PII). Check out the open-source repository at [here](https://github.com/geriyoco/vscode-image-gallery) to inspect the code. You can always opt-out of telemetry by setting `geriyocoImageGallery.isTelemetryEnabled` to `false` in your VS Code settings. Visit [here](https://code.visualstudio.com/docs/getstarted/telemetry) to learn more about VS Code telemetry.
+
+### Fixed
+- Image sort preference was not respected when file watcher is involved, e.g. after an image is added, deleted, or modified.
+
 ## [1.0.0] - 2022-09-12
 ### Added
 - Support sorting by name, type, size, created time, and modified time
@@ -84,4 +91,4 @@
 - Gallery can be opened by right clicking folders in the Explorer sidebar
 
 ## [0.0.1] - 2022-04-10
-- Initial release
+- Initial release

README.md

@@ -1,5 +1,9 @@
 # Image Gallery
-[![.github/workflows/vsce_publish.yml](https://github.com/geriyoco/vscode-image-gallery/actions/workflows/vsce_publish.yml/badge.svg?branch=production)](https://github.com/geriyoco/vscode-image-gallery/actions/workflows/vsce_publish.yml)
+
+[![](https://github.com/geriyoco/vscode-image-gallery/actions/workflows/vsce_publish.yml/badge.svg?branch=production)](https://github.com/geriyoco/vscode-image-gallery/actions/workflows/vsce_publish.yml)
+[![](https://vsmarketplacebadge.apphb.com/version-short/geriyoco.vscode-image-gallery.svg?label=Version)](https://marketplace.visualstudio.com/items?itemName=geriyoco.vscode-image-gallery)
+[![](https://vsmarketplacebadge.apphb.com/installs-short/geriyoco.vscode-image-gallery.svg?label=Installs)](https://marketplace.visualstudio.com/items?itemName=geriyoco.vscode-image-gallery)
+[![](https://vsmarketplacebadge.apphb.com/rating-short/geriyoco.vscode-image-gallery.svg?label=Rating)](https://marketplace.visualstudio.com/items?itemName=GeriYoco.vscode-image-gallery&ssr=false#review-details)
 
 A light-weighted extension that brings you the best image browsing experience in VS Code, especially for remote / cloud development.
 
@@ -8,7 +12,7 @@ A light-weighted extension that brings you the best image browsing experience in
 - **Gallery**: Collapsible grid view of all images in the selected folder, including its sub-folders
 - **Performance**: Lazy loading of images (tested on 10k images with a start-up time of 1.5s)
 - **Refresh**: Automatically update view as images are modified, added, or deleted
-- **Light**: Extension size less than 500 kB, installation time is typically negligible
+- **Light**: Extension size less than 1 MB, installation time is typically negligible
 
 ## Usage
 ![demo](docs/demo-v1.0.0.gif)

media/arrow-down.svg renamed to assets/arrow-down.svg

@@ -2,7 +2,7 @@
 	"name": "vscode-image-gallery",
 	"displayName": "Image Gallery",
 	"description": "Improve image browsing experience, especially for remote development.",
-	"version": "1.0.0",
+	"version": "1.2.0",
 	"publisher": "GeriYoco",
 	"repository": {
 		"type": "git",
@@ -17,9 +17,9 @@
 		"vscode": "^1.65.0"
 	},
 	"categories": [
+		"Visualization",
 		"Data Science",
-		"Machine Learning",
-		"Visualization"
+		"Machine Learning"
 	],
 	"keywords": [
 		"image",
@@ -29,10 +29,9 @@
 		"visualization"
 	],
 	"activationEvents": [
-		"onCommand:vscodeImageGallery.openGallery",
+		"onCommand:gryc.openGallery",
 		"onWebviewPanel:gryc.gallery",
-		"onWebviewPanel:gryc.viewer",
-		"onCustomEditor:gryc.editor"
+		"onCustomEditor:gryc.viewer"
 	],
 	"main": "./dist/extension.js",
 	"contributes": {
@@ -68,12 +67,19 @@
 					"type": "string",
 					"default": null,
 					"markdownDescription": "Variant collations for certain locales. Possible values include:\n- \"`compat`\" - Arabic\n- \"`dict`\" - Sinhala\n- \"`emoji`\" - root\n- \"`eor`\" - root\n- \"`phonebk`\" - German\n- \"`phonetic`\" - Lingala\n- \"`pinyin`\" - Chinese\n- \"`reformed`\" - Swedish\n- \"`stroke`\" - Chinese\n- \"`trad`\"\n- \"`zhuyin`\" - Chinese"
+				},
+
+				"telemetry.geriyocoImageGallery.isTelemetryEnabled": {
+					"type": "boolean",
+					"default": true,
+					"markdownDescription": "Enable / disable telemetry of this extension. If any of the global telemetry settings, including `telemetryLevel`, `isTelemetryEnabled`, `onDidChangeTelemetryEnabled`, rejects telemetry, this setting will be treated as `false`, i.e. this extension will not send any telemetry."
 				}
 			}
 		},
 		"customEditors": [
 			{
-				"viewType": "gryc.editor",
+				"displayName": "Viewer (GeriYoco Image Gallery)",
+				"viewType": "gryc.viewer",
 				"priority": "default",
 				"selector": [
 					{
@@ -84,15 +90,15 @@
 		],
 		"commands": [
 			{
-				"command": "vscodeImageGallery.openGallery",
+				"command": "gryc.openGallery",
 				"title": "Open Image Gallery (GeriYoco) 🖼️",
 				"category": "Image Gallery"
 			}
 		],
 		"menus": {
 			"explorer/context": [
 				{
-					"command": "vscodeImageGallery.openGallery",
+					"command": "gryc.openGallery",
 					"group": "2_grycImageGallery@1",
 					"when": "explorerResourceIsFolder && !virtualWorkspace"
 				}
@@ -122,7 +128,6 @@
 		"@typescript-eslint/parser": "^5.16.0",
 		"@vscode/test-electron": "^2.1.3",
 		"@vscode/test-web": "^0.0.24",
-		"@vscode/codicons": "^0.0.31",
 		"eslint": "^8.11.0",
 		"glob": "^7.2.0",
 		"mocha": "^9.2.2",
@@ -133,6 +138,7 @@
 		"webpack-cli": "^4.9.2"
 	},
 	"dependencies": {
+		"@vscode/extension-telemetry": "^0.6.2",
 		"panzoom": "^9.4.2"
 	}
 }

media/arrow-up.svg renamed to assets/arrow-up.svg

@@ -0,0 +1,21 @@
+declare module 'custom_typings' {
+    import * as vscode from 'vscode';
+
+    export type TImage = {
+        id: string, // hash256(imageUri.path), e.g. hash256("/c:/Users/image.jpg")
+        uri: vscode.Uri,
+        ext: string, // file extension in upper case, e.g. "JPG"
+        size: number,
+        mtime: number,
+        ctime: number,
+        status: "" | "refresh",
+    };
+
+    export type TFolder = {
+        id: string, // hash256(folderUri.path), e.g. hash256("/c:/Users")
+        path: string, // folderUri.path, e.g. "/c:/Users"
+        images: {
+            [imageId: string]: TImage,
+        },
+    };
+}

media/chevron-down.svg renamed to assets/chevron-down.svg

@@ -1,44 +1,16 @@
 import * as vscode from 'vscode';
-import * as gallery from './gallery';
-import * as viewer from './viewer';
+import * as gallery from './gallery/gallery';
+import * as viewer from './viewer/viewer';
+import * as telemetry from './telemetry';
 
 export function activate(context: vscode.ExtensionContext) {
-	console.log('Welcome! VS Code extension "GeriYoco: Image Gallery" is now active.');
-
-	const viewerEditor = new viewer.ViewerCustomEditor(context);
-	const viewerPanel = vscode.window.registerCustomEditorProvider(
-		viewer.ViewerCustomEditor.viewType,
-		viewerEditor,
-		{
-			supportsMultipleEditorsPerDocument: true,
-			webviewOptions: {
-				retainContextWhenHidden: true,
-			}
-		},
-	);
-	context.subscriptions.push(viewerPanel);
-
-
-	const disposableGallery = vscode.commands.registerCommand(
-		'vscodeImageGallery.openGallery',
-		async (galleryFolder?: vscode.Uri) => {
-			const panel = await gallery.createPanel(context, galleryFolder);
-			panel.webview.onDidReceiveMessage(
-				message => gallery.messageListener(message, context, panel.webview),
-				undefined,
-				context.subscriptions
-			);
-
-			const fileWatcher = gallery.createFileWatcher(context, panel.webview, galleryFolder);
-			context.subscriptions.push(fileWatcher);
-			panel.onDidDispose(
-				() => fileWatcher.dispose(),
-				undefined,
-				context.subscriptions
-			);
-		}
-	);
-	context.subscriptions.push(disposableGallery);
+	telemetry.activate(context);
+	gallery.activate(context);
+	viewer.activate(context);
 }
 
-export function deactivate() { }
+export function deactivate() {
+	gallery.deactivate();
+	viewer.deactivate();
+	telemetry.deactivate();
+}