Documents usage with deps.tools #164

bltavares · 2019-02-04T14:05:21Z

Since #123 it is now possible to use cljfmt without integrating it with lein.
This is very useful for CI scripts, where you might want to check for indentation, but would rather not download all the projects dependencies.

This commit documents the usage with deps-tools, using the clojure command line to execute cljfmt without using the pluging interface. It includes how to configure the tool without using the lein profile setup.

Closes #93

When using `cljfmt` action, we ended up downloading all the dependencies of the project, as it would be integrated as a `lein` plugin. This was cumbersome, as it required exposing extra configuration to access the project's dependencies as well. Ideally, to reduce the adoption, it would be better to use `cljfmt` as a globally accessible tool, without the need to access the project's dependencies from GitHub Actions' execution environment. There is a [previously undocumented feature](weavejester/cljfmt#164) on `cljfmt` which exposes it as a `deps-tools` executable. This commit refactors the execution to run the formatter from a global execution path. This means we don't need extra access to the project dependencies. The configuration to use the formatter don't live anymore inside `lein`'s `project.clj`, and now is expected to live on their own file inside the project, as it is documented. We are also taking a chance to refactor a couple of things on the `zprint` action, which is somewhat complementary to `cljfmt`.

weavejester

Thanks for the patch! I have a few changes which need to be addressed before I can merge this.

Please also ensure the commit message follows the contributing guidelines, and uses plain text rather than markdown.

weavejester · 2019-02-04T23:35:30Z

README.md


    lein cljfmt fix src/foo/core.clj
+
+### deps-tools usage


Should be deps.tools.

weavejester · 2019-02-04T23:37:37Z

README.md

+
+### deps-tools usage
+
+It is possible to execute `cljfmt` using the [clojure](https://clojure.org/guides/deps_and_cli) CLI, without integrating with `lein`.


Line should be wrapped at. 72 characters. Use reference link format, e.g.

using the [clojure CLI][],, without Leiningen. [clojure cli]: https://clojure.org/guides/deps_and_cli

weavejester · 2019-02-04T23:37:54Z

README.md

+It is possible to execute `cljfmt` using the [clojure](https://clojure.org/guides/deps_and_cli) CLI, without integrating with `lein`.
+
+```bash
+clojure -Sdeps '{:deps {lein-cljfmt {:mvn/version "0.6.4"}}}' -m cljfmt.main [check|fix]


Use cljfmt, not lein-cljfmt.

weavejester · 2019-02-04T23:38:02Z

README.md

+clojure -Sdeps '{:deps {lein-cljfmt {:mvn/version "0.6.4"}}}' -m cljfmt.main [check|fix]
+```
+
+Customizing the rules is possible passing `edn` formated files, using the same content used on lein profiles.


weavejester · 2019-02-04T23:38:11Z

README.md

+
+Customizing the rules is possible passing `edn` formated files, using the same content used on lein profiles.
+
+As example, with the following content to the `indentation.edn` file, it is possible to customize the rules.


weavejester · 2019-02-04T23:38:39Z

README.md

+```
+
+```bash
+clojure -Sdeps '{:deps {lein-cljfmt {:mvn/version "0.6.4"}}}' -m cljfmt.main check --indents indentation.edn


Use cljfmt instead of lein-cljfmt.

bltavares · 2019-02-26T16:47:04Z

@weavejester I've updated the document according to the feedback. Let me know if there are still anything else :)

weavejester · 2019-05-13T01:46:04Z

Sorry for leaving this PR hanging. It got a little lost in my inbox! There's still a few formatting changes that are missed out, and the commit message has a bunch of backticks in it.

Do you want me to list the changes, or shall I edit your commit with the changes directly?

bltavares · 2019-05-22T12:47:57Z

Sorry for taking longer to check back as well.

I've removed backticks from the commit message, as I was not sure if they should be replaced by simple quotes, but let me know if it would be better to quote any word.

I've made sure both readme and commit message have short lines as well.

weavejester · 2019-05-28T01:11:32Z

Thanks! Can you change the commit message to:

Document usage with deps.tools

Since #123 it is now possible to use cljfmt without integrating it with
Leiningen. This commit adds documentation to the README on how to
achieve that.

Closes #93.

I'm using standard formatting here: imperative mood, wrap subject at 50, body at 72.

Can you also change line 68 onward, as per my earlier comment:

It is possible to execute cljfmt using the [clojure CLI][], without
integrating with Leiningen.

[clojure cli]: https://clojure.org/guides/deps_and_cli

I'm happy to make the changes to the commit and merge if you don't have the time.

Since weavejester#123 it is now possible to use cljfmt without integrating it with Leiningen. This commit adds documentation to the README on how to achieve that. Closes weavejester#93.

lread · 2019-07-28T22:50:14Z

This is useful info, much thanks!

bltavares mentioned this pull request Feb 4, 2019

Use cljfmt without installing projects dependency bltavares/actions#11

Merged

weavejester requested changes Feb 4, 2019

View reviewed changes

bltavares force-pushed the patch-1 branch from 724e46f to bd087ca Compare February 26, 2019 16:45

bltavares changed the title ~~Documents usage with deps-tools~~ Documents usage with deps.tools Feb 26, 2019

bltavares force-pushed the patch-1 branch from bd087ca to 0396d26 Compare May 22, 2019 12:46

bltavares force-pushed the patch-1 branch from 0396d26 to e73340d Compare May 28, 2019 14:29

Document usage with deps.tools

e73340d

Since weavejester#123 it is now possible to use cljfmt without integrating it with Leiningen. This commit adds documentation to the README on how to achieve that. Closes weavejester#93.

weavejester merged commit bb0aeae into weavejester:master Dec 20, 2019

bltavares deleted the patch-1 branch February 20, 2021 02:33


		### deps-tools usage

		It is possible to execute `cljfmt` using the [clojure](https://clojure.org/guides/deps_and_cli) CLI, without integrating with `lein`.


		Customizing the rules is possible passing `edn` formated files, using the same content used on lein profiles.

		As example, with the following content to the `indentation.edn` file, it is possible to customize the rules.

Documents usage with deps.tools #164

Documents usage with deps.tools #164

Uh oh!

Conversation

bltavares commented Feb 4, 2019

Uh oh!

weavejester left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

weavejester Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

bltavares commented Feb 26, 2019

Uh oh!

weavejester commented May 13, 2019

Uh oh!

bltavares commented May 22, 2019

Uh oh!

weavejester commented May 28, 2019

Uh oh!

lread commented Jul 28, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

weavejester left a comment •

edited

Loading