Skip to content

Add doc option #445

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.

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

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Add doc option #445

wants to merge 12 commits into from

Conversation

Chemaclass
Copy link
Member

@Chemaclass Chemaclass commented Jul 20, 2025

📚 Description

Right now all assertions can be found in the website https://bashunit.typeddevs.com/assertions
The goal is to enable finding those assertions from the ./bashunit directly

🔖 Changes

  • Add --doc [filter] option

✅ To-do list

  • I updated the CHANGELOG.md to reflect the new feature or fix
  • I updated the documentation to reflect the changes

🖼️ Demo

Screenshot 2025-07-20 at 14 12 03

⚠️ Problem

The current problem is that the built is a standalone executable, so there is no access to "docs/assertions.md"... we have to find another way 🤔

@Chemaclass Chemaclass self-assigned this Jul 20, 2025
@Chemaclass Chemaclass added the enhancement New feature or request label Jul 20, 2025
@antonio-gg-dev
Copy link
Member

Maybe during the build, assert.md could be processed and embedded into the final binary.

@antonio-gg-dev
Copy link
Member

Or perform a curl to download it from the internet if it hasn’t been done beforehand.

@Chemaclass
Copy link
Member Author

@antonio-gg-dev I want to avoid using curl, because I dont want to depend on internet to render documentation.
As you suggested, I will explore this week: embed the assertions.md docs into a function in the bin result on the build step. Then it can be pretty simple to read and manipulate the data from there 🧠

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants