Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-3420

Artifact ids should follow a naming convention

    XMLWordPrintable

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      Update this "artifactId" to match the provided regular expression: xxx
    • Highlighting:
      Hide

      artifactId value

      Show
      artifactId value
    • List of parameters:
      • key: regex
      • description: The regular expression the "artifactId" should match
      • default: [a-z][a-z-0-9]+
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Covered Languages:
      Java
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min
    • Analysis Scope:
      Main Sources, Test Sources

      Description

      Shared naming conventions allow teams to collaborate effectively. This rule raises an issue when a pom's artifactId does not match the provided regular expression.

      Noncompliant Code Example

      With the default regular expression: [a-z][a-z-0-9]+

      <project ...>
        <artifactId>My_Project</artifactId>  <!-- Noncompliant -->
      
        <!-- ... -->
      </project>
      

      Compliant Solution

      <project ...>
        <artifactId>my-project</artifactId>
      
        <!-- ... -->
      </project>
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              ann.campbell.2 Ann Campbell
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated: