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

Text and console reporters links to non-existing documentation pages for plugins #1340

Closed
mjpieters opened this issue Mar 18, 2022 · 2 comments · Fixed by #1358
Closed

Text and console reporters links to non-existing documentation pages for plugins #1340

mjpieters opened this issue Mar 18, 2022 · 2 comments · Fixed by #1358
Labels
bug Something isn't working

Comments

@mjpieters
Copy link
Contributor

Describe the bug

When using a plugin (such as jupyfmt, several reporters output links to a non-existing page.

E.g. the text reporter:

Results of jupyfmt linter (version 0.5.1)
See documentation on https://megalinter.github.io/descriptors/jupyter_jupyfmt/

and the console reporter:

- Using [jupyfmt v0.31.0] https://megalinter.github.io/v5/descriptors/jupyter_jupyfmt

To Reproduce
Steps to reproduce the behavior:

  1. Create a minimal setup:

    cd $(mktemp -d -t mcve-XXXXXXXXXX)
    cat > .mega-linter.yaml <<EOF
    PLUGINS:
      - https://raw.githubusercontent.com/kpj/jupyfmt/master/mega-linter-plugin-jupyfmt/jupyfmt.megalinter-descriptor.yml
    ENABLE:
      - JUPYTER
    EOF
    touch dummy.ipynb  # so the linter has something to run against
  2. Run npx mega-linter-runner

The console output will include:

### Processed [JUPYTER] files
- Using [jupyfmt v0.5.1] https://megalinter.github.io/v5/descriptors/jupyter_jupyfmt

and in report/linters_logs/WARNING-JUPYTER_JUPYFMT.log:

Results of jupyfmt linter (version 0.5.1)
See documentation on https://megalinter.github.io/descriptors/jupyter_jupyfmt/

Expected behavior

Either no documentation URL should be shown, or it should be possible for the plugin to define a URL, with a possible fallback to the linter_url value.

@mjpieters mjpieters added the bug Something isn't working label Mar 18, 2022
@nvuillam
Copy link
Member

That's right, MegaLinter plugins should redirect to the plugin documentation, i'll try to arrange that :)

@nvuillam
Copy link
Member

@mjpieters it should be ok now (with beta version) :)

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