Skip to content
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.

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

Discuss: Code quality checks #7

Open
2 of 6 tasks
Sebobo opened this issue Feb 25, 2020 · 1 comment
Open
2 of 6 tasks

Discuss: Code quality checks #7

Sebobo opened this issue Feb 25, 2020 · 1 comment

Comments

@Sebobo
Copy link
Collaborator

Sebobo commented Feb 25, 2020

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

@Sebobo
Copy link
Collaborator Author

Sebobo commented Mar 26, 2021

@cvette can you move this to the other repo?

@cvette cvette transferred this issue from cvette/neos-fusion-parser Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant