+1,060 −0

Conversation

Planeshifter

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-botstdlib-bot added ToolsIssue or pull request related to project tooling.Needs ReviewA pull request which needs code review.labels Mar 18, 2025
@Planeshifter

/stdlib update-copyright-years

@stdlib-botstdlib-bot added the bot: In ProgressPull request is currently awaiting automation.label Mar 18, 2025
@stdlib-botstdlib-bot added bot: In ProgressPull request is currently awaiting automation.and removed bot: In ProgressPull request is currently awaiting automation.labels Mar 18, 2025
@stdlib-jsstdlib-js deleted a comment from stdlib-bot Mar 18, 2025
@stdlib-jsstdlib-js deleted a comment from stdlib-bot Mar 18, 2025
@PlaneshifterPlaneshifter requested a review from kgryte March 25, 2025 08:26
@kgrytekgryte added Needs ChangesPull request which needs changes before being merged.and removed Needs ReviewA 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
---
@PlaneshifterPlaneshifter requested a review from kgryte April 20, 2025 21:42
@stdlib-botstdlib-bot added the Needs ReviewA pull request which needs code review.label Apr 20, 2025
kgryte
kgryte reviewed Apr 23, 2025
View reviewed changes

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.

@kgrytekgryte removed the Needs ReviewA 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
---
@PlaneshifterPlaneshifter requested a review from kgryte April 24, 2025 21:54
@stdlib-botstdlib-bot added the Needs ReviewA pull request which needs code review.label Apr 24, 2025
@kgrytekgryte removed the Needs ChangesPull 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.

@kgrytekgryte added Needs DiscussionNeeds further discussion.and removed Needs ReviewA pull request which needs code review.labels Apr 25, 2025
@kgryte

/stdlib merge

@stdlib-botstdlib-bot added the bot: In ProgressPull request is currently awaiting automation.label May 31, 2025
@stdlib-botstdlib-bot removed the bot: In ProgressPull request is currently awaiting automation.label May 31, 2025
Sign up for free to join this conversation on . Already have an account? Sign in to comment

@kgryte kgryte kgryte left review comments

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

No one assigned
Needs DiscussionNeeds further discussion.ToolsIssue or pull request related to project tooling.
None yet
No milestone

Successfully merging this pull request may close these issues.