Skip to content

Commit 826363c

Browse files
readme: update custom snippet descriptions
1 parent e496c21 commit 826363c

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

README.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,37 @@ Clone the repository to the user level configuration location for Clojure LSP, e
1111

1212
[Snippets created by Practicalli](https://practical.li/spacemacs/snippets/clojure-lsp/practicalli-snippets.html) are documents in [Practicalli Spacemacs](https://practical.li/spacemacs/snippets/clojure-lsp/practicalli-snippets.html)
1313

14-
| Snippet | Description |
15-
|------------------------|-----------------------------------------------------------|
16-
| `comment-heading` | Heading describing the namespace using line comments |
17-
| `comment-separator` | Logical separator for a namespace using line comments |
18-
| `def` | `def` with doc-string |
19-
| `def-` | `def ^:private` with doc-string |
20-
| `defm` | `defn` with doc-string |
21-
| `defn-` | `defn ^:private` with doc-string |
22-
| `ns` | `ns` with doc-string |
23-
| `require` | `require` directive with `:as` alias (within ns form) |
24-
| `require-rdd` | `require` expression with `:as` alias (self-contained) |
25-
| `rich-comment` | Rich comment using `comment` function |
26-
| `rich-comment-rdd` | Rich comment with clj-kondo ignore refined-var |
27-
| `rich-comment-hotload` | Rich comment with add-libs for hotload library dependency |
28-
| `deftest` | clojure.test `deftest` function with assertion grouping |
29-
| `testing` | clojure.test `testing` function for assertion grouping |
14+
15+
### Docs / comments
16+
* `comment-heading` - describe purpose of the namespace
17+
* `comment-separator` - logically separate code sections, helps identify opportunities to refactor to other name spaces
18+
19+
### Repl Driven Development
20+
* `rich-comment` - comment block
21+
* `rich-comment-rdd` - comment block with ignore :redefined-var for repl experiments
22+
* `rich-comment-hotload` - comment block with add-libs code for hotloading libraries in Clojure CLI repl
23+
24+
### Standard library functions
25+
* `def` - def with docstring
26+
* `def-` - private def with docstring
27+
* `defn` - defn with docstring
28+
* `defn-` private defn with docstring
29+
* `ns` - namespace form with docstring
30+
31+
### Clojure CLI deps.edn aliases
32+
* `deps-alias` - add Clojure CLI alias
33+
* `deps-maven` - add a maven style dependency
34+
* `deps-git` - add a git style dependency using `:git/sha`
35+
* `deps-git-tag` - as above including `:git/tag`
36+
* `deps-git-url` - add git style dependency using git url (url taken from dependency name as it is typed - mirrored placeholder)
37+
* `deps-local` - add a `:local/root` dependency
38+
39+
### Requiring dependencies
40+
* `require-rdd` - add a require expression, for adding a require in a rich comment block for RDD
41+
* `require` - simple require
42+
* `require-refer` - require with `:refer`
43+
* `require-as` - require with `:as` alias
44+
* `use` - creates a require rather than the more troublesome use
45+
46+
### Unit testing
47+
* `deftest` - creates a deftest with testing directive and one assertion

0 commit comments

Comments
 (0)