-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Implement coala-ci #4781
Implement coala-ci #4781
Conversation
This Pull Request is being done as part of the Google Code-In task https://github.com/coala/coala/wiki/Google-Code-In-Task-Implement-coala . The mentors are : @jayvdb , @sils |
This is the official source code for the [Processing][processing site] Development Environment (PDE) | ||
, the “core” and the libraries that are included with the [download][processing download]. | ||
|
||
**I've found a bug!** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yukiisbored their standard seems to use __
for bold text, not **
, I'd recommend to configure markdownbear to their preferences. (Also applies for headings and probably more.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
core/README.md
is different though. So, I made it the same for consistency of both README files.
[java] | ||
bears = CheckstyleBear | ||
files = core/src/**.java, app/src/**.java, java/src/**.java | ||
checkstyle_configs = .checkstyle.xml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it wasn't possible to do it with the coala given settings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sils Yeah, ChecktyleBear can't be configured to match the current source and they require a huge change to the source
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean CheckstyleBear?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry, I accidentally thought I was using PMDBear, I also added it to match the source style. Since, this project has a style guide.
services: docker | ||
script: > | ||
docker run --volume=$(pwd):/app --workdir=/app coala/base:pre | ||
coala -m NORMAL -C |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe instead of m and C use the long forms for readability here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, fixed it on 10972a3
c2ad5c0
to
10972a3
Compare
|
||
[markdown] | ||
bears = MarkdownBear, LineLengthBear, SpaceConsistencyBear | ||
files = README.md, core/README.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wouldn't it be simpler to use **.md
and define the ignore
properly in the default
section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, fixed it on 15dee8e
Add linters for java source files, Ant build scripts, README files, and the configuration files for linters.
10972a3
to
15dee8e
Compare
Please add a link to your travis build of this commit, so the maintainers can see what it will look like when green. |
Here's the link for the Travis-CI build of 15dee8e: https://travis-ci.org/yukiisbored/processing/builds/185449799 |
Some context here? What's this about? |
@benfry this is a configuration file for the project https://github.com/coala/coala which is a tool for linting and fixing code to detect inconsistencies, you can consider adding coala to your CI to detect inconsistencies in future commits. This config file is customised according to your project and is done as a part of a Google-Code-In task https://github.com/coala/coala/wiki/Google-Code-In-Task-Implement-coala ping yuki if you are interested in this, so that he can update this to the current code style of your project if there were major changes since the date the PR was made. |
@benfry last summer we used coala for Processing.R for pre-commit code linting, and as checkers go it was a fairly pleasant experience. Here was the setup Ce Gao developed (points to XML file for Java Checkbear): https://github.com/processing-r/Processing.R/blob/f3a0927367ea74fb40ec71f0c102f026eeafb6a9/.coafile |
Hi @benfry, This PR was a part of a Google Code-in 2016 task for the coala organization (when it was under the FOSSASIA umbrella). Basically, coala is a common interface to utilize various linting utilities and making it easy to configure and use a bunch of linters. If you want it to be part of processing now, Feel free to message me so I can allocate some time in the future to update it. Sorry for not replying sooner, I was busy with stuff irl. |
Resolved with Travis CI via benfry/processing4#1 and continued development happening at https://github.com/processing/processing4 |
Add linters for java source files, Ant build scripts, README files,
and the configuration files for linters.