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.

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

update cli, gh action, and docs to include all features #47

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dwreeves
Copy link

@dwreeves dwreeves commented Apr 20, 2024

I'm updating rich-click docs right now.

Having working_dir: as an option in the Github Actions would be extremely helpful. For now I need to do either
<!-- RICH-CODEX working_dir: . --> or use a fake_command on literally every command in the docs to make it work the way I want. Adding working_dir: "." to the GH action would be great.

While I was at it, I also updated the table to reflect everything available in the CLI, as I noticed it wasn't in parity.


Update: won't use these for rich-click docs after all, but they're still good changes.

Copy link
Owner

@ewels ewels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one, thanks!

@dwreeves
Copy link
Author

dwreeves commented Apr 21, 2024

Woops, forgot to run pre-commit. Just did that.

@dwreeves dwreeves requested a review from ewels April 21, 2024 17:53
@dwreeves
Copy link
Author

Running into an actual issue this time.

image

This started happening when I added | fold -w 120 to the command output. 🤔

I wonder if we can just add a --fold parameter instead?

@dwreeves
Copy link
Author

Never mind the --fold parameter, I found via Google a unicode-safe way to do that.

Also, give this PR a few minutes... I'm making some more changes.

@dwreeves
Copy link
Author

Ready for re-review!

Copy link
Owner

@ewels ewels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good


1. Install the [VSCode-YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)

2. In your repo, create a `.vscode/settings.jsonc` or `.vscode/settings.template.jsonc` file containing the following data. This is what tells the extension which schema to associate with each file.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add this to https://www.schemastore.org/json/ so that it loads automatically for any VSCode users.

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

Successfully merging this pull request may close these issues.

2 participants