|
9 | 9 | ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
|
10 | 10 | ```
|
11 | 11 |
|
12 |
| -[Practicalli books](https://practical.li/#books) use the configuration extensively to develop Clojure projects. |
13 |
| - |
14 | 12 | [Practicalli Clojure CLI Config](https://github.com/practicalli/clojure-cli-config/) contains a `deps.edn` alias definitions for a wide range of community libraries and tools to that extend the features of Clojure CLI.
|
15 | 13 |
|
16 |
| -The configuration also contains |
| 14 | +Aliases are qualified keywords using descriptive names to clearly convey purpose and provide a level of consistency to minimise cognitive load. |
| 15 | + |
| 16 | +Common arguments are included in alias definitions via `main-opts` and `:exec-args` to provide a default behaviour and simplify the use aliases. |
| 17 | + |
| 18 | +Alias used with the `-A`, `-M`, `-T` or `-X` execution options |
| 19 | + |
| 20 | +Aliases are defined to be used with all execution options `-A`, `-M`, `-P`, `-T` or `-X` where possible, otherwise use the following execution options: |
| 21 | + |
| 22 | +- `-M` for `:main-opts` configuration |
| 23 | +- `-X` for `:exec-opts` configuration |
| 24 | +- `-T` for `:exec-opts`, ignoring project dependencies |
| 25 | + |
| 26 | +> [Clojure CLI - Which execution options to use](https://practical.li/clojure/clojure-cli/execution-options/) |
| 27 | +
|
| 28 | +The project also contains |
17 | 29 |
|
18 | 30 | * GitHub workflow that runs MegaLinter and Code Quality checks (clj-kondo and cljstyle via the setup-clojure action)
|
19 | 31 | * cljstyle configuration that follows the Clojure Style Guide
|
20 | 32 | * Rebel Readline example configuration (supports the Rich Terminal UI used by Practicalli)
|
21 | 33 | * cspell configuration for linting markdown and other text
|
22 |
| -* `deps-deprecated.edn` containing alias examples of tools not used by Practialli, but may be of interest |
| 34 | +* `deps-deprecated.edn` containing alias examples of tools not currently used by Practialli which may still be of interest to the wider community |
23 | 35 |
|
| 36 | +[Practicalli books](https://practical.li/#books) uses the Clojure CLI Config extensively to support a [REPL Reloaded workflow](https://practical.li/clojure/clojure-cli/repl-reloaded/) for Clojure projects. |
24 | 37 |
|
25 | 38 | [Practicalli Clojure book discusses Clojure CLI and its use](https://practical.li/clojure/clojure-cli/repl/), along with video walk-through of the key features.
|
26 | 39 |
|
27 |
| -Aliases use qualified descriptive names to avoid clashes with project specific aliases, ensuring that the user wide aliases remain available in all projects. |
28 |
| - |
29 |
| -Common default arguments are included in an alias via `:exec-args` to minimise the cognitive load required to use aliases. |
30 |
| - |
31 |
| -Aliases are used with the `-A`, `-M`, `-T` or `-X` execution options |
32 |
| - |
33 |
| -> [Clojure CLI - Which execution options to use](https://practical.li/clojure/clojure-cli/execution-options/) |
34 |
| -
|
35 | 40 |
|
36 | 41 | [](http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1)
|
37 | 42 | [](https://github.com/sponsors/practicalli-john)
|
|
0 commit comments