@@ -8,10 +8,6 @@ By default, Compas will watch your package.json files and determine if it needs
88to reinstall your dependencies. This way your local environment always matches
99the required dependency versions.
1010
11- Other actions, like automatically spinning up development dependencies in Docker
12- need to be configured explicitly. See the respective integrations for how this
13- works.
14-
1511## Configuration
1612
1713Compas is configurable via a JSON file at ` config/compas.json ` . An empty config
@@ -36,4 +32,29 @@ and return back to the menu. When a process is running, you can restart it with
3632'R' or kill the running process by pressing 'K'.
3733
3834The configuration file is automatically reloaded on changes, assuming that the
39- syntax is correct.
35+ syntax is correct. Allowing you to iterate on it and expand your
36+ [ workspace] ( /docs/workspaces.html ) .
37+
38+ ## Inferred actions
39+
40+ Compas tries to give you a good experience without any configuration. This is
41+ why Compas automatically infers some standard actions based on your project
42+ setup.
43+
44+ These inferred actions are only added when no action with the same or similar
45+ name is defined. For example, 'Lint' is only added if both 'Lint' and 'Format'
46+ are not configured.
47+
48+ - 'Dev' is automatically populated from the package.json scripts.
49+ - 'Lint' defaults to the 'format' script defined in your package.json OR the
50+ 'lint' script defined in your package.json OR to ` compas lint ` if the
51+ ` @compas/cli ` package is installed.
52+ - 'Test' is based on the 'test' script in your package.json OR to ` compas test `
53+ if the ` @compas/cli ` package is installed.
54+
55+ ## Other integrations
56+
57+ Compas supports much more. Like automatically starting Docker containers for
58+ services that your development environment needs, or running the code generators
59+ automatically on changes (not yet implemented). For more information, checkout
60+ the [ integrations] ( /docs/integrations/docker.md ) .
0 commit comments