Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor help internals into separate interface/class #1365

Merged
merged 66 commits into from Oct 23, 2020
Merged

Refactor help internals into separate interface/class #1365

merged 66 commits into from Oct 23, 2020

Commits on Sep 28, 2020

  1. Start filling out HelpUtils to try pattern

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    dde2535 View commit details
    Browse the repository at this point in the history

  2. Shift the largestFoo routines into helper

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    70038b5 View commit details
    Browse the repository at this point in the history

  3. Update generation of Commands section of help

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    9c08b35 View commit details
    Browse the repository at this point in the history

  4. Rework helpInformation in consistent new style

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    59d988e View commit details
    Browse the repository at this point in the history

  5. Remove unused routines

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    fe26f38 View commit details
    Browse the repository at this point in the history

  6. Make columns part of HelpUtils

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    f8c5cb2 View commit details
    Browse the repository at this point in the history

  7. Offer a light weight override to HelpUtils

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    720b382 View commit details
    Browse the repository at this point in the history

  8. Tweak comment

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    65edc7a View commit details
    Browse the repository at this point in the history

  9. Add chain test for helpUtilOverrides

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    08cc506 View commit details
    Browse the repository at this point in the history

  10. Add itemIndent as another proof of concept of allowing overrides

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    c81b322 View commit details
    Browse the repository at this point in the history

  11. Avoid Utils contraction

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    3b8fa89 View commit details
    Browse the repository at this point in the history

  12. Update comments

    @shadowspawn
    shadowspawn committed Sep 28, 2020
    Copy the full SHA
    fc5e4da View commit details
    Browse the repository at this point in the history

Commits on Sep 29, 2020

  1. Switch columns from function to data property

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    9d1cc4d View commit details
    Browse the repository at this point in the history

  2. Remove itemIndent(), not useful enough alone or as a pattern for now

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    965b7f9 View commit details
    Browse the repository at this point in the history

  3. Make _helpToolsOverrides inherited

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    8a2bbfa View commit details
    Browse the repository at this point in the history

  4. Improve naming for termWidth

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    fa73c6c View commit details
    Browse the repository at this point in the history

  5. Move usage into HelpTools

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    c91c515 View commit details
    Browse the repository at this point in the history

  6. Add term and description routines to HelpTools so symmetrical pattern

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    f4de668 View commit details
    Browse the repository at this point in the history

  7. Name the magic numbers

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    478e86c View commit details
    Browse the repository at this point in the history

  8. More consistent naming

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    11be18a View commit details
    Browse the repository at this point in the history

  9. Remove reference to removed routine

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    78017aa View commit details
    Browse the repository at this point in the history

  10. Move help formatting into HelpTools

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    162dca6 View commit details
    Browse the repository at this point in the history

  11. Fix typescript-checkJS errors

    @shadowspawn
    shadowspawn committed Sep 29, 2020
    Copy the full SHA
    a0d1862 View commit details
    Browse the repository at this point in the history

Commits on Sep 30, 2020

  1. Simpler naming

    @shadowspawn
    shadowspawn committed Sep 30, 2020
    Copy the full SHA
    f17be74 View commit details
    Browse the repository at this point in the history

  2. Slightly simplify code

    @shadowspawn
    shadowspawn committed Sep 30, 2020
    Copy the full SHA
    943d01a View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2020

  1. Add getter/setter to assist overrides

    @shadowspawn
    shadowspawn committed Oct 2, 2020
    Copy the full SHA
    79deb3a View commit details
    Browse the repository at this point in the history

  2. Add sort overrides

    @shadowspawn
    shadowspawn committed Oct 2, 2020
    Copy the full SHA
    9425003 View commit details
    Browse the repository at this point in the history

Commits on Oct 3, 2020

  1. First cut at TypeScript definitions for Help, no TSDoc yet

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    8fc29df View commit details
    Browse the repository at this point in the history

  2. Replace pad and low level indents with modern calls

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    63f58d9 View commit details
    Browse the repository at this point in the history

  3. Rename and rework type for HelpConfiguration

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    25f240f View commit details
    Browse the repository at this point in the history

  4. Combine optionalWrap and wrap

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    d8ba2c0 View commit details
    Browse the repository at this point in the history

  5. Add createHelp to TypeScript definition

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    d1da3f7 View commit details
    Browse the repository at this point in the history

  6. Add test-all script

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    ee0a71b View commit details
    Browse the repository at this point in the history

  7. More carefully make concrete help option for displaying

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    2ea7619 View commit details
    Browse the repository at this point in the history

  8. Fix test with valid parameters for custom help

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    36b3be7 View commit details
    Browse the repository at this point in the history

  9. Start adding Help tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    8ec5342 View commit details
    Browse the repository at this point in the history

  10. Add largestCommandTermLength tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    5e895fc View commit details
    Browse the repository at this point in the history

  11. Add more Help tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    71acb69 View commit details
    Browse the repository at this point in the history

  12. Add commandUsage tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    a946cda View commit details
    Browse the repository at this point in the history

  13. Add test for commandDescription

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    8230fe5 View commit details
    Browse the repository at this point in the history

  14. Add missing Command properties, and default description to empty string

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    09c460e View commit details
    Browse the repository at this point in the history

  15. Add tests for optionDescription

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    1e60ab1 View commit details
    Browse the repository at this point in the history

  16. Add padWidth tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    7e75235 View commit details
    Browse the repository at this point in the history

  17. Add sort tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    b96c528 View commit details
    Browse the repository at this point in the history

  18. Add columns and wrap tests

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    e195b78 View commit details
    Browse the repository at this point in the history

  19. Add test for legacy commandTerm behaviour

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    74c2adf View commit details
    Browse the repository at this point in the history

  20. Add TypeScript usage tests for Help

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    f654c9a View commit details
    Browse the repository at this point in the history

  21. Refactor Help tests into separate files

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    ed68199 View commit details
    Browse the repository at this point in the history

  22. Add tests for createHelp and configureHelp

    @shadowspawn
    shadowspawn committed Oct 3, 2020
    Copy the full SHA
    c26f943 View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2020

  1. Add JSDoc for Help. 

    Rename methods.
Delete @api public as default.
    @shadowspawn
    shadowspawn committed Oct 4, 2020
    Copy the full SHA
    3707814 View commit details
    Browse the repository at this point in the history

  2. Add TSDoc for Help

    @shadowspawn
    shadowspawn committed Oct 4, 2020
    Copy the full SHA
    d99ec22 View commit details
    Browse the repository at this point in the history

  3. Test special caes of implicit help flags

    @shadowspawn
    shadowspawn committed Oct 4, 2020
    Copy the full SHA
    9133df3 View commit details
    Browse the repository at this point in the history

Commits on Oct 7, 2020

  1. Clarify method naming

    @shadowspawn
    shadowspawn committed Oct 7, 2020
    Copy the full SHA
    82d43f5 View commit details
    Browse the repository at this point in the history

Commits on Oct 9, 2020

  1. Shift the Usage prefix into formatHelp

    @shadowspawn
    shadowspawn committed Oct 9, 2020
    Copy the full SHA
    8c0ae2e View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2020

  1. Add Help class mention and reorder help

    @shadowspawn
    shadowspawn committed Oct 11, 2020
    Copy the full SHA
    c6e7f58 View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2020

  1. Add simple configure-help example

    @shadowspawn
    shadowspawn committed Oct 14, 2020
    Copy the full SHA
    cc3a322 View commit details
    Browse the repository at this point in the history

Commits on Oct 16, 2020

  1. Add example file to README

    @shadowspawn
    shadowspawn committed Oct 16, 2020
    Copy the full SHA
    142bcaa View commit details
    Browse the repository at this point in the history

  2. Rename to sortSubcommands to match other naming

    @shadowspawn
    shadowspawn committed Oct 16, 2020
    Copy the full SHA
    ec77a66 View commit details
    Browse the repository at this point in the history

Commits on Oct 18, 2020

  1. Do not weaken configuration type, user can extend as required

    @shadowspawn
    shadowspawn committed Oct 18, 2020
    Copy the full SHA
    5fd56e0 View commit details
    Browse the repository at this point in the history

  2. Do not cache implicit help command calculation so safer (no need, not… 

    … being thrashed)
    @shadowspawn
    shadowspawn committed Oct 18, 2020
    Copy the full SHA
    b0850b0 View commit details
    Browse the repository at this point in the history

  3. Add JSDoc for configureHelp

    @shadowspawn
    shadowspawn committed Oct 18, 2020
    Copy the full SHA
    b6503f6 View commit details
    Browse the repository at this point in the history

  4. Add TSDoc

    @shadowspawn
    shadowspawn committed Oct 18, 2020
    Copy the full SHA
    ea676a8 View commit details
    Browse the repository at this point in the history

  5. Add missing TSDoc

    @shadowspawn
    shadowspawn committed Oct 18, 2020
    Copy the full SHA
    634828b View commit details
    Browse the repository at this point in the history

Commits on Oct 21, 2020

  1. Switch option sort to use attributeName, with negative after positive

    @shadowspawn
    shadowspawn committed Oct 21, 2020
    Copy the full SHA
    ee48a67 View commit details
    Browse the repository at this point in the history

  2. No need for string template literal

    @shadowspawn
    shadowspawn committed Oct 21, 2020
    Copy the full SHA
    67ea43c View commit details
    Browse the repository at this point in the history

Commits on Oct 22, 2020

  1. No need for string template literal

    @shadowspawn
    shadowspawn committed Oct 22, 2020
    Copy the full SHA
    7266d89 View commit details
    Browse the repository at this point in the history