coala / coala/coala-quickstart

Running modes in coala-quickstart

Open
#90 14 comments 0 reactions 0 assignees View on GitHub
status/STALE
Dominant language
Python
Stars
49
Forks
74
PR merge metrics
No merged PRs in 30d

Description

webServices Status

webServices doesn't support all the bears presently. It doesn't support the bears which have nonoptional settings. As a solution, what we can do is run coala-quickstart on the project and get relevant bears, by running quickstart in a ```--relevant-bears``` mode

```
relevant_bears = ["PEP8Bear", "PyLintBear", "SpaceConsistencyBear"]
```

Then ask users for the optional/non-optional settings of those bears, and send this to the backend saving it in a settings.json file.
```
bears_settings = {
"PEP8Bear" : {},
"PyLintBear" : {}.
"SpaceConsistencyBear" : { "use_spaces" : true }
}
```
Then coala-quickstart would run in ```--get-bears-settings = settings.json``` mode, and return the frontend a coafile, with bear settings.

Users will now click a "Run coala" button (or we can do that without asking user ?) and then we run coala on the project with the generated coafile, which has optional/non optional settings for bears and thus doesn't break the module.

![screen shot 2017-05-08 at 11 31 27 am](https://cloud.githubusercontent.com/assets/13018570/25792082/035c4c82-33e2-11e7-8925-74d6a1f7ccc7.png)

Essentialy, frontend will send flags to the backend which will then decide the running mode of coala-quickstart.

cc @adtac @satwikkansal Thoughts?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the coala-quickstart entry point and the proposed --relevant-bears and --get-bears-settings modes described in the issue. Trace how relevant bears and settings.json would flow into the generated coafile. Done would require an agreed design and an end-to-end path that handles bear settings without breaking unsupported bears.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.