From 91c1d24f0eb5c93e397f7789b49715846668cbac Mon Sep 17 00:00:00 2001 From: Pulkit gera Date: Wed, 27 Jun 2018 03:41:11 +0530 Subject: [PATCH 1/3] added .coalfile --- .coafile | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .coafile diff --git a/.coafile b/.coafile new file mode 100644 index 0000000..cf7a6e0 --- /dev/null +++ b/.coafile @@ -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 = 80 +[all.python] +bears = DocGrammarBear, PycodestyleBear, DocumentationStyleBear +files = **.py +language = all.python +[all.markdown] +bears = TextLintBear, MarkdownBear +files = **.md From 8164c22c7d16c2a1051b6f7b9a6df46444a09f30 Mon Sep 17 00:00:00 2001 From: Pulkit gera Date: Wed, 27 Jun 2018 03:42:13 +0530 Subject: [PATCH 2/3] update .coafile --- .coafile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.coafile b/.coafile index cf7a6e0..b573a8f 100644 --- a/.coafile +++ b/.coafile @@ -2,7 +2,7 @@ [all] bears = coalaBear, FilenameBear, LineCountBear, InvalidLinkBear files = **.py, **.md -max_lines_per_file = 80 +max_lines_per_file = 100 [all.python] bears = DocGrammarBear, PycodestyleBear, DocumentationStyleBear files = **.py From 02066e57c8bc83e416aed8e61e083318198d7703 Mon Sep 17 00:00:00 2001 From: Pulkit gera Date: Sat, 30 Jun 2018 00:22:04 +0530 Subject: [PATCH 3/3] basic documentation added --- coala_use.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 coala_use.md diff --git a/coala_use.md b/coala_use.md new file mode 100644 index 0000000..5ece04a --- /dev/null +++ b/coala_use.md @@ -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 +that needs to be followed when working with coala.It can modified. + +In order to specify the files to analyze, you can use the --files argument. +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 +Coala includes a special setting called default_actions that allows you to set the +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) \ No newline at end of file