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

Evaluate and add linting to detect at pull request issues in the change #45

Open
prasanth-reddy-wavemaker-com opened this issue Nov 19, 2019 · 1 comment
Assignees

Comments

@prasanth-reddy-wavemaker-com
Copy link
Contributor

prasanth-reddy-wavemaker-com commented Nov 19, 2019

When contributor submits a pull request, we should automatically detect using linting potential issues with the change. The potential issues could be:

  1. Linking to an image with incorrect path
  2. Missing link, perhaps they forgot to specify the target hyperlink
  3. When page is missing a mention of sidebar id
  4. Has code but has not surrounded the code with back ticks. For example: /learn/request-response-processing-rest-services.md
  5. Has HTML code that is not fenced properly leading it to be executed by browser causing nasty issues like Popup shown in OWASP page #97

check this remark-lint

@prasanth-reddy-wavemaker-com
Copy link
Contributor Author

Instead of trying the markdown lint approach, which is proving to be tricky, we can use cypress to parse the generated HTML of a page to find:

  1. java code which is not fenced.
  2. Pages that don't have sidebar,
  3. Page having links that are broken

However finding HTML, XML, JavaScript code that is unfenced should still be at linting phase. HTML, JS code that not fenced will become part of HTML and we will not be able to detect it using cypress test.

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

No branches or pull requests

3 participants