{"id":20270274,"url":"https://github.com/opral/inlang-sherlock","last_synced_at":"2025-03-03T23:12:03.768Z","repository":{"id":227305953,"uuid":"771009007","full_name":"opral/inlang-sherlock","owner":"opral","description":"Issue tracker for Sherlock","archived":false,"fork":false,"pushed_at":"2024-03-12T16:39:29.000Z","size":14,"stargazers_count":3,"open_issues_count":26,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T05:49:26.298Z","etag":null,"topics":["i18n","inlang","l10n","localization","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=inlang.vs-code-extension","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-12T14:28:28.000Z","updated_at":"2024-12-07T16:08:54.000Z","dependencies_parsed_at":"2024-03-12T17:14:02.179Z","dependency_job_id":null,"html_url":"https://github.com/opral/inlang-sherlock","commit_stats":null,"previous_names":["opral/inlang-sherlock"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opral%2Finlang-sherlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opral%2Finlang-sherlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opral%2Finlang-sherlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opral%2Finlang-sherlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opral","download_url":"https://codeload.github.com/opral/inlang-sherlock/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241753145,"owners_count":20014252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["i18n","inlang","l10n","localization","vscode","vscode-extension"],"created_at":"2024-11-14T12:29:33.589Z","updated_at":"2025-03-03T23:12:03.753Z","avatar_url":"https://github.com/opral.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!NOTE]\n\u003e This repository serves as an issue tracker. The readme is mirrored from, and the source code is at [monorepo/inlang/packages/sherlock](https://github.com/opral/monorepo/tree/main/inlang/packages/sherlock). Make pull requests to the monorepo.\n\n# Sherlock – i18n inspector for Visual Studio Code\n\n\u003cp\u003e\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=inlang.vs-code-extension\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/visual-studio-marketplace/v/inlang.vs-code-extension?color=1E90FF\u0026label=VS%20Code%20Marketplace\u0026logo=visual-studio-code\" alt=\"Visual Studio Marketplace Version\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=inlang.vs-code-extension\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/visual-studio-marketplace/d/inlang.vs-code-extension?color=32CD32\" alt=\"Visual Studio Marketplace Downloads\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=inlang.vs-code-extension\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/visual-studio-marketplace/i/inlang.vs-code-extension?color=3CB371\" alt=\"Visual Studio Marketplace Installs\" /\u003e\u003c/a\u003e\n\u003cbr/\u003e\n\u003ca href=\"https://github.com/opral/monorepo\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/opral/monorepo?color=9370DB\" alt=\"GitHub last commit\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/opral/inlang-sherlock/issues\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/opral/inlang-sherlock?color=20B2AA\" alt=\"GitHub issues\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/opral/monorepo\" target=\"__blank\"\u003e\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/opral/monorepo?style=social\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nVisualize, edit, and lint translated strings effortlessly using Inline Decorations \u0026 Hover Support. Extract new strings with a simple click, making localization tasks more intuitive and efficient.\n\n\u003cdiv\u003e\n\t\u003cp\u003e\n\t\t\u003cbr\u003e\n\t\t\u003ca href='https://inlang.com/c/apps' target=\"_blank\"\u003e🕹️ Other i18n Apps\u003c/a\u003e\n\t\t·\n\t\t\u003ca href='https://inlang.com/m/r7kp499g' target=\"_blank\"\u003e📄 Docs\u003c/a\u003e\n\t\t·\n\t\t\u003ca href='https://discord.gg/gdMPPWy57R' target=\"_blank\"\u003e💙 Discord\u003c/a\u003e\n\t\t·\n\t\t\u003ca href='https://twitter.com/inlangHQ' target=\"_blank\"\u003e🐦 Twitter\u003c/a\u003e\n\t\u003c/p\u003e\n\t\u003cbr /\u003e\n\u003c/div\u003e\n\n\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/sherlock-cover-small.png\"/\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n✅ Streamline the i18n translation process.\n\n✅ Visualize, edit, and lint translations.\n\n✅ Extract new translations with a simple click.\n\n\u003cbr\u003e\n\n# Quick start\n\n\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/sherlock-start.png\"/\u003e\n\nInstall the extension and click `Getting Started` in the `Sherlock Tab`.\n\n\u003e You need a git repository to use the Sherlock extension, as it leverages git functionality (the inlang ecosystem is built on git).\n\n### Manual setup\n\n#### 1. Create a `project.inlang/settings.json` in the **root** of your project\n\nYou can use the following template when using JSON files as translation files. If not, please look for other [supported resource file types](https://inlang.com/):\n\n```json\n{\n\t// official schema ensures that your project file is valid\n\t\"$schema\": \"https://inlang.com/schema/project-settings\",\n\t// the \"source\" language tag that is used in your project\n\t\"baseLocale\": \"en\",\n\t// all the language tags you want to support in your project\n\t\"locales\": [\"en\", \"de\"],\n\t\"modules\": [\"https://cdn.jsdelivr.net/npm/@inlang/plugin-json@4/dist/index.js\"], // or use another storage module: https://inlang.com/c/plugins (i18next, json, inlang message format)\n\t\"settings\": {}\n}\n```\n\n\u003e You might need another module if you are using a different resource file type. You can find all available modules [here](https://inlang.com/c/plugins).\n\n#### 2. Decide on a **syntax matcher**\n\nYou should continue with **installing a syntax matcher**. There are multiple syntax matcher available:\n\n- m function matcher: https://inlang.com/m/632iow21/plugin-inlang-mFunctionMatcher\n- t function matcher: https://inlang.com/m/698iow33/plugin-inlang-tFunctionMatcher\n- _if you are using the i18next module, everything is already built-in_\n- _if you are using next-intl, you need https://inlang.com/m/193hsyds/plugin-inlang-nextIntl_\n\n#### 3. ✨ Recommended\n\nIf you want to add lint rules to your experience, you can add them from https://inlang.com/c/lint-rules\n\n#### Requirements:\n\n- VS Code version 1.84.0 or higher.\n- Node.js version v18 or higher.\n\n---\n\n# Features\n\n## Manage Translations directly from your Code\n\nSee translations and edit them directly in your code. No more back-and-forth looking into the translation files themselves.\n\n\u003cbr\u003e\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/ide-inline.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e🔎 Inline Annotations\u003c/p\u003e\n\t\t\t\u003cp\u003eSee translations directly in your code. No more back-and-forth looking into the translation files themselves.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/ide-extract.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e✂️ Extract Messages (translations)\u003c/p\u003e\n\t\t\t\u003cp\u003eExtract new strings with a simple click, making localization tasks more intuitive and efficient. Visualize, edit, and lint translated strings effortlessly using Inline Decorations \u0026 Hover Support.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/ide-lint.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e❌ Message Linting\u003c/p\u003e\n\t\t\t\u003cp\u003eGet notified about missing translations and other issues directly in your IDE.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## Sherlock tab - Transparent \u0026 Fast\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/sherlock-monorepo.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e📦 Monorepo support\u003c/p\u003e\n\t\t\t\u003cp\u003eYou can have multiple projects in your repository. The Sherlock tab makes it easy to switch from one to another.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/sherlock-update.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e🔁 Update Translations\u003c/p\u003e\n\t\t\t\u003cp\u003eTranslations from the resource files are automatically updated when you change the source text.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv\u003e\n\t\u003cdiv class=\"flex-container\"\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cimg width=\"100%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/sherlock-errors.png\"/\u003e\n\t\t\u003c/div\u003e\n\t\t\u003cdiv class=\"flex-item\"\u003e\n\t\t\t\u003cp class=\"bold\"\u003e⚠ Transparent Errors\u003c/p\u003e\n\t\t\t\u003cp\u003eIn the tab menu, you can see project errors if the setup is broken.\u003c/p\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## Customization\n\n### Custom preview language\n\nYou can customize the preview language in the settings. This is useful if you want to see how your translations look in a specific language. This setting is also available in the bottom status bar.\n\n```json\n\"sherlock.previewLanguageTag\": \"de\"\n```\n\n### Custom extension colors\n\nYou can customize the colors for inline annotations directly through the VS Code settings JSON file. This feature allows you to set different colors for `info` and `error` states, enhancing the readability and usability of inline annotations.\n\nAdd the following properties to your VS Code `settings.json` file to customize annotation colors:\n\n```json\n\"sherlock.editorColors\": {\n\t\"info\": {\n\t\t\"foreground\": \"#color\",\n\t\t\"background\": \"rgba(number, number, number, 0.2)\", // needs transparency\n\t\t\"border\": \"#color\"\n\t},\n\t\"error\": {\n\t\t\"foreground\": \"#color\",\n\t\t\"background\": \"rgba(number, number, number, 0.2)\", // needs transparency\n\t\t\"border\": \"#color\"\n\t}\n}\n\n// or (for all extensions)\n\n\"workbench.colorCustomizations\": {\n\t\"editorError.foreground\": \"#color\",\n\t\"editorError.background\": \"#color\",\n\t\"editorError.border\": \"#color\",\n\t\"editorInfo.foreground\": \"#color\",\n\t\"editorInfo.background\": \"#color\",\n\t\"editorInfo.border\": \"#color\"\n}\n```\n\n### Disable Inline Annotations\n\nYou can disable inline annotations by setting the following property to `false` in your VS Code `settings.json` file or by using the command `Sherlock: Toggle Inline Annotations`. The default value is `true`.\n\n```json\n\"sherlock.inlineAnnotations.enabled\": false\n```\n\n### Disable Auto Human ID Generation\n\nYou can disable the automatic generation of human IDs by setting the following property to `false` in your VS Code `settings.json` file. The default value is `true`.\n\n```json\n\"sherlock.extract.autoHumanId.enabled\": false\n```\n\n\u003e [!NOTE]  \n\u003e 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.\n\n#### Troubleshooting\n\nIf you are having trouble with the **loading icon** not disappearing, this is a known issue \u0026 we are working with Visual Studio Code to fix it. In the meantime, you can right-click the Inlang icon to hide it:\n\n\u003cimg width=\"25%\" src=\"https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/packages/sherlock/assets/hide-badge.png\"/\u003e\n\n## Support: Join our Discord / Open an issue on GitHub!\n\nIf something isn't working as expected or you have a feature suggestion, please join our [Discord](https://discord.gg/CNPfhWpcAa) or [create an issue](\u003c[https](https://github.com/opral/monorepo/issues/new/choose)\u003e). We are happy to help!\n\n\u003cstyle\u003e\n.flex-container {\n\tdisplay: flex;\n\tflex-wrap: wrap;\n\talign-items: center;\n}\n.flex-item {\n\twidth: 100%;\n}\n@media (min-width: 600px) {\n\t.flex-item {\n\t\twidth: calc(50% - 16px); /* Two columns with a small gap between them */\n\t\tmargin-bottom: 0;\n\t\tpadding: 0 8px;\n\t}\n}\n.flex-item .bold {\n\tfont-weight: bold;\n\tfont-size: 20px;\n}\n\u003c/style\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopral%2Finlang-sherlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopral%2Finlang-sherlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopral%2Finlang-sherlock/lists"}