diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml new file mode 100644 index 000000000..2c59fec6c --- /dev/null +++ b/.github/linters/.markdown-lint.yml @@ -0,0 +1,40 @@ +--- +########################### +########################### +## Markdown Linter rules ## +########################### +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint +# +# Note: +# To comment out a single error: +# +# any violations you want +# +# +# To run the linter locally: +# 1. install the npm package: +# `npm install -g markdownlint-cli` +# 2. Then run it in the root of the repo with +# `markdownlint -c .github\linters\.markdown-lint.yml ./*.md` + +############### +# Rules by id # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: + line_length: 400 # Line length 80 is far to short +MD026: + punctuation: ".,;:!。，；:" # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 3d17a44f2..bddaefe5c 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -46,5 +46,6 @@ jobs: env: VALIDATE_ALL_CODEBASE: false DEFAULT_BRANCH: master + MARKDOWN_CONFIG_FILE: .markdown-lint.yml GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} VALIDATE_EDITORCONFIG: false diff --git a/README.md b/README.md index 6b00d670f..f61708972 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,13 @@ This repository contains the source code for: * The Windows console host (`conhost.exe`) * Components shared between the two projects * [ColorTool](https://github.com/Microsoft/Terminal/tree/master/src/tools/ColorTool) -* [Sample projects](https://github.com/Microsoft/Terminal/tree/master/samples) that show how to consume the Windows Console APIs +* [Sample projects](https://github.com/Microsoft/Terminal/tree/master/samples) + that show how to consume the Windows Console APIs Related repositories include: -* [Windows Terminal Documentation](https://docs.microsoft.com/windows/terminal) ([Repo: Contribute to the docs](https://github.com/MicrosoftDocs/terminal)) +* [Windows Terminal Documentation](https://docs.microsoft.com/windows/terminal) + ([Repo: Contribute to the docs](https://github.com/MicrosoftDocs/terminal)) * [Console API Documentation](https://github.com/MicrosoftDocs/Console-Docs) * [Cascadia Code Font](https://github.com/Microsoft/Cascadia-Code) @@ -21,7 +23,9 @@ Related repositories include: ### Microsoft Store [Recommended] -Install the [Windows Terminal from the Microsoft Store][store-install-link]. This allows you to always be on the latest version when we release new builds with automatic upgrades. +Install the [Windows Terminal from the Microsoft Store][store-install-link]. +This allows you to always be on the latest version when we release new builds +with automatic upgrades. This is our preferred method. @@ -29,16 +33,21 @@ This is our preferred method. #### Via GitHub -For users who are unable to install Terminal from the Microsoft Store, Terminal builds can be manually downloaded from this repository's [Releases page](https://github.com/microsoft/terminal/releases). +For users who are unable to install Terminal from the Microsoft Store, Terminal +builds can be manually downloaded from this repository's [Releases +page](https://github.com/microsoft/terminal/releases). > 🔴 Note: If you install Terminal manually: > -> * Be sure to install the [Desktop Bridge VC++ v14 Redistributable Package](https://www.microsoft.com/en-us/download/details.aspx?id=53175) otherwise Terminal may not install and/or run and may crash at startup -> * Terminal will not auto-update when new builds are released so you will need to regularly install the latest Terminal release to receive all the latest fixes and improvements! +> * Terminal will not auto-update when new builds are released so you will need +> to regularly install the latest Terminal release to receive all the latest +> fixes and improvements! #### Via Windows Package Manager CLI (aka winget) -[winget](https://github.com/microsoft/winget-cli) users can download and install the latest Terminal release by installing the `Microsoft.WindowsTerminal` package: +[winget](https://github.com/microsoft/winget-cli) users can download and install +the latest Terminal release by installing the `Microsoft.WindowsTerminal` +package: ```powershell winget install --id=Microsoft.WindowsTerminal -e @@ -46,7 +55,8 @@ winget install --id=Microsoft.WindowsTerminal -e #### Via Chocolatey (unofficial) -[Chocolatey](https://chocolatey.org) users can download and install the latest Terminal release by installing the `microsoft-windows-terminal` package: +[Chocolatey](https://chocolatey.org) users can download and install the latest +Terminal release by installing the `microsoft-windows-terminal` package: ```powershell choco install microsoft-windows-terminal @@ -58,11 +68,15 @@ To upgrade Windows Terminal using Chocolatey, run the following: choco upgrade microsoft-windows-terminal ``` -If you have any issues when installing/upgrading the package please go to the [Windows Terminal package page](https://chocolatey.org/packages/microsoft-windows-terminal) and follow the [Chocolatey triage process](https://chocolatey.org/docs/package-triage-process) +If you have any issues when installing/upgrading the package please go to the +[Windows Terminal package +page](https://chocolatey.org/packages/microsoft-windows-terminal) and follow the +[Chocolatey triage process](https://chocolatey.org/docs/package-triage-process) #### Via Scoop (unofficial) -[Scoop](https://scoop.sh) users can download and install the latest Terminal release by installing the `windows-terminal` package: +[Scoop](https://scoop.sh) users can download and install the latest Terminal +release by installing the `windows-terminal` package: ```powershell scoop install windows-terminal @@ -74,70 +88,123 @@ To update Windows Terminal using Scoop, run the following: scoop update windows-terminal ``` -If you have any issues when installing/updating the package, please search for or report the same on the [issues page](https://github.com/lukesampson/scoop-extras/issues) of Scoop Extras bucket repository. +If you have any issues when installing/updating the package, please search for +or report the same on the [issues +page](https://github.com/lukesampson/scoop-extras/issues) of Scoop Extras bucket +repository. --- ## Windows Terminal 2.0 Roadmap -The plan for delivering Windows Terminal 2.0 [is described here](/doc/terminal-v2-roadmap.md) and will be updated as the project proceeds. +The plan for delivering Windows Terminal 2.0 [is described +here](/doc/terminal-v2-roadmap.md) and will be updated as the project proceeds. ## Project Build Status Project|Build Status ---|--- -Terminal|[![Build Status](https://dev.azure.com/ms/Terminal/_apis/build/status/Terminal%20CI?branchName=master)](https://dev.azure.com/ms/Terminal/_build?definitionId=136) -ColorTool|![](https://microsoft.visualstudio.com/_apis/public/build/definitions/c93e867a-8815-43c1-92c4-e7dd5404f1e1/17023/badge) +Terminal|[![Terminal Build Status](https://dev.azure.com/ms/Terminal/_apis/build/status/Terminal%20CI?branchName=master)](https://dev.azure.com/ms/Terminal/_build?definitionId=136) +ColorTool|![Colortool Build Status](https://microsoft.visualstudio.com/_apis/public/build/definitions/c93e867a-8815-43c1-92c4-e7dd5404f1e1/17023/badge) --- ## Terminal & Console Overview -Please take a few minutes to review the overview below before diving into the code: +Please take a few minutes to review the overview below before diving into the +code: ### Windows Terminal -Windows Terminal is a new, modern, feature-rich, productive terminal application for command-line users. It includes many of the features most frequently requested by the Windows command-line community including support for tabs, rich text, globalization, configurability, theming & styling, and more. +Windows Terminal is a new, modern, feature-rich, productive terminal application +for command-line users. It includes many of the features most frequently +requested by the Windows command-line community including support for tabs, rich +text, globalization, configurability, theming & styling, and more. -The Terminal will also need to meet our goals and measures to ensure it remains fast and efficient, and doesn't consume vast amounts of memory or power. +The Terminal will also need to meet our goals and measures to ensure it remains +fast and efficient, and doesn't consume vast amounts of memory or power. ### The Windows Console Host -The Windows Console host, `conhost.exe`, is Windows' original command-line user experience. It also hosts Windows' command-line infrastructure and the Windows Console API server, input engine, rendering engine, user preferences, etc. The console host code in this repository is the actual source from which the `conhost.exe` in Windows itself is built. +The Windows Console host, `conhost.exe`, is Windows' original command-line user +experience. It also hosts Windows' command-line infrastructure and the Windows +Console API server, input engine, rendering engine, user preferences, etc. The +console host code in this repository is the actual source from which the +`conhost.exe` in Windows itself is built. -Since taking ownership of the Windows command-line in 2014, the team added several new features to the Console, including background transparency, line-based selection, support for [ANSI / Virtual Terminal sequences](https://en.wikipedia.org/wiki/ANSI_escape_code), [24-bit color](https://devblogs.microsoft.com/commandline/24-bit-color-in-the-windows-console/), a [Pseudoconsole ("ConPTY")](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/), and more. +Since taking ownership of the Windows command-line in 2014, the team added +several new features to the Console, including background transparency, +line-based selection, support for [ANSI / Virtual Terminal +sequences](https://en.wikipedia.org/wiki/ANSI_escape_code), [24-bit +color](https://devblogs.microsoft.com/commandline/24-bit-color-in-the-windows-console/), +a [Pseudoconsole +("ConPTY")](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/), +and more. -However, because Windows Console's primary goal is to maintain backward compatibility, we have been unable to add many of the features the community (and the team) have been wanting for the last several years including tabs, unicode text, and emoji. +However, because Windows Console's primary goal is to maintain backward +compatibility, we have been unable to add many of the features the community +(and the team) have been wanting for the last several years including tabs, +unicode text, and emoji. These limitations led us to create the new Windows Terminal. -> You can read more about the evolution of the command-line in general, and the Windows command-line specifically in [this accompanying series of blog posts](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/) on the Command-Line team's blog. +> You can read more about the evolution of the command-line in general, and the +> Windows command-line specifically in [this accompanying series of blog +> posts](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/) +> on the Command-Line team's blog. ### Shared Components -While overhauling Windows Console, we modernized its codebase considerably, cleanly separating logical entities into modules and classes, introduced some key extensibility points, replaced several old, home-grown collections and containers with safer, more efficient [STL containers](https://docs.microsoft.com/en-us/cpp/standard-library/stl-containers?view=vs-2019), and made the code simpler and safer by using Microsoft's [Windows Implementation Libraries - WIL](https://github.com/Microsoft/wil). +While overhauling Windows Console, we modernized its codebase considerably, +cleanly separating logical entities into modules and classes, introduced some +key extensibility points, replaced several old, home-grown collections and +containers with safer, more efficient [STL +containers](https://docs.microsoft.com/en-us/cpp/standard-library/stl-containers?view=vs-2019), +and made the code simpler and safer by using Microsoft's [Windows Implementation +Libraries - WIL](https://github.com/Microsoft/wil). -This overhaul resulted in several of Console's key components being available for re-use in any terminal implementation on Windows. These components include a new DirectWrite-based text layout and rendering engine, a text buffer capable of storing both UTF-16 and UTF-8, a VT parser/emitter, and more. +This overhaul resulted in several of Console's key components being available +for re-use in any terminal implementation on Windows. These components include a +new DirectWrite-based text layout and rendering engine, a text buffer capable of +storing both UTF-16 and UTF-8, a VT parser/emitter, and more. ### Creating the new Windows Terminal -When we started planning the new Windows Terminal application, we explored and evaluated several approaches and technology stacks. We ultimately decided that our goals would be best met by continuing our investment in our C++ codebase, which would allow us to reuse several of the aforementioned modernized components in both the existing Console and the new Terminal. Further, we realized that this would allow us to build much of the Terminal's core itself as a reusable UI control that others can incorporate into their own applications. +When we started planning the new Windows Terminal application, we explored and +evaluated several approaches and technology stacks. We ultimately decided that +our goals would be best met by continuing our investment in our C++ codebase, +which would allow us to reuse several of the aforementioned modernized +components in both the existing Console and the new Terminal. Further, we +realized that this would allow us to build much of the Terminal's core itself as +a reusable UI control that others can incorporate into their own applications. -The result of this work is contained within this repo and delivered as the Windows Terminal application you can download from the Microsoft Store, or [directly from this repo's releases](https://github.com/microsoft/terminal/releases). +The result of this work is contained within this repo and delivered as the +Windows Terminal application you can download from the Microsoft Store, or +[directly from this repo's +releases](https://github.com/microsoft/terminal/releases). --- ## Resources -For more information about Windows Terminal, you may find some of these resources useful and interesting: +For more information about Windows Terminal, you may find some of these +resources useful and interesting: * [Command-Line Blog](https://devblogs.microsoft.com/commandline) -* [Command-Line Backgrounder Blog Series](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/) -* Windows Terminal Launch: [Terminal "Sizzle Video"](https://www.youtube.com/watch?v=8gw0rXPMMPE&list=PLEHMQNlPj-Jzh9DkNpqipDGCZZuOwrQwR&index=2&t=0s) -* Windows Terminal Launch: [Build 2019 Session](https://www.youtube.com/watch?v=KMudkRcwjCw) -* Run As Radio: [Show 645 - Windows Terminal with Richard Turner](http://www.runasradio.com/Shows/Show/645) -* Azure Devops Podcast: [Episode 54 - Kayla Cinnamon and Rich Turner on DevOps on the Windows Terminal](http://azuredevopspodcast.clear-measure.com/kayla-cinnamon-and-rich-turner-on-devops-on-the-windows-terminal-team-episode-54) -* Microsoft Ignite 2019 Session: [The Modern Windows Command Line: Windows Terminal - BRK3321](https://myignite.techcommunity.microsoft.com/sessions/81329?source=sessions) +* [Command-Line Backgrounder Blog + Series](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/) +* Windows Terminal Launch: [Terminal "Sizzle + Video"](https://www.youtube.com/watch?v=8gw0rXPMMPE&list=PLEHMQNlPj-Jzh9DkNpqipDGCZZuOwrQwR&index=2&t=0s) +* Windows Terminal Launch: [Build 2019 + Session](https://www.youtube.com/watch?v=KMudkRcwjCw) +* Run As Radio: [Show 645 - Windows Terminal with Richard + Turner](http://www.runasradio.com/Shows/Show/645) +* Azure Devops Podcast: [Episode 54 - Kayla Cinnamon and Rich Turner on DevOps + on the Windows + Terminal](http://azuredevopspodcast.clear-measure.com/kayla-cinnamon-and-rich-turner-on-devops-on-the-windows-terminal-team-episode-54) +* Microsoft Ignite 2019 Session: [The Modern Windows Command Line: Windows + Terminal - + BRK3321](https://myignite.techcommunity.microsoft.com/sessions/81329?source=sessions) --- @@ -147,35 +214,50 @@ For more information about Windows Terminal, you may find some of these resource Cause: You're launching the incorrect solution in Visual Studio. -Solution: Make sure you're building & deploying the `CascadiaPackage` project in Visual Studio. +Solution: Make sure you're building & deploying the `CascadiaPackage` project in +Visual Studio. -> ⚠ Note: `OpenConsole.exe` is just a locally-built `conhost.exe`, the classic Windows Console that hosts Windows' command-line infrastructure. OpenConsole is used by Windows Terminal to connect to and communicate with command-line applications (via [ConPty](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/)). +> ⚠ Note: `OpenConsole.exe` is just a locally-built `conhost.exe`, the classic +> Windows Console that hosts Windows' command-line infrastructure. OpenConsole +> is used by Windows Terminal to connect to and communicate with command-line +> applications (via +> [ConPty](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/)). --- ## Documentation -All project documentation is located at aka.ms/terminal-docs. If you would like to contribute to the documentation, please submit a pull request on the [Windows Terminal Documentation repo](https://github.com/MicrosoftDocs/terminal). +All project documentation is located at aka.ms/terminal-docs. If you would like +to contribute to the documentation, please submit a pull request on the [Windows +Terminal Documentation repo](https://github.com/MicrosoftDocs/terminal). --- ## Contributing -We are excited to work alongside you, our amazing community, to build and enhance Windows Terminal\! +We are excited to work alongside you, our amazing community, to build and +enhance Windows Terminal\! -***BEFORE you start work on a feature/fix***, please read & follow our [Contributor's Guide](https://github.com/microsoft/terminal/blob/master/CONTRIBUTING.md) to help avoid any wasted or duplicate effort. +***BEFORE you start work on a feature/fix***, please read & follow our +[Contributor's +Guide](https://github.com/microsoft/terminal/blob/master/CONTRIBUTING.md) to +help avoid any wasted or duplicate effort. ## Communicating with the Team The easiest way to communicate with the team is via GitHub issues. -Please file new issues, feature requests and suggestions, but **DO search for similar open/closed pre-existing issues before creating a new issue.** +Please file new issues, feature requests and suggestions, but **DO search for +similar open/closed pre-existing issues before creating a new issue.** -If you would like to ask a question that you feel doesn't warrant an issue (yet), please reach out to us via Twitter: +If you would like to ask a question that you feel doesn't warrant an issue +(yet), please reach out to us via Twitter: -* Kayla Cinnamon, Program Manager: [@cinnamon\_msft](https://twitter.com/cinnamon_msft) +* Kayla Cinnamon, Program Manager: + [@cinnamon\_msft](https://twitter.com/cinnamon_msft) * Dustin Howett, Engineering Lead: [@dhowett](https://twitter.com/DHowett) -* Michael Niksa, Senior Developer: [@michaelniksa](https://twitter.com/MichaelNiksa) +* Michael Niksa, Senior Developer: + [@michaelniksa](https://twitter.com/MichaelNiksa) * Mike Griese, Developer: [@zadjii](https://twitter.com/zadjii) * Carlos Zamora, Developer: [@cazamor_msft](https://twitter.com/cazamor_msft) * Leon Liang, Developer: [@leonmsft](https://twitter.com/leonmsft) @@ -185,11 +267,19 @@ If you would like to ask a question that you feel doesn't warrant an issue (yet) ## Prerequisites -* You must be running Windows 1903 (build >= 10.0.18362.0) or later to run Windows Terminal -* You must [enable Developer Mode in the Windows Settings app](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development) to locally install and run Windows Terminal -* You must have the [Windows 10 1903 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) installed -* You must have at least [VS 2019](https://visualstudio.microsoft.com/downloads/) installed -* You must install the following Workloads via the VS Installer. Note: Opening the solution in VS 2019 will [prompt you to install missing components automatically](https://devblogs.microsoft.com/setup/configure-visual-studio-across-your-organization-with-vsconfig/): +* You must be running Windows 1903 (build >= 10.0.18362.0) or later to run + Windows Terminal +* You must [enable Developer Mode in the Windows Settings + app](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development) + to locally install and run Windows Terminal +* You must have the [Windows 10 1903 + SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) + installed +* You must have at least [VS + 2019](https://visualstudio.microsoft.com/downloads/) installed +* You must install the following Workloads via the VS Installer. Note: Opening + the solution in VS 2019 will [prompt you to install missing components + automatically](https://devblogs.microsoft.com/setup/configure-visual-studio-across-your-organization-with-vsconfig/): * Desktop Development with C++ * Universal Windows Platform Development * **The following Individual Components** @@ -197,13 +287,17 @@ If you would like to ask a question that you feel doesn't warrant an issue (yet) ## Building the Code -This repository uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for some of its dependencies. To make sure submodules are restored or updated, be sure to run the following prior to building: +This repository uses [git +submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for some of its +dependencies. To make sure submodules are restored or updated, be sure to run +the following prior to building: ```shell git submodule update --init --recursive ``` -OpenConsole.sln may be built from within Visual Studio or from the command-line using a set of convenience scripts & tools in the **/tools** directory: +OpenConsole.sln may be built from within Visual Studio or from the command-line +using a set of convenience scripts & tools in the **/tools** directory: ### Building in PowerShell @@ -222,19 +316,28 @@ bcz ## Running & Debugging -To debug the Windows Terminal in VS, right click on `CascadiaPackage` (in the Solution Explorer) and go to properties. In the Debug menu, change "Application process" and "Background task process" to "Native Only". +To debug the Windows Terminal in VS, right click on `CascadiaPackage` (in the +Solution Explorer) and go to properties. In the Debug menu, change "Application +process" and "Background task process" to "Native Only". -You should then be able to build & debug the Terminal project by hitting F5. +You should then be able to build & debug the Terminal project by hitting +F5. -> 👉 You will _not_ be able to launch the Terminal directly by running the WindowsTerminal.exe. For more details on why, see [#926](https://github.com/microsoft/terminal/issues/926), [#4043](https://github.com/microsoft/terminal/issues/4043) +> 👉 You will _not_ be able to launch the Terminal directly by running the +> WindowsTerminal.exe. For more details on why, see +> [#926](https://github.com/microsoft/terminal/issues/926), +> [#4043](https://github.com/microsoft/terminal/issues/4043) ### Coding Guidance Please review these brief docs below about our coding practices. -> 👉 If you find something missing from these docs, feel free to contribute to any of our documentation files anywhere in the repository (or write some new ones!) +> 👉 If you find something missing from these docs, feel free to contribute to +> any of our documentation files anywhere in the repository (or write some new +> ones!) -This is a work in progress as we learn what we'll need to provide people in order to be effective contributors to our project. +This is a work in progress as we learn what we'll need to provide people in +order to be effective contributors to our project. * [Coding Style](https://github.com/Microsoft/Terminal/blob/master/doc/STYLE.md) * [Code Organization](https://github.com/Microsoft/Terminal/blob/master/doc/ORGANIZATION.md) @@ -243,10 +346,12 @@ This is a work in progress as we learn what we'll need to provide people in orde --- -# Code of Conduct +## Code of Conduct -This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code]. -For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments. +This project has adopted the [Microsoft Open Source Code of +Conduct][conduct-code]. For more information see the [Code of Conduct +FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any +additional questions or comments. [conduct-code]: https://opensource.microsoft.com/codeofconduct/ [conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/