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

rstcheck does not have a -c option #2869

Closed
daltonv opened this issue Aug 8, 2023 · 1 comment · Fixed by #2899
Closed

rstcheck does not have a -c option #2869

daltonv opened this issue Aug 8, 2023 · 1 comment · Fixed by #2899
Labels
bug Something isn't working

Comments

@daltonv
Copy link
Contributor

daltonv commented Aug 8, 2023

Describe the bug
The megalinter config (as of megalinter v7.2.1) RST_RSTCHECK_CONFIG_FILE uses the wrong cli arg for passing a config file to rstcheck

To Reproduce
Steps to reproduce the behavior:

  1. Modify the .mega-linter.yml file to set RST_RSTCHECK_CONFIG_FILE like
    RST_RSTCHECK_CONFIG_FILE: pyproject.toml
  2. Run megalinter and see it fail with:
- Using [rstcheck v6.1.2] https://megalinter.io/7.2.1/descriptors/rst_rstcheck
- MegaLinter key: [RST_RSTCHECK]
- Rules config: [/github/workspace/pyproject.toml]
- Number of files analyzed: [4]
[rstcheck] docs/cpu.rst - ERROR - 1 error(s)
--Error detail:
Usage: rstcheck [OPTIONS] FILES...
Try 'rstcheck --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such option: -c  

Expected behavior
Instead this config option should use the correct --config argument.

Additional context
Additionally I think rstcheck should be installed with pip install rstcheck[toml,sphinx] to support sphinx directives in rst files and toml config files.

@daltonv daltonv added the bug Something isn't working label Aug 8, 2023
nvuillam added a commit that referenced this issue Aug 21, 2023
@nvuillam
Copy link
Member

@daltonv thanks for catching the issue, PR is on the way :)

nvuillam added a commit that referenced this issue Aug 21, 2023
sanmai-NL pushed a commit to sanmai-NL/megalinter that referenced this issue Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants