Skip to content

build: add package-reference-format commitlint rule #9099

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
Planeshifter wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

build: add package-reference-format commitlint rule #9099

Planeshifter wants to merge 2 commits into from
+893 −0

Conversation

@Planeshifter
Copy link
Member

@Planeshifter Planeshifter commented Dec 16, 2025 •
edited
Loading

Description

What is the purpose of this pull request?

This pull request:

  • adds a new commitlint rule package-reference-format that enforces consistent formatting of stdlib package references in commit messages and PR titles. The rule requires package paths to be wrapped in backticks (e.g., math/base/special/abs) and prohibits the @stdlib/ prefix.

Related Issues

Does this pull request have any related issues?

No.

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" to using AI assistance, 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.".

Code was mainly generated by Claude Code according to my specifications.

@stdlib-js/reviewers

@Planeshifter Planeshifter force-pushed the philipp/commitlint-package-reference-format branch from 669748e to 8a6e310 Compare December 16, 2025 18:16
@Planeshifter
build: add package-reference-format commitlint rule
8372618 
---
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: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Planeshifter Planeshifter force-pushed the philipp/commitlint-package-reference-format branch from 8a6e310 to 8372618 Compare December 16, 2025 18:17
@Planeshifter Planeshifter marked this pull request as ready for review December 16, 2025 18:29
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Dec 16, 2025
@Planeshifter
chore: do not hoist declarations in example code
fa922b5 
---
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: na
  - 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
---
kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
...modules/@stdlib/_tools/commitlint/rules/package-reference-format/lib/namespace_segments.json
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

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

For clarity, is the main reason for hard coding this list to avoid reading the file system for each commit?

Copy link
Member Author

@Planeshifter Planeshifter Dec 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@kgryte Yes, precisely; don't want to reconstitute the list of namespaces on each commit (tested it and it does become very sluggish indeed otherwise). PR contains script to regenerate the list, and I don't believe it sometimes not being up-to-date would have large consequences.

kgryte
kgryte reviewed Dec 17, 2025
View reviewed changes
lib/node_modules/@stdlib/_tools/commitlint/rules/package-reference-format/scripts/build.js
Copy link
Member

@kgryte kgryte Dec 17, 2025

Choose a reason for hiding this comment

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

One set of tests which I think are missing here are commit messages with bodies. E.g., see https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/moving_packages.md#7-commit-the-changes-to-the-parent-namespace where there is an instance where including a prefix is acceptable.

In short, would be good to confirm that this lint rule only applies to commit subjects, not bodies.

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 Review A pull request which needs code review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Planeshifter @kgryte @stdlib-bot