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

Implement coala-ci #4781

Closed
wants to merge 1 commit into from
Closed

Conversation

yukiisbored
Copy link

Add linters for java source files, Ant build scripts, README files,
and the configuration files for linters.

@yukiisbored
Copy link
Author

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
In addition to normal review comments, collaborators are welcome to come and discuss the task at https://gitter.im/coala/coala .

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!**
Copy link

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.)

Copy link
Author

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
Copy link

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?

Copy link
Author

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean CheckstyleBear?

Copy link
Author

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
Copy link

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

Copy link
Author

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


[markdown]
bears = MarkdownBear, LineLengthBear, SpaceConsistencyBear
files = README.md, core/README.md
Copy link

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?

Copy link
Author

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.
@jayvdb
Copy link

jayvdb commented Dec 20, 2016

Please add a link to your travis build of this commit, so the maintainers can see what it will look like when green.

@yukiisbored
Copy link
Author

yukiisbored commented Dec 20, 2016

Here's the link for the Travis-CI build of 15dee8e: https://travis-ci.org/yukiisbored/processing/builds/185449799

@benfry
Copy link
Contributor

benfry commented Mar 26, 2018

Some context here? What's this about?

@ishanSrt
Copy link

ishanSrt commented May 11, 2018

@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.

@jeremydouglass
Copy link
Contributor

jeremydouglass commented Jun 4, 2018

@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

@yukiisbored
Copy link
Author

yukiisbored commented Jun 5, 2018

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.

@benfry
Copy link
Contributor

benfry commented Jan 17, 2020

Resolved with Travis CI via benfry/processing4#1 and continued development happening at https://github.com/processing/processing4

@benfry benfry closed this Jan 17, 2020
@processing processing locked as resolved and limited conversation to collaborators Jan 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants