Skip to content

Commit

Permalink
Move M.T.Core's *interfaces* to a separate project
Browse files Browse the repository at this point in the history
  • Loading branch information
@DHowett
DHowett committed Feb 10, 2023
1 parent 0420bb2 commit 2eb4b28
Show file tree
Hide file tree
Showing 13 changed files with 105 additions and 66 deletions.
32 changes: 32 additions & 0 deletions OpenConsole.sln
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Interfaces", "Interfaces",
EndProject
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Microsoft.Terminal.Connection.Interfaces", "src\cascadia\ITerminalConnection\ITerminalConnection.vcxproj", "{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17}"
EndProject
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Microsoft.Terminal.Core.Interfaces", "src\cascadia\ITerminalCore\ITerminalCore.vcxproj", "{40503EDC-E3E4-46AB-BC26-D293B956CAE8}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
AuditMode|Any CPU = AuditMode|Any CPU
Expand Down Expand Up @@ -2800,6 +2802,35 @@ Global
{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17}.Release|x64.Build.0 = Release|x64
{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17}.Release|x86.ActiveCfg = Release|Win32
{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17}.Release|x86.Build.0 = Release|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|Any CPU.ActiveCfg = AuditMode|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|ARM.ActiveCfg = AuditMode|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|ARM64.ActiveCfg = AuditMode|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|ARM64.Build.0 = AuditMode|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|x64.ActiveCfg = AuditMode|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|x64.Build.0 = AuditMode|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|x86.ActiveCfg = AuditMode|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.AuditMode|x86.Build.0 = AuditMode|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|Any CPU.ActiveCfg = Debug|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|ARM.ActiveCfg = Debug|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|ARM64.ActiveCfg = Debug|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|ARM64.Build.0 = Debug|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|x64.ActiveCfg = Debug|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|x64.Build.0 = Debug|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|x86.ActiveCfg = Debug|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Debug|x86.Build.0 = Debug|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Fuzzing|Any CPU.ActiveCfg = Fuzzing|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Fuzzing|ARM.ActiveCfg = Fuzzing|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Fuzzing|ARM64.ActiveCfg = Fuzzing|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Fuzzing|x64.ActiveCfg = Fuzzing|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Fuzzing|x86.ActiveCfg = Fuzzing|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|Any CPU.ActiveCfg = Release|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|ARM.ActiveCfg = Release|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|ARM64.ActiveCfg = Release|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|ARM64.Build.0 = Release|ARM64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|x64.ActiveCfg = Release|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|x64.Build.0 = Release|x64
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|x86.ActiveCfg = Release|Win32
{40503EDC-E3E4-46AB-BC26-D293B956CAE8}.Release|x86.Build.0 = Release|Win32
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -2907,6 +2938,7 @@ Global
{613CCB57-5FA9-48EF-80D0-6B1E319E20C4} = {A10C4720-DCA4-4640-9749-67F4314F527C}
{6F4CC67D-6FC5-435E-885D-9FC3624BDF2F} = {59840756-302F-44DF-AA47-441A9D673202}
{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17} = {6F4CC67D-6FC5-435E-885D-9FC3624BDF2F}
{40503EDC-E3E4-46AB-BC26-D293B956CAE8} = {6F4CC67D-6FC5-435E-885D-9FC3624BDF2F}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {3140B1B7-C8EE-43D1-A772-D82A7061A271}
Expand Down
0 ...cascadia/TerminalCore/ICoreAppearance.idl → ...ascadia/ITerminalCore/ICoreAppearance.idl
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion src/cascadia/TerminalCore/ICoreSettings.idl → src/cascadia/ITerminalCore/ICoreSettings.idl
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import "..\ICoreAppearance.idl";
import "ICoreAppearance.idl";

namespace Microsoft.Terminal.Core
{
Expand Down
29 changes: 29 additions & 0 deletions src/cascadia/ITerminalCore/ITerminalCore.vcxproj
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup Label="Globals">
<ProjectGuid>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</ProjectGuid>
<Keyword>Win32Proj</Keyword>
<ProjectName>Microsoft.Terminal.Core.Interfaces</ProjectName>
<TargetName>Microsoft.Terminal.Core.Interfaces</TargetName>
<ConfigurationType>Utility</ConfigurationType>
<RootNamespace>Microsoft.Terminal.Core</RootNamespace>

<TerminalMidlRT>true</TerminalMidlRT>

<!-- Force our output directory -->
<OpenConsoleCppWinRTProject>true</OpenConsoleCppWinRTProject>
</PropertyGroup>

<Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
<Import Project="$(OpenConsoleDir)src\common.nugetversions.props" />
<Import Project="$(OpenConsoleDir)src\common.build.pre.props" />

<ItemGroup>
<Midl Include="ICoreSettings.idl" />
<Midl Include="ICoreAppearance.idl" />
</ItemGroup>

<!-- Careful reordering these. Some default props (contained in these files) are order sensitive. -->
<Import Project="$(OpenConsoleDir)src\common.build.post.props" />
<Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />
</Project>
7 changes: 1 addition & 6 deletions src/cascadia/TerminalApp/TerminalAppLib.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,12 +375,7 @@
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
<!-- TODO VALIDATE DELETION -->
<Reference Include="$(WindowsSDK_MetadataPathVersioned)\Windows.UI.Xaml.Hosting.HostingContract\*\*.winmd">
<WinMDFile>true</WinMDFile>
<CopyLocal>false</CopyLocal>
Expand Down
16 changes: 4 additions & 12 deletions src/cascadia/TerminalApp/dll/TerminalApp.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@
include Settings and Connection, since Control will include them for us) -->
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalConnection\TerminalConnection.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalControl\dll\TerminalControl.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalSettingsEditor\Microsoft.Terminal.Settings.Editor.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalSettingsModel\dll\Microsoft.Terminal.Settings.Model.vcxproj" />
<!-- Reference TerminalAppLib here, so we can use its TerminalApp.winmd as
Expand All @@ -80,18 +84,6 @@
</ItemGroup>


<ItemGroup>
<!-- Manually include the Terminal.Core winmd, so we know where those types
are defined. We don't want to include it as a project reference, because
that would make us link that lib into our own binary. -->
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
</ItemGroup>

<ItemDefinitionGroup>
<ClCompile>
<AdditionalIncludeDirectories>$(OpenConsoleDir)\dep\jsoncpp\json;%(AdditionalIncludeDirectories);</AdditionalIncludeDirectories>
Expand Down
9 changes: 9 additions & 0 deletions src/cascadia/TerminalControl/TerminalControlLib.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,13 @@
<ProjectReference Include="..\..\renderer\uia\lib\uia.vcxproj" />
<ProjectReference Include="..\..\terminal\parser\lib\parser.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\terminal\input\lib\terminalinput.vcxproj" />

<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalCore\lib\TerminalCore-lib.vcxproj" />

<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalConnection\TerminalConnection.vcxproj">
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
Expand All @@ -188,6 +194,9 @@
<!-- ========================= Globals ======================== -->
<Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />

<Import Project="$(SolutionDir)build\rules\ConsumeWinRTInterfacesStatically.targets" />
<!-- TODO DH troubleshoot why ITerminalCore isn't rolling up into our winmd so our dependers don't need to know about it; namespace decollision? -->

<!-- This -must- go after cppwinrt.build.post.props because that includes many VS-provided props including appcontainer.common.props, which stomps on what cppwinrt.targets did. -->
<Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />

Expand Down
19 changes: 8 additions & 11 deletions src/cascadia/TerminalControl/dll/TerminalControl.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,31 +65,28 @@
<CopyLocalSatelliteAssemblies>true</CopyLocalSatelliteAssemblies>
</ProjectReference>
<!-- Dependency Interfaces -->
<!--
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>
-->
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalConnection\ITerminalConnection.vcxproj">
<Private>false</Private>
<Project>{EFC0B7EF-BB0D-44EC-BFC9-772AE4391D17}</Project>
</ProjectReference>
</ItemGroup>

<!--
<ItemGroup>
<!-- Manually add a reference to TerminalControl here. We need this so
MDMERGE will know where the TermControl types are defined. However, we need
to do it exactly like this so the packaging project won't roll up
TermControl's .xbf's from both the TermControl project and this one. -->
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>

<Reference Include="Microsoft.Terminal.TerminalConnection">
<HintPath>$(OpenConsoleCommonOutDir)TerminalConnection\Microsoft.Terminal.TerminalConnection.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
</ItemGroup>
-->

<ItemDefinitionGroup>
<Link>
Expand Down
9 changes: 5 additions & 4 deletions src/cascadia/TerminalCore/lib/terminalcore-lib.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,11 @@
<ProjectReference Include="$(OpenConsoleDir)src\renderer\dx\lib\dx.vcxproj">
<Project>{48d21369-3d7b-4431-9967-24e81292cf62}</Project>
</ProjectReference>
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>
</ItemGroup>

<ItemGroup>
<Midl Include="..\ICoreSettings.idl" />
<Midl Include="..\ICoreAppearance.idl" />
</ItemGroup>
<ItemDefinitionGroup>
<ClCompile>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
Expand All @@ -69,6 +68,8 @@
<!-- Careful reordering these. Some default props (contained in these files) are order sensitive. -->
<Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />

<Import Project="$(SolutionDir)build\rules\ConsumeWinRTInterfacesStatically.targets" />

<!-- This -must- go after cppwinrt.build.post.props because that includes many VS-provided props including appcontainer.common.props, which stomps on what cppwinrt.targets did. -->
<Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />
</Project>
11 changes: 5 additions & 6 deletions src/cascadia/TerminalSettingsEditor/Microsoft.Terminal.Settings.Editor.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,11 @@
<Private>false</Private>
</ProjectReference>

<ProjectReference Include="$(SolutionDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>

<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalControl\dll\TerminalControl.vcxproj">
<!-- Private:false and ReferenceOutputAssembly:false, in combination with
the manual reference to TerminalControl.winmd below make sure that this
Expand All @@ -397,12 +402,6 @@
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
</ItemGroup>

<ItemDefinitionGroup>
Expand Down
11 changes: 5 additions & 6 deletions src/cascadia/TerminalSettingsModel/Microsoft.Terminal.Settings.ModelLib.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,11 @@
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
</ProjectReference>

<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>

</ItemGroup>
<ItemGroup>
<!-- Manually add references to each of our dependent winmds. Mark them as private=false and CopyLocalSatelliteAssemblies=false, so that we don't
Expand All @@ -299,12 +304,6 @@
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
</ItemGroup>
<!-- ====================== Compiler & Linker Flags ===================== -->
<ItemDefinitionGroup>
Expand Down
8 changes: 1 addition & 7 deletions src/cascadia/TerminalSettingsModel/dll/Microsoft.Terminal.Settings.Model.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,7 @@
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>

<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
<!-- TODO DH validate removal -->
</ItemGroup>

<ItemDefinitionGroup>
Expand Down
18 changes: 5 additions & 13 deletions src/cascadia/WindowsTerminal/WindowsTerminal.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,26 +90,18 @@
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\Remoting\dll\Microsoft.Terminal.Remoting.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalSettingsEditor\Microsoft.Terminal.Settings.Editor.vcxproj" />

<ProjectReference Include="$(OpenConsoleDir)src\cascadia\ITerminalCore\ITerminalCore.vcxproj">
<Private>false</Private>
<Project>{40503EDC-E3E4-46AB-BC26-D293B956CAE8}</Project>
</ProjectReference>

<ProjectReference Include="$(OpenConsoleDir)src\types\lib\types.vcxproj" />
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\WinRTUtils\WinRTUtils.vcxproj">
<Project>{CA5CAD1A-039A-4929-BA2A-8BEB2E4106FE}</Project>
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
</ProjectReference>
</ItemGroup>

<!-- Manually add a reference to Core here. We need this so MDMERGE will know
where the Core types are defined. However, we need to do it exactly like this,
because the Core project is a lib not a dll, so it can't be ProjectReference'd
like everything else. It does get built into TerminalControl.dll, so we don't
need to worry about that. -->
<ItemGroup>
<Reference Include="Microsoft.Terminal.Core">
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
<IsWinMDFile>true</IsWinMDFile>
<Private>false</Private>
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
</Reference>
</ItemGroup>
<!--
This ItemGroup and the Globals PropertyGroup below it are required in order
to enable F5 debugging for the unpackaged application
Expand Down

1 comment on commit 2eb4b28

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (2)

decollision
dependers

Previously acknowledged words that are now absent CLA demoable everytime Hirots inthread reingest unmark :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:PKRoma/Terminal.git repository
on the dev/duhowett/interface-projects branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/PKRoma/Terminal/actions/runs/4399271438/attempts/1'
✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. If it doesn't work for you, you can manually add (one word per line) / remove items to expect.txt and the excludes.txt files.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.