Skip to content

fix: support basePath with dots #25

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

Merged
merged 5 commits into from
May 19, 2025
Merged

fix: support basePath with dots #25

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5408ab
fix: support basePath with dots
Feb 26, 2025
0996134
fix: custom regex to kebab case on rule oar011
May 16, 2025
dafa8d3
fix: resolving v2 and v3 test
May 17, 2025
6809e99
Merge branch 'master' into fix/22/url_name_convention
adrian-palanques-cloudappi May 19, 2025
ffe0793
chore: format
adrian-palanques-cloudappi May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/main/java/apiaddicts/sonar/openapi/checks/format/OAR011UrlNamingConventionCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.google.common.collect.ImmutableSet;
import com.sonar.sslr.api.AstNodeType;

import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
Expand All @@ -20,7 +21,8 @@ public class OAR011UrlNamingConventionCheck extends AbstractNamingConventionChec
private static final String MESSAGE = "OAR011.error";

private static final String NAMING_CONVENTION = KEBAB_CASE;

private static final String KEBAB_SEGMENT ="^[a-z0-9-.]*$";

@RuleProperty(
key = "naming-convention",
description = "Naming convention (snake_case, kebab-case, camelCase or UpperCamelCase).",
Expand Down Expand Up @@ -84,4 +86,24 @@ private void visitPathNode(JsonNode node) {
String path = node.key().getTokenValue();
validateNamingConvention(path, node.key());
}

@Override
protected void validateNamingConvention(String name, JsonNode nameNode) {
if (nameExceptions.contains(name)) return;
if (KEBAB_CASE.equalsIgnoreCase(namingConvention)) {
if (!isKebabCaseWithDots(name)) {
addIssue(KEY, translate(MESSAGE, KEBAB_CASE), nameNode.key());
}
return;
}
super.validateNamingConvention(name, nameNode);
}

private boolean isKebabCaseWithDots(String path) {
if (path.contains("/")) {
path = path.replaceAll("\\{[^}{]*}", "");
}
String transformed = path.replace("/", "-");
return transformed.matches(KEBAB_SEGMENT);
}
}
Loading