Analysis Details

Adhere to generally accepted naming conventions

es.uniovi.reflection.analyses.bloch.8.56.2

This rule detects packages that start with 'java' or 'javax' reserved names, have no hierarchical structure with component names separated by '.', or do not follow the lowercase convention. It also detects when the default package contains any type declaration.

Computational Reflection Research Group

12-03-2025 17:14

Program Understandability

Package Node

MATCH (packageOrModule:PACKAGE_NODE{isUserCode:TRUE})
WITH packageOrModule, CASE WHEN packageOrModule:PACKAGE THEN 'PACKAGE' ELSE 'MODULE' END + ' ' + packageOrModule.name as desc, split(packageOrModule.name, '.') as components
WITH CASE WHEN packageOrModule.name = "" THEN 'The default packageOrModule must not be used.' ELSE CASE WHEN NOT packageOrModule.name CONTAINS '.' THEN 'Packages and modules must start with the organization name, and then separate its distinct components with . in a hierarchical way.' ELSE CASE WHEN components[0] IN ["java", "javax"] THEN 'Packages and modules must never start with java or javax special names.' ELSE CASE WHEN ANY(compName IN components WHERE NOT compName =~ '^[a-z0-9]+$' ) THEN 'Package and module components must be written using only lowercase caracters and digits.' ELSE NULL END END END + ' ' + desc + ' does not follow this convention.' END as message, desc
WHERE message IS NOT NULL
RETURN '{"node":"'+desc+'","rule":"BLOCH-8.56.2","location":"'+desc+'","message":"'+message+'"}'