Skip to content

Discuss: Code quality checks #7

@Sebobo

Description

@Sebobo

When running projects in a team (or alone) it's helpful to have a common standard.
This standard should mirror the best practices pushed by the Neos community and the core team.
See https://docs.neos.io/cms/manual/best-practices for details.

The following topics usually come up:

  • Warn or enforce a directory structure for presentational & integration components
  • Warn or enforce naming of prototypes to match folder structure
  • Warn when a prototype name doesn't match best practices (list should be configurable)
  • Enforce ONE prototype per file
  • Warn when a prototype inherits from ContentComponent or Content, but is not a NodeType (this would of course also require checks for NodeTypes which might be a use case for a plugin system)
  • Warn with code style issues like spacing, indentation, empty lines, etc...

TBC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions