Skip to content

Commit df8df4b

Browse files
readme: update common tasks table
Resolve #83
1 parent 0225320 commit df8df4b

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

CHANGELOG.org

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
** Changed
55
- health: remove FUNDING.yaml and use Practicalli Org file
66
- readme: update sponsorship link to practicalli-johnny account
7+
- readme: update common tasks table
78

89
** Updated
910
- alias: project/create latest practicalli project-template release

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -144,25 +144,23 @@ See the rest of this readme for examples of how to use each alias this configura
144144

145145
How to run common tasks for Clojure development.
146146

147-
* Built-in tasks require no additional configuration.
148-
* User aliases should be added to `~/.clojure/deps.edn`.
149-
* Project aliases should be added to the individual project `deps.edn` file (or may be part of a template).
150-
* User/Project alias can be defined in both user and project `deps.edn` files (add to project `deps.edn` for Continuous Integration)
151-
152-
| Task | Command | Configuration |
153-
|----------------------------------------------------|-----------------------------------------------------------------------------------------|---------------|
154-
| Create project (clojure exec) | `clojure -T:project/create :template practicalli/appplication :name practicalli/my-app` | Practicalli |
155-
| Run REPL (rebel readline with nrepl server) | `clojure -M:repl/rebel` | Practicalli |
156-
| Run ClojureScript REPL with nREPL (editor support) | `clojure -M:repl/cljs` | Practicalli |
157-
| Download dependencies | `clojure -P` (followed by optional aliases) | Built-in |
158-
| Find libraries (Clojars & Maven Central) | `clojure -M:search/libraries qualified-library-name(s)` | Practicalli |
159-
| Find available versions of a library | `clojure -X:deps find-versions :lib domain/library-name` | Built-in |
160-
| Resolve git coord tags to shas and update deps.edn | `clojure -X:deps git-resolve-tags git-coord-tag` | Built-in |
161-
| Generate image of project dependency graph | `clojure -T:project/graph-deps` | Practicalli |
162-
| Check library dependencies for newer versions | `clojure -T:search/outdated` | Practicalli |
163-
| Run tests / watch for changes | `clojure -X:test/run` / `clojure -X:test/watch` | Practicalli |
164-
| Run the project (clojure.main) | `clojure -M -m domain.main-namespace` | Built-in |
165-
| Deploy library locally (~/.m2/repository) | `clojure -X:deps mvn-install :jar '"project.jar"'` | Built-in |
147+
* Built-in: tasks provided by Clojure CLI
148+
* Practicalli: aliases provided by Practicalli Clojure CLI Config
149+
150+
| Task | Command | Configuration |
151+
| -------------------------------------------------- | --------------------------------------------------------- | --------------- |
152+
| Create minimal playground project | `clojure -T:project/create` | Practicalli |
153+
| Clojure REPL - rebel readline & nrepl server | `clojure -M:repl/rebel` | Practicalli |
154+
| ClojureScript REPL with nREPL server | `clojure -M:repl/cljs` | Practicalli |
155+
| Run tests / watch for changes | `clojure -X:test/run` / `clojure -X:test/watch` | Practicalli |
156+
| Run the project (clojure.main) | `clojure -M -m domain.main-namespace` | Built-in |
157+
| Check library dependencies for newer versions | `clojure -T:search/outdated` | Practicalli |
158+
| Download dependencies | `clojure -P` (followed by optional aliases) | Built-in |
159+
| Generate image of project dependency graph | `clojure -T:project/graph-deps` | Practicalli |
160+
| Deploy library locally (~/.m2/repository) | `clojure -X:deps mvn-install :jar '"project.jar"'` | Built-in |
161+
| Find library names (Clojars & Maven Central) | `clojure -M:search/libraries qualified-library-names` | Practicalli |
162+
| Find available versions of a library | `clojure -X:deps find-versions :lib domain/library-name` | Built-in |
163+
| Resolve git coord tags to shas and update deps.edn | `clojure -X:deps git-resolve-tags git-coord-tag` | Built-in |
166164

167165

168166
## REPL terminal UI

0 commit comments

Comments
 (0)