Skip to content

Commit a7417ff

Browse files
aliases: update documentation and formatting
- add clojure command and execution flag for each alias - move :repl/clerk to REPL section - move :lib/integrant-repl & :lib/component-repl to development environment section
1 parent d67d211 commit a7417ff

File tree

3 files changed

+369
-386
lines changed

3 files changed

+369
-386
lines changed

CHANGELOG.org

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- Removed: `:lib/scope-capture` - use cider-debug or `:lib/flowstorm` or Portal data inspector
1515
- Removed: `:alpha/closh` - project only proof of concept
1616
- `:test/env` - remove `pjstadig/humane-test-output` library as it requires activation
17+
- update documentation and formatting
1718

1819
* 2023-10-17
1920
** Added

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -657,23 +657,34 @@ Take care to get the timezone notation correct.
657657

658658
## Library Hosting Services
659659

660-
Repositories that host libraries for Clojure.
660+
Clojure libraries are packaged as Java Archive (JAR) files and distributed by Maven style repositories. A Clojure project configuration defines library dependencies that are satisfied by downloading jar files from the collective repository sources.
661661

662-
`central` and `clojars` are the man repositories for Clojure development are consulted in order.
662+
`central` and `clojars` are defined in the Clojure CLI installation configuration and are the main repositories for Clojure development.
663663

664-
`central` and `clojars` repos can be removed from consideration by setting their configuration hash-map to `nil` in `~/.clojure/deps.edn`. For example, `{:mvn/repos {"central" nil}}`.
664+
* `central` - Maven Central, the canonical repository for JVM libraries, including Clojure releases
665+
* `clojars` - [clojars.org](https://repo.clojars.org/), the canonical repositories for Clojure community libraries fronted by a contend delivery network service
666+
667+
```clojure
668+
:mvn/repos
669+
{"central" {:url "https://repo1.maven.org/maven2/"}
670+
"clojars" {:url "https://repo.clojars.org/"}}
671+
```
665672

666-
The order of additional repositories consulted is not guaranteed, so may cause unpredictable side effects in the project build especially if `RELEASE` or `LATEST` tags are used rather than a numeric library version.
673+
`central` and `clojars` repos can be removed by setting their configuration to `nil` in the user or project `deps.edn` configuration.
667674

668-
Maven supports [explicit mirror definition](https://maven.apache.org/guides/mini/guide-mirror-settings.html) in `~/.m2/settings.xml` and Clojure CLI supports this configuration. Adding Maven Central or a mirror to `~/.m2/settings.xml` negates the need for its entry in deps.edn configuration.
675+
```clojure
676+
`:mvn/repos
677+
{"central" nil
678+
"clojars" nil}
679+
```
669680

670-
### Recommended repositories
681+
Maven supports [explicit mirror definition](https://maven.apache.org/guides/mini/guide-mirror-settings.html) in `~/.m2/settings.xml` and Clojure CLI supports this configuration. Adding Maven Central or a mirror to `~/.m2/settings.xml` negates the need for its entry in deps.edn configuration.
671682

672-
* `central` - Maven Central, the canonical repository for JVM libraries, including Clojure releases
673-
* `clojars` - [clojars.org](https://repo.clojars.org/), the canonical repositories for Clojure community libraries fronted by a contend delivery network service
674683

675684
### Optional repositories
676685

686+
The order of additional repositories consulted is not guaranteed, so may cause unpredictable side effects in the project build especially if `RELEASE` or `LATEST` tags are used rather than a specifice numerical version.
687+
677688
* `sonatype` - [snapshots of Clojure development releases](https://oss.sonatype.org/), useful for testing against before new stable releases.
678689
* `business-area` - example of adding a local Artifactory server for your team or business area.
679690
* `google-maven-central` - [Maven Central mirror hosted on Google Cloud Storage](https://storage-download.googleapis.com/maven-central/index.html) - Americas, Asia, Europe
@@ -706,7 +717,7 @@ Example of local Artifactory repository configuration
706717
"clojars" {:url "https://repo.clojars.org/"}}
707718
```
708719

709-
### Asian Region Mirrors
720+
### Asia Region Mirrors
710721

711722
```clojure
712723
:mvn/repos
@@ -721,10 +732,16 @@ Example of local Artifactory repository configuration
721732

722733
## Maven local repository
723734

724-
Define a local Maven repository. Useful if you wish to specify an alternative to the default `~/.m2/` directory.
735+
Specify a local repository for maven, as an alternative to the default location: `$HOME/.m2/repository`
736+
737+
FreeDesktop.org `XDG_CACHE_HOME` is the recommended location for an alternative Maven local repository.
725738

726739
```clojure
727-
:mvn/local-repo "/cache/.m2"
740+
:mvn/local-repo "/home/practicalli/.cache/maven/repository"
728741
```
729742

743+
> NOTE: The full path should be specified, otherwise a relative directory path will be created
744+
745+
`clojure -Spath` will show the current class path which will include the path to the local maven repository for the library dependencies.
746+
730747
> NOTE: using `clojure -Sforce` forces a classpath recompute, deleting the contents of .cpcache

0 commit comments

Comments
 (0)