Skip to content

Coala #28

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Coala #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91c1d24
added .coalfile
darthgera123 Jun 26, 2018
8164c22
update .coafile
darthgera123 Jun 26, 2018
02066e5
basic documentation added
darthgera123 Jun 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .coafile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Generated by coala-quickstart on 27 Jun 2018.
[all]
bears = coalaBear, FilenameBear, LineCountBear, InvalidLinkBear
files = **.py, **.md
max_lines_per_file = 100
[all.python]
bears = DocGrammarBear, PycodestyleBear, DocumentationStyleBear
files = **.py
language = all.python
[all.markdown]
bears = TextLintBear, MarkdownBear
files = **.md
29 changes: 29 additions & 0 deletions coala_use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#Coala

This is a guide on how to use coala-bears for this project

This project consists of a .coafile which basically has all the guidelines
Copy link
Contributor

Choose a reason for hiding this comment

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

.coafile should be in codespace like .coafile

Copy link
Author

Choose a reason for hiding this comment

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

.coafile is there in the codespace. This is just the documentation

that needs to be followed when working with coala.It can modified.
Copy link
Contributor

Choose a reason for hiding this comment

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

missing a space, "coala. It can..."

Copy link
Contributor

Choose a reason for hiding this comment

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

And it should it with working with coala or working with wtfpython-web?


In order to specify the files to analyze, you can use the --files argument.
Copy link
Contributor

Choose a reason for hiding this comment

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

code highlight --files

Copy link
Contributor

Choose a reason for hiding this comment

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

btw we don't need --files argument

Copy link
Contributor

Choose a reason for hiding this comment

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

you just need to run coala, and since .coafile is already present, settings would be supplied from there.

So instead of this section, you should add instructions to install coala using pip, and use it inside the project directory!

Copy link
Author

Choose a reason for hiding this comment

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

okay will do

For all file paths, you can specify (recursive) globs.

`coala --files=src/\*.c --bears=SpaceConsistencyBear --save`

Coala will now ask you for missing values that are needed to perform the analysis.
Coala will now check the code and, in case there are errors it will be duly pointed out.
You can also run coala in non interactive mode
`coala --non-interactive`

###Auto-applying results
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of asking user to supply the flags, you can add default_actions in the .coafile.

Example: https://github.com/coala/coala-quickstart/blob/master/.coafile#L25

So adding this default section to the all section should do the job for us!

Coala includes a special setting called default_actions that allows you to set the
Copy link
Contributor

Choose a reason for hiding this comment

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

All this would no longer be needed one we add default action. We just need the instructions to install and run coala, that's all.

All the other changes should be made to .coafile which the other developers on wtfpython-web need not to worry about.

action for a bear that shall be automatically applied on run. It has a command line
alias --apply-patches to make it easier to use.
For eg
`coala -S python.bears=PEP8Bear python.files=\*\*/\*.py --apply-patches --save`
This command would automatically fix all your issues in python files.

###Help
To know more about Coala you could do the following
`coala -h`
To follow the documentation follow the [link](https://docs.coala.io/en/latest/Users/Tutorial.html)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy