Skip to content

Document hierarchical lint configuration#1301

Merged
SeanTAllen merged 1 commit intomainfrom
docs/hierarchical-lint-config
Apr 5, 2026
Merged

Document hierarchical lint configuration#1301
SeanTAllen merged 1 commit intomainfrom
docs/hierarchical-lint-config

Conversation

@SeanTAllen
Copy link
Copy Markdown
Member

Update the linting documentation to cover hierarchical .pony-lint.json support being added in ponylang/ponyc#5135.

  • Add "Subdirectory Overrides" subsection under Configuration with example, precedence rules, category-cleaning merge semantics, and error handling
  • Clarify that CLI --disable takes precedence over all config files including subdirectory overrides
  • Add "malformed config" to the exit code 2 description

Parked review item: The Completeness reviewer flagged that the interaction between --config (explicit config path) and the hierarchy root anchoring isn't documented. This is an edge case — when someone passes --config /some/path/.pony-lint.json, subdirectory configs are resolved relative to that file's directory. Didn't include it because it adds complexity for an uncommon scenario, but worth considering.

ponyc PR #5135 adds subdirectory .pony-lint.json support. Update the
linting docs to cover subdirectory overrides, category-cleaning merge
semantics, and malformed config handling. Also update the exit code
table to include malformed configs.
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Apr 5, 2026
@SeanTAllen SeanTAllen merged commit fa9ec31 into main Apr 5, 2026
11 checks passed
@SeanTAllen SeanTAllen deleted the docs/hierarchical-lint-config branch April 5, 2026 17:11
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Apr 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants