Merge pull request #3674 from GauBen/feat/sherlock-nanoid

feat(sherlock): add a nanoid generator for the key extractor

Author: samuelstroschein

.changeset/gentle-sites-act.md

@@ -0,0 +1,7 @@
+---
+"vs-code-extension": minor
+---
+
+https://github.com/opral/monorepo/pull/3674
+
+adds a new sherlock.extract.generator config key, and deprecates sherlock.extract.autoHumanId.enabled

inlang/packages/sherlock/package.json

@@ -210,8 +210,27 @@
 				"sherlock.extract": {
 					"type": "object",
 					"properties": {
+						"generator": {
+							"type": "string",
+							"description": "The generator to use for the extracted message IDs. Default is `humanId`.",
+							"anyOf": [
+								{
+									"const": "humanId",
+									"description": "A human-readable id, like `direct_legal_giraffe_empower`."
+								},
+								{
+									"const": "nanoid",
+									"description": "A short, high-entropy id, like `vOpwTYdaKl`."
+								},
+								{
+									"const": "none",
+									"description": "The field is left empty, for you to fill in."
+								}
+							]
+						},
 						"autoHumanId": {
 							"type": "object",
+							"deprecated": true,
 							"properties": {
 								"enabled": {
 									"type": "boolean",
@@ -266,6 +285,7 @@
 		"kysely": "^0.27.4",
 		"lit-html": "^3.1.2",
 		"lodash-es": "^4.17.21",
+		"nanoid": "^5.1.5",
 		"prettier": "^3.3.3",
 		"require-from-string": "^2.0.2",
 		"throttle-debounce": "^5.0.0",

inlang/packages/sherlock/src/commands/extractMessage.test.ts

@@ -6,7 +6,6 @@ import { CONFIGURATION } from "../configuration.js"
 import { getSetting } from "../utilities/settings/index.js"
 import { state } from "../utilities/state.js"
 import { upsertBundleNested } from "@inlang/sdk"
-import { capture } from "../services/telemetry/index.js"
 
 // Mocking the necessary modules
 vi.mock("../utilities/state", () => ({
@@ -60,12 +59,18 @@ vi.mock("../utilities/settings/index.js", () => ({
 }))
 
 vi.mock("@inlang/sdk", () => ({
-	humanId: vi.fn().mockReturnValue("generatedId123"),
-	createBundle: vi.fn().mockReturnValue({ id: "generatedId123", alias: "alias123" }),
-	createMessage: vi.fn().mockReturnValue({ id: "messageId123", bundleId: "generatedId123" }),
+	humanId: vi.fn().mockReturnValue("generated_human_id"),
+	createBundle: vi.fn().mockReturnValue({ id: "bundleId123", alias: "alias123" }),
+	createMessage: vi
+		.fn()
+		.mockReturnValue({ id: "messageId123", bundleId: "bundleId123bundleId123" }),
 	upsertBundleNested: vi.fn(),
 }))
 
+vi.mock("nanoid", () => ({
+	customAlphabet: vi.fn().mockReturnValue(() => "nanoidnano"),
+}))
+
 vi.mock("../utilities/messages/isQuoted", () => ({
 	isQuoted: vi.fn(),
 	stripQuotes: vi.fn(),
@@ -503,4 +508,87 @@ describe("extractMessageCommand", () => {
 		expect(CONFIGURATION.EVENTS.ON_DID_EXTRACT_MESSAGE.fire).toHaveBeenCalled()
 		expect(msg).toHaveBeenCalledWith("Message extracted.")
 	})
+
+	it("should use the right generator if configured", async () => {
+		vi.mocked(state).mockReturnValue({
+			project: {
+				plugins: {
+					get: async () => [
+						{
+							key: "plugin1",
+							meta: {
+								"app.inlang.ideExtension": {
+									extractMessageOptions: [
+										{
+											callback: vi.fn(() => ({
+												bundleId: "generatedId123",
+												messageReplacement: "Replacement Text",
+											})),
+										},
+									],
+								},
+							},
+						},
+					],
+				},
+				// @ts-expect-error
+				settings: {
+					get: async () => ({ baseLocale: "en", locales: ["en"] }),
+				},
+				db: {
+					// @ts-expect-error
+					transaction: () => ({
+						execute: vi.fn().mockResolvedValueOnce(true),
+					}),
+				},
+			},
+		})
+
+		const mockTextEditor = {
+			selection: {
+				isEmpty: false,
+				start: {
+					line: 1,
+					character: 1,
+				},
+				end: {
+					line: 1,
+					character: 20,
+				},
+			},
+			document: {
+				getText: () => "Some text",
+			},
+			edit: vi.fn(),
+		}
+
+		for (const [generator, expected] of [
+			["humanId", "generated_human_id"],
+			["nanoid", "nanoidnano"],
+			["none", ""],
+		]) {
+			vi.mocked(getSetting).mockResolvedValue(generator)
+			vi.mocked(window.showInputBox).mockResolvedValueOnce("generatedId123")
+			// @ts-expect-error
+			vi.mocked(window.showQuickPick).mockResolvedValueOnce("Replacement Text")
+
+			// @ts-expect-error
+			await extractMessageCommand.callback(mockTextEditor)
+
+			expect(window.showInputBox).toHaveBeenCalledWith(
+				expect.objectContaining({
+					value: expected,
+				})
+			)
+
+			expect(mockTextEditor.edit).toHaveBeenCalled()
+			expect(CONFIGURATION.EVENTS.ON_DID_EXTRACT_MESSAGE.fire).toHaveBeenCalled()
+			expect(msg).toHaveBeenCalledWith("Message extracted.")
+
+			vi.mocked(window.showInputBox).mockReset()
+			vi.mocked(mockTextEditor.edit).mockReset()
+			vi.mocked(CONFIGURATION.EVENTS.ON_DID_EXTRACT_MESSAGE.fire).mockReset()
+			vi.mocked(msg).mockReset()
+		}
+	})
 })

inlang/packages/sherlock/src/commands/extractMessage.ts

@@ -13,6 +13,16 @@ import {
 } from "@inlang/sdk"
 import { v4 as uuidv4 } from "uuid"
 import { saveProject } from "../main.js"
+import { customAlphabet } from "nanoid"
+
+/**
+ * Generators used to populate the message key field.
+ */
+const generators = {
+	humanId,
+	nanoid: customAlphabet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", 8),
+	none: () => "",
+}
 
 /**
  * Helps the user to extract messages from the active text editor.
@@ -63,13 +73,29 @@ export const extractMessageCommand = {
 			)
 		}
 
-		const autoHumanId = await getSetting("extract.autoHumanId.enabled").catch(() => true)
+		// Favor the modern option
+		let generator = await getSetting("extract.generator").catch(() => undefined)
+
+		// If undefined or empty, use the deprecated option
+		if (!generator) {
+			generator = (await getSetting("extract.autoHumanId.enabled").catch(() => true))
+				? "humanId"
+				: "none"
+		}
+
+		const isKnownGenerator = Object.hasOwn(generators, generator)
+		const generatedValue = isKnownGenerator
+			? generators[generator as keyof typeof generators]()
+			: ""
+		const showRandomNamesTip = generator !== "none"
+
 		const bundleId = await window.showInputBox({
 			title: "Enter the ID:",
-			value: autoHumanId ? humanId() : "",
-			prompt:
-				autoHumanId &&
-				"Tip: It's best practice to use random names for your messages. Read this [guide](https://inlang.com/documentation/concept/message#idhuman-readable) for more information.",
+			value: generatedValue,
+			// Show the random-names tip only when a random generator is active
+			prompt: showRandomNamesTip
+				? "Tip: It's best practice to use random names for your messages. Read this [guide](https://inlang.com/documentation/concept/message#idhuman-readable) for more information."
+				: undefined,
 		})
 
 		if (bundleId === undefined) {

inlang/packages/sherlock/src/utilities/settings/index.ts

@@ -13,7 +13,8 @@ const settingsProperty = [
 	"editorColors.error.foreground",
 	"editorColors.error.background",
 	"editorColors.error.border",
-	"extract.autoHumanId.enabled",
+	"extract.generator",
+	"extract.autoHumanId.enabled", // DEPRECATED, TODO: remove in the next major
 	"inlineAnnotations.enabled",
 	"appRecommendations.ninja.enabled",
 ] as const

packages/lix-plugin-md/package.json

@@ -30,7 +30,7 @@
 		"remark-stringify": "^11.0.0",
 		"remark-gfm": "^3.0.1",
 		"remark-frontmatter": "^4.0.1",
-		"unified": "11.0.3",
+		"unified": "^11.0.5",
 		"unist-util-visit": "5.0.0"
 	},
 	"devDependencies": {

packages/markdown-wc/package.json

@@ -33,12 +33,12 @@
 		"rehype-rewrite": "3.0.6",
 		"rehype-sanitize": "6.0.0",
 		"rehype-slug": "6.0.0",
-		"rehype-stringify": "10.0.0",
+		"rehype-stringify": "^10.0.1",
 		"remark-frontmatter": "^5.0.0",
 		"remark-gfm": "3.0.1",
 		"remark-parse": "10.0.2",
 		"remark-rehype": "10.1.0",
-		"unified": "11.0.3",
+		"unified": "^11.0.5",
 		"unist-util-visit": "5.0.0",
 		"yaml": "^2.1.3"
 	},