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

Feat: Added tabular markdown writer #1722

Merged
merged 28 commits into from
May 1, 2023
Merged

Feat: Added tabular markdown writer #1722

merged 28 commits into from
May 1, 2023

Commits on Apr 14, 2023

  1. 🚀 feat(docs.go): add support for generating tabular markdown document… 

    …ation

✅ test(docs_test.go): add tests for generating tabular markdown documentation

✨ feat(template.go): add MarkdownTabularDocTemplate to generate a markdown table for command flags and environment variables
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    b857483 View commit details
    Browse the repository at this point in the history

  2. 🐛 fix(docs.go): split UsageText into an array of strings 

    🐛 fix(fish_test.go): add EXAMPLE_VARIABLE_NAME to another-flag's EnvVars
✨ feat(template.go): add support for multiline UsageText in MarkdownTabularDocTemplate
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    763d715 View commit details
    Browse the repository at this point in the history

  3. 📝 docs(godoc-current.txt): add ToTabularMarkdown method to App struct

    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    bfe4046 View commit details
    Browse the repository at this point in the history

  4. 📝 docs(godoc-v3.x.txt): add ToTabularMarkdown method to App struct

    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    02295d9 View commit details
    Browse the repository at this point in the history

  5. 🔨 refactor(docs.go): remove unused TabularOption type and WithTabular… 

    …AppPath function

✨ feat(docs.go): add ToTabularToFileBetweenTags function to generate tabular markdown documentation and update file between tags
🔨 refactor(docs_test.go): update tests to use ToTabularMarkdown with appPath parameter instead of TabularOption
✅ test(docs_test.go): add tests for ToTabularToFileBetweenTags function
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    2167107 View commit details
    Browse the repository at this point in the history

  6. 🐛 fix(docs_test.go): add error handling for file close operation

    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    c45d216 View commit details
    Browse the repository at this point in the history

  7. 🐛 fix(docs_test.go): ignore windows line endings in file content

    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    b046679 View commit details
    Browse the repository at this point in the history

  8. 🔧 chore(docs_test.go): change comment to lowercase 'ignore' and remov… 

    …e extra space
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    015e176 View commit details
    Browse the repository at this point in the history

  9. 🐛 fix(docs_test.go): fix typo in comment, add space before 'line endi… 

    …ngs'
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    c2ec633 View commit details
    Browse the repository at this point in the history

  10. 🐛 fix(docs_test.go): use bytes.Replace instead of bytes.ReplaceAll to… 

    … support older Go versions
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    f46c8f5 View commit details
    Browse the repository at this point in the history

  11. 🐛 fix(docs_test.go): trim whitespaces and line endings after replacin… 

    …g windows line endings
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    7396688 View commit details
    Browse the repository at this point in the history

  12. 🐛 fix(docs_test.go): remove unnecessary trimming of bytes in bytes.Re… 

    …place function
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    d42ae6d View commit details
    Browse the repository at this point in the history

  13. 🐛 fix(docs_test.go): remove unnecessary second argument in bytes.Repl… 

    …ace function call to ignore windows line endings
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    daf2ae3 View commit details
    Browse the repository at this point in the history

  14. 🔥 refactor(docs_test.go): remove unused bytes package import 

    🔥 refactor(docs_test.go): comment out unused windows line endings replacement
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    260031b View commit details
    Browse the repository at this point in the history

  15. 🔨 refactor(docs_test.go): remove commented out code 

    🐛 fix(docs_test.go): fix expected content type to byte array
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    8940782 View commit details
    Browse the repository at this point in the history

  16. 🐛 fix(docs_test.go): replace windows line endings with unix line endings

    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    012763e View commit details
    Browse the repository at this point in the history

  17. 🐛 fix(docs_test.go): replace line ending byte sequence to fix test fa… 

    …ilure on Windows
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    a0c1d80 View commit details
    Browse the repository at this point in the history

  18. 🔥 refactor(docs_test.go): remove unused bytes package import 

    🔥 refactor(docs_test.go): comment out unused code
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    ebf4e51 View commit details
    Browse the repository at this point in the history

  19. 🐛 fix(docs_test.go): normalize newlines in file content before comparing 

    ✨ feat(docs_test.go): add normalizeNewlines function to normalize windows and mac newlines into unix newlines
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    1865722 View commit details
    Browse the repository at this point in the history

  20. 🐛 fix(docs_test.go): refactor normalizeNewlines function to remove du… 

    …plicated code and improve readability
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    33ea5a2 View commit details
    Browse the repository at this point in the history

  21. 🐛 fix(docs_test.go): add comment to clarify the purpose of normalizin… 

    …g newlines in test
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    e2824a8 View commit details
    Browse the repository at this point in the history

  22. 🔧 chore(docs_test.go): update comment to clarify the purpose of the f… 

    …unction
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    aa63bac View commit details
    Browse the repository at this point in the history

  23. 🐛 fix(docs_test.go): add comment to clarify the purpose of normalizin… 

    …g newlines in test
    @tarampampam
    tarampampam committed Apr 14, 2023
    Configuration menu
    Copy the full SHA
    d36393b View commit details
    Browse the repository at this point in the history

Commits on May 1, 2023

  1. 🧪 test(docs_test.go): add test for ToTabularMarkdown with custom app … 

    …path
    @tarampampam
    tarampampam committed May 1, 2023
    Configuration menu
    Copy the full SHA
    05cf386 View commit details
    Browse the repository at this point in the history

  2. 🧪 test(docs_test.go): add test case for ToTabularMarkdown with empty … 

    …app path
    @tarampampam
    tarampampam committed May 1, 2023
    Configuration menu
    Copy the full SHA
    949f45e View commit details
    Browse the repository at this point in the history

  3. 🚨 test(docs_test.go): add test case for ToTabularMarkdownFailed funct… 

    …ion with invalid template.
    @tarampampam
    tarampampam committed May 1, 2023
    Configuration menu
    Copy the full SHA
    d945e8d View commit details
    Browse the repository at this point in the history

  4. ArgsUsage in next line

    @tarampampam
    tarampampam committed May 1, 2023
    Configuration menu
    Copy the full SHA
    d8caf8b View commit details
    Browse the repository at this point in the history

  5. 🐛 fix(docs_test.go): rename TestToTabularMarkdownFull to TestToTabula… 

    …rMarkdown and remove TestToTabularMarkdownWithEmptyAppPath

✨ feat(docs_test.go): add subtests to TestToTabularMarkdown to test different scenarios
🔥 chore(docs_test.go): remove unused variable and restore MarkdownTabularDocTemplate after test
    @tarampampam
    tarampampam committed May 1, 2023
    Configuration menu
    Copy the full SHA
    9640f32 View commit details
    Browse the repository at this point in the history