Skip to content

build: add remark plugin for validating HTML section structure #6133

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

build: add remark plugin for validating HTML section structure #6133

wants to merge 5 commits into from

Conversation

Planeshifter
Copy link
Member

What is the purpose of this pull request?

This pull request:

  • adds a remark plugin for validating that the HTML sections structure in README.md files is accurate.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@Planeshifter
build: add remark plugin for validating HTML section structure
16ce662 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added Tools Issue or pull request related to project tooling. Needs Review A pull request which needs code review. labels Mar 18, 2025
@Planeshifter
Copy link
Member Author

/stdlib update-copyright-years

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Mar 18, 2025
@stdlib-bot stdlib-bot added bot: In Progress Pull request is currently awaiting automation. and removed bot: In Progress Pull request is currently awaiting automation. labels Mar 18, 2025
@stdlib-js stdlib-js deleted a comment from stdlib-bot Mar 18, 2025
@stdlib-js stdlib-js deleted a comment from stdlib-bot Mar 18, 2025
@Planeshifter Planeshifter requested a review from kgryte March 25, 2025 08:26
@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Apr 16, 2025
@Planeshifter
chore: address PR feedback and move repeated logic to helper functions
59665e5 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Planeshifter Planeshifter requested a review from kgryte April 20, 2025 21:42
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 20, 2025
@kgryte
Apply suggestions from code review
62f6e82 
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
kgryte reviewed Apr 23, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

Other than questions around the use of exec, this is shaping up.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 23, 2025
@Planeshifter
chore: rename variables and define empty line regexp
12e5511 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Planeshifter Planeshifter requested a review from kgryte April 24, 2025 21:54
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 24, 2025
@kgryte kgryte removed the Needs Changes Pull request which needs changes before being merged. label Apr 24, 2025
kgryte
kgryte reviewed Apr 24, 2025
View reviewed changes
lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/lib/main.js
if ( !hasValidWhitespace( node, nextNode ) ) {
msg = 'Missing proper empty line after closing section tag. There should be an empty line between </section> and the closing comment.';
errCode = 'missing-empty-line-after-section';
reportErr( file, node, msg, errCode );
Copy link
Member

Choose a reason for hiding this comment

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

@Planeshifter Just checking, but for a number of these reportErr statements, we don't early return, but instead fall through to subsequent logic. Are these fall-throughs intentional? I'd want to avoid a scenario where lint errors pile up and it becomes confusing for devs to understand what the actual issue is which is triggering lint failures.

Copy link
Member

Choose a reason for hiding this comment

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

If we shouldn't be early returning, it may be good to add a comment in each circumstance indicating that fall-through is intentional.

@kgryte kgryte added Needs Discussion Needs further discussion. and removed Needs Review A pull request which needs code review. labels Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Needs Discussion Needs further discussion. Tools Issue or pull request related to project tooling.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Planeshifter @kgryte @stdlib-bot