-
Notifications
You must be signed in to change notification settings - Fork 16
Improve compound name linting and idiomatic checks #809
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.
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
+33
−2
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d2b0284
#806: Improve compound name linting and idiomatic checks.
yegor256 15834b9
#806: Refactor compound-name.md for clarity and consistency
yegor256 df46a54
Merge branch 'master' into 806
yegor256 2e868c8
Merge branch 'master' into 806
yegor256 9cf073b
#806: Refactor idiomatic prefixes and suffixes in EO standard library.
yegor256 d6981d9
#806: Refactor idiomatic prefixes and suffixes in compound-name.md.
yegor256 dfe116a
Merge branch 'master' into 806
yegor256 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,10 @@ All objects that are not formations must have single-word names. | |
| Compound names indicate that the program context is too large | ||
| and needs to be decomposed. | ||
|
|
||
| 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`). | ||
|
||
|
|
||
| Incorrect: | ||
|
|
||
| ```eo | ||
|
|
||
14 changes: 14 additions & 0 deletions
14
...rces/org/eolang/lints/packs/single/compound-name/allows-idiomatic-as-and-is-prefixes.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2016-2026 Objectionary.com | ||
| # SPDX-License-Identifier: MIT | ||
| --- | ||
| sheets: | ||
| - /org/eolang/lints/names/compound-name.xsl | ||
| asserts: | ||
| - /defects[count(defect[@severity='warning'])=0] | ||
| input: | | ||
| # No comments. | ||
| [] > main | ||
| x.as-bytes > as-bytes | ||
| y.as-i64 > as-i64 | ||
| z.is-empty > is-empty | ||
| w.is-nan > is-nan |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The exemption is currently overly broad: any compound name starting with
as-oris-bypasses the lint (e.g.,as-very-long-compound-name), which undermines the rule and makes it easy to evade. Consider tighteningeo: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).