{"id":16431042,"url":"https://github.com/estruyf/vscode-microsoft-writingstyleguide","last_synced_at":"2025-08-11T16:13:01.325Z","repository":{"id":48883158,"uuid":"379001979","full_name":"estruyf/vscode-microsoft-writingstyleguide","owner":"estruyf","description":"Extension that makes your writing better by taking the recommendations from the Microsoft Writing Style Guide into account.","archived":false,"fork":false,"pushed_at":"2022-03-16T08:17:59.000Z","size":1068,"stargazers_count":4,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-10T18:22:07.333Z","etag":null,"topics":["code","vscode","vscode-extension","vscode-plugin","writing"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-microsoft-writingstyleguide","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/estruyf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["estruyf"],"custom":["https://www.buymeacoffee.com/zMeFRy9"]}},"created_at":"2021-06-21T16:53:26.000Z","updated_at":"2024-11-22T22:52:12.000Z","dependencies_parsed_at":"2022-09-16T04:01:19.290Z","dependency_job_id":null,"html_url":"https://github.com/estruyf/vscode-microsoft-writingstyleguide","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/estruyf/vscode-microsoft-writingstyleguide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fvscode-microsoft-writingstyleguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fvscode-microsoft-writingstyleguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fvscode-microsoft-writingstyleguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fvscode-microsoft-writingstyleguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/estruyf","download_url":"https://codeload.github.com/estruyf/vscode-microsoft-writingstyleguide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fvscode-microsoft-writingstyleguide/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269917414,"owners_count":24496087,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["code","vscode","vscode-extension","vscode-plugin","writing"],"created_at":"2024-10-11T08:29:01.962Z","updated_at":"2025-08-11T16:13:01.290Z","avatar_url":"https://github.com/estruyf.png","language":"TypeScript","funding_links":["https://github.com/sponsors/estruyf","https://www.buymeacoffee.com/zMeFRy9"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-microsoft-writingstyleguide\"\u003e\n    \u003cimg alt=\"Writing Style Guide\" src=\"./assets/writing-style-guide.png\" height=\"200\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eWriting Style Guide\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-microsoft-writingstyleguide\" title=\"Check it out on the Visual Studio Marketplace\"\u003e\n    \u003cimg src=\"https://vsmarketplacebadge.apphb.com/version/eliostruyf.vscode-microsoft-writingstyleguide.svg\" alt=\"Visual Studio Marketplace\" style=\"display: inline-block\" /\u003e\n  \u003c/a\u003e\n\n  \u003cimg src=\"https://vsmarketplacebadge.apphb.com/installs/eliostruyf.vscode-microsoft-writingstyleguide.svg\" alt=\"Number of installs\"  style=\"display: inline-block;margin-left:10px\" /\u003e\n  \n  \u003cimg src=\"https://vsmarketplacebadge.apphb.com/rating/eliostruyf.vscode-microsoft-writingstyleguide.svg\" alt=\"Ratings\" style=\"display: inline-block;margin-left:10px\" /\u003e\n\n  \u003ca href=\"https://www.buymeacoffee.com/zMeFRy9\" title=\"Buy me a coffee\" style=\"margin-left:10px\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Buy%20me%20a%20coffee-€%203-blue?logo=buy-me-a-coffee\u0026style=flat\" alt=\"Buy me a coffee\" style=\"display: inline-block\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nThis is a VSCode extension based on the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/), which helps you to get Microsoft's voice and style when you write about tech. Among other considerations about accessibility guidelines, bias-free communication and in-detail information on grammar, text formatting and capitalization, the guide points out an A-Z word list and term collection, which works as a refernce that can be looked up, when in doubt. \n\nWhen authoring a document in Visual Studio Code, you can now use this extension, which will hint you which word or terminology can be improved to match the recommendations from the Writung Style Guide. This means, that you do not need to have an external reference as an author, but can stay in the flow of your work as this extension gives you contextual information right where you need it. Now there is no need anymore to keep the Writing Style Guide website open or go back and forth, switching between writing and editing a document. \n\nIf the extension detects a word listed in the **A-Z word list and term collections**, it shows blue squiggly underlines for the respecting word and displays a contextual popup, which explains the issue. It also links to respecting recommendation in the Writing Style Guide. \n\n![](./assets/guidance-tooltips.png)\n\n## What is supported\n\nIn the current version, the extension supports highlighting the words which you can find \n\n* in the **A-Z word list and term collections**\n* in [Bias-free communication](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)\n\n## Smart Features\n\nThe extension will \n\n* ignore the front matters of an `.md` file\n* ignore text in code blocks\n* ignore text in inline code blocks\n\nIn the sidepanel, you can enable which checks you like to apply: \n\n![](./assets/sidepanel-actions.png)\n\n\n## Commands\n\nCurrently the extension supports the following commands in VSCode:\n\n![](./assets/commands.png)\n\n- `Writing: Open the Microsoft Writing Style Guide website`\n- `Writing: Enable the Microsoft Writing Style Guide` \n  - Extension is enabled by default. If you want to disable it for a project, you can run the disable command.\n- `Writing: Disable the Microsoft Writing Style Guide`\n  - Allows you to disable the extension for the current project. \n\n## Work in progress\n\nThis extension is still a work in progress.\n\n\u003e Originates from an idea by [Luise Freese](https://github.com/LuiseFreese)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#\"\u003e\n      \u003cimg src=\"https://estruyf-github.azurewebsites.net/api/VisitorHit?user=estruyf\u0026repo=vscode-microsoft-writingstyleguide\u0026countColor=%23D69B37\u0026labelColor=%23162034\" /\u003e\n   \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festruyf%2Fvscode-microsoft-writingstyleguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Festruyf%2Fvscode-microsoft-writingstyleguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festruyf%2Fvscode-microsoft-writingstyleguide/lists"}