mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-07-10 20:39:11 +02:00
0819a6268b
## Summary Move Command Palette developer documentation from \src/modules/cmdpal/doc\ to \doc/devdocs/modules/cmdpal\, consistent with the location of other module dev docs. Also updates the spell-check exclude path for the moved \.pdn\ file. Points 2 and 3 from the issue (extension settings how-to and details pane markdown documentation) are addressed in the windows-dev-docs-pr repo. Closes #38107 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
118 lines
5.0 KiB
PowerShell
118 lines
5.0 KiB
PowerShell
# The spec is next to this script:
|
|
$pathToSpec = Join-Path (Split-Path -parent $MyInvocation.MyCommand.Definition) initial-sdk-spec.md
|
|
# First, use the mistletoe library to parse the markdown file to json
|
|
$jsonText = mistletoe $pathToSpec --renderer mistletoe.ast_renderer.AstRenderer
|
|
$json = $jsonText | ConvertFrom-Json
|
|
|
|
$sdkContents = ""
|
|
foreach ($item in $json.children) {
|
|
if ($item.type -eq 'CodeFence') {
|
|
# we only care about code fences with language 'csharp'
|
|
if ($item.language -eq 'c#') {
|
|
$code = $item.children.content
|
|
# Each line that starts with `runtimeclass` or `interface` should be prefixed with the contract attribute
|
|
$code = $code -replace "(?m)^(runtimeclass|interface) ", "[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]`n`$1 "
|
|
|
|
# if there are two [contract] attributes, remove the second one
|
|
$code = $code -replace "(?m)^\[contract\(Microsoft.CommandPalette.Extensions.ExtensionsContract, ([0-9]+)\)\]\n\[contract\(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1\)\]", "[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, `$1)]"
|
|
|
|
|
|
# all the lines that start with `(whitespace)async (T)` should be translated to `IAsyncOperation<T>`
|
|
$code = $code -replace "(?m)^(\s*)async\s+(void)\s+([A-Za-z0-9_]+)\s*\(", "`$1Windows.Foundation.IAsyncAction `$3("
|
|
$code = $code -replace "(?m)^(\s*)async\s+([A-Za-z0-9_<>]+)\s+([A-Za-z0-9_]+)\s*\(", "`$1Windows.Foundation.IAsyncOperation<`$2> `$3("
|
|
$code = $code -replace ">>", "> >"
|
|
|
|
# Add four spaces to each line of the code block
|
|
$code = $code -replace "(?m)^", " "
|
|
|
|
$sdkContents += $code + "`n"
|
|
}
|
|
}
|
|
}
|
|
foreach ($item in $json.children) {
|
|
if ($item.type -eq 'CodeFence') {
|
|
# we only care about code fences with language 'csharp'
|
|
if ($item.language -eq 'csharp') {
|
|
$code = $item.children.content
|
|
# Each line that starts with `runtimeclass` or `interface` should be prefixed with the contract attribute
|
|
$code = $code -replace "(?m)^(runtimeclass|interface) ", "[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]`n`$1 "
|
|
|
|
# if there are two [contract] attributes, remove the second one
|
|
$code = $code -replace "(?m)^\[contract\(Microsoft.CommandPalette.Extensions.ExtensionsContract, ([0-9]+)\)\]\n\[contract\(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1\)\]", "[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, `$1)]"
|
|
|
|
|
|
# all the lines that start with `(whitespace)async (T)` should be translated to `IAsyncOperation<T>`
|
|
$code = $code -replace "(?m)^(\s*)async\s+(void)\s+([A-Za-z0-9_]+)\s*\(", "`$1Windows.Foundation.IAsyncAction `$3("
|
|
$code = $code -replace "(?m)^(\s*)async\s+([A-Za-z0-9_<>]+)\s+([A-Za-z0-9_]+)\s*\(", "`$1Windows.Foundation.IAsyncOperation<`$2> `$3("
|
|
$code = $code -replace ">>", "> >"
|
|
|
|
# Add four spaces to each line of the code block
|
|
$code = $code -replace "(?m)^", " "
|
|
|
|
$sdkContents += $code + "`n"
|
|
}
|
|
}
|
|
}
|
|
|
|
# now, write the fully formatted interface with headers and all:
|
|
Write-Output @"
|
|
namespace Microsoft.CommandPalette.Extensions
|
|
{
|
|
[contractversion(1)]
|
|
apicontract ExtensionsContract {}
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface IExtension {
|
|
IInspectable GetProvider(ProviderType providerType);
|
|
void Dispose();
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
enum ProviderType {
|
|
Commands = 0,
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface IIconData {
|
|
String Icon { get; };
|
|
Windows.Storage.Streams.IRandomAccessStreamReference Data { get; };
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface IIconInfo {
|
|
IIconData Light { get; };
|
|
IIconData Dark { get; };
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
struct KeyChord
|
|
{
|
|
Windows.System.VirtualKeyModifiers Modifiers;
|
|
Int32 Vkey;
|
|
Int32 ScanCode;
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface INotifyPropChanged {
|
|
event Windows.Foundation.TypedEventHandler<Object, IPropChangedEventArgs> PropChanged;
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface IPropChangedEventArgs {
|
|
String PropertyName { get; };
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface INotifyItemsChanged {
|
|
event Windows.Foundation.TypedEventHandler<Object, IItemsChangedEventArgs> ItemsChanged;
|
|
};
|
|
|
|
[contract(Microsoft.CommandPalette.Extensions.ExtensionsContract, 1)]
|
|
interface IItemsChangedEventArgs {
|
|
Int32 TotalItems { get; };
|
|
};
|
|
|
|
$sdkContents
|
|
}
|
|
"@
|