Improve compound name linting and idiomatic checks by yegor256 · Pull Request #809 · objectionary/lints

yegor256 · 2026-03-24T00:59:01Z

fixes #806

Summary by CodeRabbit

Bug Fixes
- The compound-name linter now recognizes EO idiomatic names (prefixes as-, is-, and suffix -of) and no longer flags them as violations.
Documentation
- Updated docs to explicitly permit as- conversion, is- predicate, and -of extractor naming patterns with examples.
Tests
- Added lint tests to verify these idiomatic names produce no warnings.

coderabbitai · 2026-03-24T00:59:15Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 98437d86-20bf-4ba5-b508-0227e71819cb

📥 Commits

Reviewing files that changed from the base of the PR and between 9cf073b and d6981d9.

📒 Files selected for processing (1)

src/main/resources/org/eolang/motives/names/compound-name.md

✅ Files skipped from review due to trivial changes (1)

src/main/resources/org/eolang/motives/names/compound-name.md

📝 Walkthrough

Walkthrough

The compound-name lint now exempts idiomatic EO naming patterns: names starting with as- or is-, and names ending with -of. A new eo:idiomatic() XSL function was added and integrated into the defect-selection XPath. Documentation and a test fixture were added.

Changes

Cohort / File(s)	Summary
Core Linting Logic `src/main/resources/org/eolang/lints/names/compound-name.xsl`	Added `eo:idiomatic()` XSL function to recognize `as-`, `is-` prefixes and `-of` suffix; updated XPath to require `eo:compound(`@name`)` and exclude `eo:idiomatic(`@name`)`; minor punctuation fix.
Documentation `src/main/resources/org/eolang/motives/names/compound-name.md`	Documented exceptions to the single-word rule for idiomatic `as-`, `is-`, and `-of` patterns with examples.
Test Coverage `src/test/resources/org/eolang/lints/packs/single/compound-name/allows-idiomatic-prefixes-and-suffixes.yaml`	New YAML test verifying no warning-level defects for idiomatic compound names (e.g., `as-bytes`, `is-empty`, `slice-of`).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

feat(#565): warning compound attribute names #582: Modifies the same compound-name.xsl stylesheet and introduced related compound-name detection logic; this PR adds an idiomatic-name exemption.

Suggested labels

core

Suggested reviewers

maxonfjvipon

Poem

🐰
Hopping through the files I see,
as- and is- now roam free.
-of joins the friendly crew,
No more false warnings—hip hop, woo! 🥕

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Improve compound name linting and idiomatic checks' directly matches the main change: adding idiomatic name exemptions to compound-name linting to prevent false warnings.
Linked Issues check	✅ Passed	The PR implements all coding requirements from issue `#806`: added eo:idiomatic() function recognizing as-, is- prefixes and -of suffix patterns, updated XPath to exclude idiomatic names, and included test coverage for these patterns.
Out of Scope Changes check	✅ Passed	All changes are in-scope: updated linting XSL, documented idiomatic patterns, and added test coverage. No unrelated changes detected outside the stated objectives of improving compound-name linting.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch 806

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-03-24T01:02:43Z

src/main/resources/org/eolang/motives/names/compound-name.md


+There are two exceptions for idiomatic prefixes used in EO standard library:
+the `as-` prefix for type conversions (such as `as-bytes`, `as-i64`, `as-number`)
+and the `is-` prefix for boolean predicates (such as `is-empty`, `is-nan`, `is-finite`).


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'boolean'?

Copilot

Pull request overview

Updates the compound-name lint rule to allow idiomatic as- and is- prefixed names (common in EO stdlib), and documents/tests this exception.

Changes:

Added an XSL exception for names starting with as- and is- in the compound-name lint.
Added documentation describing the idiomatic prefix exceptions.
Added a YAML regression test ensuring these idiomatic names do not trigger warnings.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
src/test/resources/org/eolang/lints/packs/single/compound-name/allows-idiomatic-as-and-is-prefixes.yaml	Adds a test case asserting no warnings for `as-` / `is-` names.
src/main/resources/org/eolang/motives/names/compound-name.md	Documents the new idiomatic exceptions for compound names.
src/main/resources/org/eolang/lints/names/compound-name.xsl	Implements the idiomatic-prefix exemption in the lint rule.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-24T01:05:34Z

src/main/resources/org/eolang/lints/names/compound-name.xsl

+  <xsl:function name="eo:idiomatic" as="xs:boolean">
+    <xsl:param name="name"/>
+    <xsl:sequence select="starts-with($name, 'as-') or starts-with($name, 'is-')"/>
+  </xsl:function>
  <xsl:template match="/">
    <defects>
-      <xsl:for-each select="//o[@base and @name and not(eo:special(@name)) and eo:compound(@name)]">
+      <xsl:for-each select="//o[@base and @name and not(eo:special(@name)) and eo:compound(@name) and not(eo:idiomatic(@name))]">


The exemption is currently overly broad: any compound name starting with as- or is- bypasses the lint (e.g., as-very-long-compound-name), which undermines the rule and makes it easy to evade. Consider tightening eo:idiomatic($name) to only allow the intended idiomatic form (e.g., a single hyphen with a simple suffix via a regex like ^(as|is)-[a-z0-9]+$, or another clearly bounded pattern consistent with EO stdlib naming).

Copilot · 2026-03-24T01:05:35Z

...rces/org/eolang/lints/packs/single/compound-name/allows-idiomatic-prefixes-and-suffixes.yaml

+sheets:
+  - /org/eolang/lints/names/compound-name.xsl
+asserts:
+  - /defects[count(defect[@severity='warning'])=0]


This assertion only guarantees there are no warning defects; the test could still pass if the lint emits defects with a different severity (e.g., error). If the intent is to ensure no defects at all for these names, consider asserting count(defect)=0 (or explicitly covering all severities expected in this lint pack) to make the regression test more robust.

Suggested change

- /defects[count(defect[@severity='warning'])=0]

- /defects[count(defect)=0]

github-actions · 2026-03-29T10:01:50Z

src/main/resources/org/eolang/motives/names/compound-name.md

    read file
 ```
+
+There are exceptions for idiomatic prefixes and suffixes used in EO standard library:


📝 [vale] _{reported by reviewdog 🐶}
[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).

0crat · 2026-03-29T22:02:54Z

@yegor256 Great work on your contribution! 🎉 You've earned +4 points (+16 base, -8 for missing code review, -4 for 35 hits-of-code). Your running score is now +39! Please keep the momentum going and don't forget to check your Zerocracy account.

#806: Improve compound name linting and idiomatic checks.

d2b0284

Copilot AI review requested due to automatic review settings March 24, 2026 00:59

github-actions bot reviewed Mar 24, 2026

View reviewed changes

Copilot AI reviewed Mar 24, 2026

View reviewed changes

Copilot started reviewing on behalf of yegor256 March 24, 2026 01:07 View session

yegor256 added 4 commits March 24, 2026 04:15

#806: Refactor compound-name.md for clarity and consistency

15834b9

Merge branch 'master' into 806

df46a54

Merge branch 'master' into 806

2e868c8

#806: Refactor idiomatic prefixes and suffixes in EO standard library.

9cf073b

github-actions bot reviewed Mar 29, 2026

View reviewed changes

yegor256 added 2 commits March 29, 2026 13:03

#806: Refactor idiomatic prefixes and suffixes in compound-name.md.

d6981d9

Merge branch 'master' into 806

dfe116a

yegor256 merged commit d59cc9e into master Mar 29, 2026
22 checks passed

yegor256 deleted the 806 branch March 29, 2026 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve compound name linting and idiomatic checks#809

Improve compound name linting and idiomatic checks#809
yegor256 merged 7 commits intomasterfrom
806

yegor256 commented Mar 24, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 24, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

github-actions bot Mar 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

github-actions bot Mar 29, 2026

Uh oh!

Uh oh!

0crat commented Mar 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- /defects[count(defect[@severity='warning'])=0]
	- /defects[count(defect)=0]

Conversation

yegor256 commented Mar 24, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

github-actions bot Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

0crat commented Mar 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yegor256 commented Mar 24, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 24, 2026 •

edited

Loading