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

Include / improve code style checks #83

Open
AFaust opened this issue May 13, 2017 · 1 comment
Open

Include / improve code style checks #83

AFaust opened this issue May 13, 2017 · 1 comment

Comments

@AFaust
Copy link
Contributor

AFaust commented May 13, 2017

FEATURE / ENHANCEMENT

We already have some base conventions in our project documentation and also some tooling in our build process that checks for conventions in our JS files. Still, in the recent PR #81 we encountered various minor issues that may trick people up. We should strive to improve this situation and check the following options:

  • including IDE-specific formating configuration in the project(s)
  • check current jshint configuration for style consistency between front-end and back-end (I think I may have given front-end some leeway when migrating features from Alfresco Support Tools to avoid being blocked on legacy code issues)
  • include Maven validation plugin(s) for Java / JavaScript code style, copyright header presence and generic text file validations (e.g. properly encoded characters in I18n files, use of UTF-8 encoding in source files etc
@binduwavell
Copy link
Contributor

I'm a fan of using http://editorconfig.org/ for common format specification within a project. Most IDEs including IntelliJ and Eclipse have plugins that will configure the IDE to handle the project specific requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants