Skip to content

Commit 682c13d

Browse files
committed
coafile.rst: Add aspects section
Relates to coala/coala#4665
1 parent deeba14 commit 682c13d

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

Users/coafile.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,31 @@ Instead, make the inheritance explicit::
107107
# setting1 is inherited
108108
setting2 = 2
109109

110+
Defining Aspects and Tastes
111+
---------------------------
112+
113+
Aspects is an alternative way to configure coala. In this mode, we don't need
114+
to explicitly state list of bears, coala will choose it automatically based on
115+
requested aspects in coafile. To run coala in this mode, we need to define
116+
`aspects`, `files`, `languages`, and optionally aspect tastes setting. See
117+
the following example::
118+
119+
[all]
120+
files = **
121+
aspects = aspectname1, AspectName2 # case-insensitive
122+
# defining an aspect's taste
123+
aspectname1:aspect_taste = 80
124+
# we can define subaspect taste through its parent
125+
aspectname1:subaspect_taste = word1, word2, word3
126+
127+
[all.python]
128+
files = **.py
129+
language = Python
130+
# appending additional aspect
131+
aspects += aspectname3
132+
# excluding certain subaspect
133+
excludes = AspectName2Subaspect
134+
110135
Comments, Escaping and Multiline Values and Keys
111136
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112137

0 commit comments

Comments
 (0)