Code

Allow custom help providers#1259

Code

Merged

patriksvensson merged 25 commits intospectreconsole:mainspectreconsole/spectre.console:mainfrom FrankRay78:Custom-Help-ProviderFrankRay78/spectre.console:Custom-Help-ProviderCopy head branch name to clipboardSep 8, 2023

+1,647-331

Commits

Commits on Jul 5, 2023

• Help writer improvements

  Show description for dea428a
  FrankRay78

  committed
  dea428a

  Copy full SHA for dea428a

Commits on Jul 12, 2023

• Reordering to better group together tests for default command and branches

  FrankRay78

  committed
  e8ce305

  Copy full SHA for e8ce305

• Added documentation to CommandInfo.Flatten() method

  FrankRay78

  committed
  a467c35

  Copy full SHA for a467c35

Commits on Jul 19, 2023

• Allow custom help providers

  Show description for 0272a7d
  FrankRay78

  committed
  0272a7d

  Copy full SHA for 0272a7d

Commits on Aug 3, 2023

• Updated documentation for clarity and grammar

  FrankRay78

  committed
  1393ed5

  Copy full SHA for 1393ed5

Commits on Aug 4, 2023

• DefaultHelpProvider constructor now accepts an ICommandAppSettings, rather than individual configuration values

  FrankRay78

  committed
  a7757f9

  Copy full SHA for a7757f9

Commits on Aug 6, 2023

• Removed the setter on ICommandArgument.Position

  FrankRay78

  committed
  1f22d15

  Copy full SHA for 1f22d15

Commits on Aug 10, 2023

• Allow custom help providers to be configured, in addition to being registered in the type factory

  FrankRay78

  committed
  bdea5a5

  Copy full SHA for bdea5a5

• Exposed internal methods within DefaultHelpProvider for overriding by marking them virtual, to make it more easy for users to customise individual aspects of the default help provider. ie. not forc…

  Show description for f66e5cf
  FrankRay78

  committed
  f66e5cf

  Copy full SHA for f66e5cf

Commits on Aug 11, 2023

• Added example showing how to extend the built-in spectre.console help provider

  FrankRay78

  committed
  a7fdf3c

  Copy full SHA for a7fdf3c

• Added example showing how to extend the built-in spectre.console help provider

  FrankRay78

  committed
  f6986a5

  Copy full SHA for f6986a5

• Removed use of Composer internal class (which should not have been made accessible to Spectre.Console.Cli.Tests)

  FrankRay78

  committed
  db7c27d

  Copy full SHA for db7c27d

Commits on Aug 17, 2023

• User documentation for help providers

  FrankRay78

  committed
  6b449d5

  Copy full SHA for 6b449d5

Commits on Sep 2, 2023

• Added Spectre.Console.Cli.Help to global usings; removed fully qualified Help namespaces throughout codebase; removed use of regions;

  FrankRay78

  committed
  919f9f8

  Copy full SHA for 919f9f8

• Added the Example meta data to Help.csproj

  FrankRay78

  committed
  a4f06aa

  Copy full SHA for a4f06aa

• Explicitly qualify the return type as IRenderable

  FrankRay78

  committed
  55c4271

  Copy full SHA for 55c4271

• Removed namespace qualification from DefaultHelpProvider, IHelpProvider for reader clarity

  FrankRay78

  committed
  bb1c986

  Copy full SHA for bb1c986

• Use an injected IAnsiConsole since that is the recommended best practice.

  FrankRay78

  committed
  d3b7f6b

  Copy full SHA for d3b7f6b

• Added null argument check

  FrankRay78

  committed
  6903c15

  Copy full SHA for 6903c15

• No multiple blank lines

  FrankRay78

  committed
  3e7dbc2

  Copy full SHA for 3e7dbc2

• Minor refactoring and code commentary to show that CommandModel always serves an non-null applicationame when cast as ICommandModel (as used by the help provider)

  FrankRay78

  committed
  ebd73a1

  Copy full SHA for ebd73a1

• Removed the redundant Write method on IHelpProvider

  FrankRay78

  committed
  08eda96

  Copy full SHA for 08eda96

• Use IReadOnlyList<> instead

  FrankRay78

  committed
  416f656

  Copy full SHA for 416f656

• Renamed DefaultHelpProvider to HelpProvider

  FrankRay78

  committed
  57613f3

  Copy full SHA for 57613f3

• Removed redundant "Help." namespace prefixes

  FrankRay78

  committed
  475818b

  Copy full SHA for 475818b