Skip to content

build: restore shared JSDoc settings in flat config - #16378

Merged
kgryte merged 1 commit into
developfrom
philipp/restore-eslint-jsdoc-settings
Oct 30, 2026
Merged

kgryte merged 1 commit into
developfrom
philipp/restore-eslint-jsdoc-settings

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Addresses the JSDoc lint regression observed in #16346.

Description

What is the purpose of this pull request?

This pull request:

  • restores settings.jsdoc.contexts and settings.jsdoc.tagNamePreference in the base JavaScript flat configuration.
  • preserves the project's preference for @constructor over @class, fixing the jsdoc/check-tag-names error on existing constructor documentation.

These settings were present in the legacy configuration at commit fd16a2f49cc, which introduced them in #10965. They were omitted when #10973 switched JavaScript linting to flat configuration.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

What carried over from the reference(s)?

  • The complete settings.jsdoc block, including all five contexts and the class: 'constructor' tag preference.

What differed, or what did you have to work out yourself?

  • The settings are applied within the base JavaScript entry in eslint.config.js, preserving inheritance by the Markdown code-block configuration.

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.

Validation:

  • Confirmed the restored settings exactly match the legacy configuration.
  • Linted array/fixed-endian-factory/lib/main.js and eslint.config.js: zero errors; one existing stdlib/no-single-property-require warning on the config's path import.
  • Verified a focused reproducer rejects @constructor without the settings, accepts it with the settings, and continues to flag @class.
  • Confirmed the Markdown code-block configuration inherits the restored settings.
  • git diff --check, normal pre-commit checks, and the pre-push dependency license check passed.
  • Used EC_VERSION=v3.11.3 locally because the installed EditorConfig downloader does not recognize the latest release's renamed macOS binary assets.

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.".

This PR was written primarily by OpenAI Codex under human direction, including investigation, implementation, validation, and the PR description.


@stdlib-js/reviewers

---
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
---
@stdlib-bot stdlib-bot added the Good First PR A pull request resolving a Good First Issue. label Oct 30, 2026
@stdlib-js stdlib-js deleted a comment from stdlib-bot Oct 30, 2026
@Planeshifter
Planeshifter marked this pull request as ready for review October 30, 2026 04:53
@Planeshifter
Planeshifter requested review from a team and kgryte October 30, 2026 04:53
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 30, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Oct 30, 2026

@kgryte kgryte left a comment •

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.

@Planeshifter We've now a few of these situations where the previous settings were not carried over. Would you mind taking a closer look at the other previous overrides we had and making sure we have 1:1 parity?

@kgryte
kgryte merged commit 715c639 into develop Oct 30, 2026
52 of 53 checks passed
@kgryte
kgryte deleted the philipp/restore-eslint-jsdoc-settings branch October 30, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First PR A pull request resolving a Good First Issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants