default.fclint.json

{
    "_patterns": {
        "hasBooleanPrefix": "^(is|has|show|hide)",
        "endsWithDateTime": "([Dd]ate|[Tt]ime)$",
        "endsWithImage": "[Ii]m(age|g)$",
        "endsWithNavigationMenu": "([Nn]av(igation)?|[Mm]enu)$",
        "endsWithUriUrlLink": "([Uu]r[il]|[Ll]ink)$",
        "kebabCase": "^([a-z0-9]+-)*[a-z0-9]*$",
        "lowerCamelCase": "^[a-z][a-zA-Z0-9]*$",
        "noNumbers": "^[^0-9]$",
        "noNumberSuffix": "[^0-9]+$",
        "snakeCase": "^([a-z0-9]+_)*[a-z0-9]*$"
    },
    "files": {
        "ignorePatterns": []
    },
    "component": {
        "requireFixtureFile": {
            "check": false,
            "severity": "major"
        },
        "requireStrictComponentStructure": {
            "check": true,
            "severity": "blocker"
        },
        "requireDocumentation": {
            "check": false,
            "severity": "major"
        },
        "requireDocumentationWithFixtureFile": {
            "check": true,
            "severity": "major"
        }
    },
    "params": {
        "count": {
            "max": 20,
            "min": 0,
            "severity": "major"
        },
        "extraNamingConventionsPerType": {
            "boolean": {
                "typeValue": "boolean",
                "namingConventions": ["hasBooleanPrefix"],
                "severity": "minor"
            }
        },
        "generalNamingConventions": {
            "namingConventions": ["lowerCamelCase", "noNumberSuffix"],
            "severity": "major"
        },
        "nameLength": {
            "min": 3,
            "max": 40,
            "allowed": ["id"],
            "denied": ["data", "row", "result", "results", "resultset"],
            "severity": "major"
        },
        "requireDescription": {
            "check": false,
            "severity": "minor"
        },
        "requireDescriptionForType": {
            "array": {
                "typeValue": "array",
                "requireDescription": true,
                "severity": "minor"
            },
            "object": {
                "typeValue": "object",
                "requireDescription": true,
                "severity": "minor"
            }
        },
        "requireNamespaceWithoutLeadingSlash": {
            "check": true,
            "severity": "info"
        },
        "typeHints": {
            "endsWithDateTime": {
                "namePattern": "endsWithDateTime",
                "typeHint": "SMS\\FluidComponents\\Domain\\Model\\DateTime",
                "message": "It is recommended to use %s for date and time values",
                "severity": "info"
            },
            "endsWithImage": {
                "namePattern": "endsWithImage",
                "typeHint": "Image",
                "message": "It is recommended to use %s for images",
                "severity": "info"
            },
            "endsWithNavigationMenu": {
                "namePattern": "endsWithNavigationMenu",
                "typeHint": "Navigation",
                "message": "It is recommended to use %s for navigations",
                "severity": "info"
            },
            "endsWithUriUrlLink": {
                "namePattern": "endsWithUriUrlLink",
                "typeHint": "Typolink",
                "message": "It is recommended to use %s for urls",
                "severity": "info"
            },
            "hasBooleanPrefix": {
                "namePattern": "hasBooleanPrefix",
                "typeHint": "boolean",
                "message": "Based on its name, the parameter looks like a boolean",
                "severity": "info"
            }
        },
        "typeAlternatives": {
            "array": {
                "typeValue": "array",
                "message": "It is recommended to use data structures or scalar types in combination with \"[]\" instead of generic \"%2$s\"",
                "severity": "info"
            },
            "bool": {
                "typeValue": "bool",
                "typeAlternative": "boolean",
                "message": "It is recommended to use %1$s instead of %2$s",
                "severity": "info"
            },
            "DateTime": {
                "typeValue": "DateTime",
                "typeAlternative": "SMS\\FluidComponents\\Domain\\Model\\DateTime",
                "message": "You should use %1$s instead of %2$s",
                "severity": "minor"
            },
            "int": {
                "typeValue": "int",
                "typeAlternative": "integer",
                "message": "It is recommended to use %1$s instead of %2$s",
                "severity": "info"
            },
            "object": {
                "typeValue": "object",
                "message": "It is recommended to use specific data structures instead of generic \"%2$s\"",
                "severity": "info"
            }
        }
    },
    "renderer": {
        "requireClass": {
            "check": true,
            "severity": "minor"
        },
        "requireComponentPrefixer": {
            "check": true,
            "severity": "minor"
        },
        "requireRawContent": {
            "check": true,
            "severity": "minor"
        },
        "viewHelperRestrictions": {
            "f:base": {
                "viewHelperName": "f:base",
                "message": "The base tag (<%s>) must not be used within components",
                "severity": "major"
            },
            "f:be.*": {
                "viewHelperName": "f:be.",
                "message": "The backend ViewHelpers (<%s>) should not be used within components",
                "severity": "minor"
            },
            "f:cache.*": {
                "viewHelperName": "f:cache.",
                "message": "The caching ViewHelpers (<%s>) should not be used within components",
                "severity": "minor"
            },
            "f:cObject": {
                "viewHelperName": "f:cObject",
                "message": "TypoScript content must be passed as a component parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:debug": {
                "viewHelperName": "f:debug",
                "message": "<%s> may be used in components, but should not be used in production",
                "severity": "info"
            },
            "f:flashMessages": {
                "viewHelperName": "f:flashMessages",
                "message": "Flash messages must be passed as a component parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:form": {
                "viewHelperName": "f:form",
                "message": "Form ViewHelpers (<%s>) may be used deliberately within components",
                "severity": "info"
            },
            "f:form.*": {
                "viewHelperName": "f:form.",
                "message": "Form ViewHelpers (<%s>) may be used deliberately within components",
                "severity": "info"
            },
            "f:format.html": {
                "viewHelperName": "f:format.html",
                "message": "<%1$s> must be used outside of the component, <f:format.raw> may be used within component to render HTML previously passed through <%1$s>",
                "severity": "major"
            },
            "f:image": {
                "viewHelperName": "f:image",
                "message": "<%s> should be used deliberately within components (e. g. only in Atom.Image)",
                "severity": "minor"
            },
            "f:inline": {
                "viewHelperName": "f:inline",
                "message": "Inline fluid code (<%s>) may be used deliberately within components",
                "severity": "info"
            },
            "f:layout": {
                "viewHelperName": "f:layout",
                "message": "Layouts (<%s>) are currently not supported within components and thus must not be used",
                "severity": "major"
            },
            "f:link.*": {
                "viewHelperName": "f:link.",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:media": {
                "viewHelperName": "f:media",
                "message": "<%s> should be used deliberately within components (e. g. only in Atom.Media)",
                "severity": "minor"
            },
            "f:render": {
                "viewHelperName": "f:render",
                "message": "Rendering sections or partials (<%s>) is currently not supported within components and thus must not be used",
                "severity": "major"
            },
            "f:renderChildren": {
                "viewHelperName": "f:renderChildren",
                "message": "Widgets should be part of integration: <%s>",
                "severity": "minor"
            },
            "f:section": {
                "viewHelperName": "f:section",
                "message": "Sections (<%s>) are currently not supported within components and thus must not be used",
                "severity": "major"
            },
            "f:security.*": {
                "viewHelperName": "f:security.",
                "message": "Frontend user logic must happen outside of components and then passed as a parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:translate": {
                "viewHelperName": "f:translate",
                "message": "<%s> may be used within components, try to pass translations via component parameters instead",
                "severity": "info"
            },
            "f:uri.action": {
                "viewHelperName": "f:uri.action",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:uri.email": {
                "viewHelperName": "f:uri.email",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:uri.external": {
                "viewHelperName": "f:uri.external",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:uri.page": {
                "viewHelperName": "f:uri.page",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:uri.typolink": {
                "viewHelperName": "f:uri.typolink",
                "message": "URIs must be generated outside of components and then passed as TypoLink parameter instead of using a ViewHelper: <%s>",
                "severity": "major"
            },
            "f:uri.image": {
                "viewHelperName": "f:uri.image",
                "message": "<%s> should be used deliberately within components (e. g. only in Atom.Image)",
                "severity": "minor"
            },
            "f:widget.*": {
                "viewHelperName": "f:widget.",
                "message": "Widgets should be part of integration: <%s>",
                "severity": "minor"
            }
        }
    }
}