Skip to content

feat: enforce primary header filenames - #15369

Open
kanikasharma-18 wants to merge 3 commits into
stdlib-js:developfrom
kanikasharma-18:feat/lint-header-filenames
Open

feat: enforce primary header filenames#15369
kanikasharma-18 wants to merge 3 commits into
stdlib-js:developfrom
kanikasharma-18:feat/lint-header-filenames

Conversation

@kanikasharma-18

@kanikasharma-18 kanikasharma-18 commented Sep 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Resolves #13658.

Description

What is the purpose of this pull request?

This pull request:

  • adds lint support for enforcing primary header filename conventions for packages containing an include/ directory
  • requires the primary header filename to match the package name, with hyphens converted to underscores
  • preserves hyphens in parent package directories
  • allows additional headers with arbitrary filenames
  • adds test coverage for missing, valid, and invalid primary header filenames
  • documents the include/ directory in the package structure documentation

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" above, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

I used AI assistance for research and understanding of the implementation.

@stdlib-js/reviewers

@kanikasharma-18
kanikasharma-18 requested a review from a team September 20, 2026 12:15
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 20, 2026
@stdlib-bot

stdlib-bot commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@kanikasharma-18

kanikasharma-18 commented Sep 20, 2026

Copy link
Copy Markdown
Contributor Author

@kgryte @Planeshifter @nakul-krishnakumar

Hi! I’ve opened this PR for #13658. It adds lint support for enforcing primary header filename conventions, along with the relevant tests and documentation.

Would appreciate a review when you get a chance. Thank you!

Lokeshranjan8
Lokeshranjan8 reviewed Oct 28, 2026
View reviewed changes
Comment thread lib/node_modules/@stdlib/_tools/lint/header-filenames/lib/lint.js
* @returns {(ObjectArray|EmptyArray)} array of lint errors
*/
function lint( arr ) {
var packages;

@Lokeshranjan8 Lokeshranjan8 Oct 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The variable declarations should be ordered by length in decreasing order. Please rearrange them accordingly.

@kanikasharma-18 kanikasharma-18 Nov 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review!
I have rearranged the variable declarations in the order of decreasing length.

@kanikasharma-18
fix: order header filename lint declarations
e42eec5 
---
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_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - 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: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
Planeshifter
Planeshifter reviewed Nov 2, 2026
View reviewed changes
Comment thread docs/contributing/packages.md
Comment on lines 36 to 38
benchmark/ benchmarks
include/ public C/C++ header files
docs/ documentation (excluding README)

@Planeshifter Planeshifter Nov 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
benchmark/ benchmarks
include/ public C/C++ header files
docs/ documentation (excluding README)
benchmark/ benchmarks
include/ public C/C++ header files
docs/ documentation (excluding README)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Planeshifter Planeshifter Planeshifter left review comments
+1 more reviewer
@Lokeshranjan8 Lokeshranjan8 Lokeshranjan8 left review comments
Reviewers whose approvals may not affect merge requirements

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

Assignees

No one assigned

Labels

Needs Review A pull request which needs code review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[RFC]: Add lint support for enforcing header filename conventions

4 participants

@kanikasharma-18 @stdlib-bot @Planeshifter @Lokeshranjan8