Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

Add .coafile #102

Merged
merged 5 commits into from
Jun 23, 2016
Merged

Add .coafile #102

merged 5 commits into from
Jun 23, 2016

Conversation

SanketDG
Copy link
Contributor

@SanketDG SanketDG commented May 27, 2016

coala (http://coala-analyzer.org/) is a language independent
static analysis tool that can provide patches to source code
errors. This file implements common settings for coala.

A dev-requirements.txt file is added that contains the latest
stable version of coala.

The first step would be to install coala:

$ pip install -r dev-requirements.txt

So coala uses this .coafile to decide which routines (aka bears) to run. Just running:

$ coala

would do everything your white_space.py currently does! 😄

Along with that I have added a few sections that you can run using:

$ coala <section_name>

The sections are:

pylint: Checks the whole codebase against pylint
invalidlinks: Checks docs for invalid links.
imports: Sorts imports! This is pretty trivial, but you may want to take a look.

If you need any help in this or want to learn more about the project, feel free to ping us at https://gitter.im/coala-analyzer/coala.

@sils
Copy link

sils commented May 27, 2016

@SanketDG they already seem to have https://github.com/pydsa/pydsa/blob/master/white_space.py which this would replace, right?

@aktech
Copy link
Member

aktech commented May 29, 2016

@SanketDG Thanks for the PR.
How about using requirements.txt instead of dev-requirements.txt ?

@SanketDG
Copy link
Contributor Author

SanketDG commented May 29, 2016

@aktech sure I have updated the PR. Also:

  • Would you like to remove white_space.py? Since coala now does all of its work.
  • autopep8 shouldn't be in the dependencies IMHO, It should be in a "requirements" file. But since coala uses autopep8 to fix python code, it is not needed and hence can be removed.

Let me know what you think.

@aktech
Copy link
Member

aktech commented Jun 5, 2016

Sorry for the late reply.

Would you like to remove white_space.py? Since coala now does all of its work.

Yes, sure.

autopep8 shouldn't be in the dependencies IMHO, It should be in a "requirements" file. But since coala uses autopep8 to fix python code, it is not needed and hence can be removed.

Go ahead.

coala (http://coala-analyzer.org/) is a language independent
static analysis tool that can provide patches to source code
errors. This file implements common settings for coala.

A requirements.txt file is added that contains the latest
stable version of coala.
coala is now used for conforming to code standards,
so this custom solution can be removed.
autopep8 will be no longer required
@SanketDG
Copy link
Contributor Author

SanketDG commented Jun 5, 2016

@aktech cool! PR's updated, let me know if you need any changes.

@aktech
Copy link
Member

aktech commented Jun 16, 2016

PR's updated, let me know if you need any changes.

Great! Can you also add some basic usage instructions on the README.md file?

@SanketDG
Copy link
Contributor Author

@aktech Done 😄

I have also added py.test to the list of requirements and accordingly updated the README.

@aktech
Copy link
Member

aktech commented Jun 23, 2016

@SanketDG Thanks for the PR. Merging. 👍

@aktech aktech merged commit 0916b02 into pydsa:master Jun 23, 2016
@SanketDG SanketDG deleted the coala! branch June 23, 2016 23:33
@SanketDG
Copy link
Contributor Author

@aktech 👍 😄

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.

3 participants