Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide and usage related updates #454

Merged
merged 5 commits into from
Jun 12, 2022
Merged

User guide and usage related updates #454

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ebf82a8
User guide and usage related updates
lread May 31, 2022
1799331
ci: test-doc: switch to from ubuntu macos
lread Jun 11, 2022
fff6250
test-docs: add some dir creation setup
lread Jun 11, 2022
9605aee
docs: user-guide: typos and grammar
lread Jun 12, 2022
1feb8e0
test-docs: fiddle for sporadic failure
lread Jun 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .clj-kondo/config.edn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,4 @@
;; finer grained error reporting
{:macroexpand
{etaoin.impl.util/defmethods etaoin.impl.util/defmethods
etaoin.impl.util/with-tmp-file etaoin.impl.util/with-tmp-file}}

:linters
;; etaoin is dsl-ish and does make use of :refer :all, can decide if we like that at some later date
{:refer-all {:level :off}}}
etaoin.impl.util/with-tmp-file etaoin.impl.util/with-tmp-file}}}
5 changes: 4 additions & 1 deletion CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,11 @@ Fixed.
* Docs
** https://github.com/clj-commons/etaoin/issues/393[#393]: Add changelog
** https://github.com/clj-commons/etaoin/issues/426[#426]: Reorganize into separate guides
** https://github.com/clj-commons/etaoin/commit/f3f0370fb76bc353c14293243410db1641f99c70[f3f0370]: A new troubleshooting tip (thanks https://github.com/jkrasnay[@jkrasnay]!)
** https://github.com/clj-commons/etaoin/issues/396[#396]: Move from Markdown to AsciiDoc
** User guide
*** Reviewed, re-organized, hopefully clarified some things
*** Checking code blocks with https://github.com/lread/test-doc-blocks[test-doc-blocks]
*** https://github.com/clj-commons/etaoin/commit/f3f0370fb76bc353c14293243410db1641f99c70[f3f0370]: A new troubleshooting tip (thanks https://github.com/jkrasnay[@jkrasnay]!)
* Internal quality
** https://github.com/clj-commons/etaoin/issues/382[#382]: Fix process fork testing on Windows
** https://github.com/clj-commons/etaoin/issues/391[#391]: Identify browser name on failed ide tests
Expand Down
2 changes: 2 additions & 0 deletions bb.edn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
"--nrepl-server"))}
test {:doc "run all or a subset of tests, use --help for args"
:task test/-main}
test-doc {:doc "test code blocks in user guide"
:task test-doc/-main}
drivers {:doc "[list|kill] any running WebDrivers"
:task drivers/-main}
lint {:doc "[--rebuild] lint source code"
Expand Down
17 changes: 16 additions & 1 deletion deps.edn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,23 @@
;; for babashka testing, allows us to use cognitect test-runner
:bb-test {:extra-deps {org.clojure/tools.namespace {:git/url "https://github.com/babashka/tools.namespace"
:git/sha "a13b037215e21a2e71aa34b27e1dd52c801a2a7b"}}}

;; test-doc-blocks - gen tests
:test-doc-blocks {:replace-deps {org.clojure/clojure {:mvn/version "1.11.1"}
com.github.lread/test-doc-blocks {:mvn/version "1.0.166-alpha"}}
:replace-paths []
:ns-default lread.test-doc-blocks
:exec-args {:docs ["doc/01-user-guide.adoc"]}}

;; test-doc-blocks - run tests
;; usage: test:test-docs
:test-docs {:override-deps {org.clojure/clojure {:mvn/version "1.11.1"}}
:extra-paths ["target/test-doc-blocks/test"]
:main-opts ["-m" "cognitect.test-runner"
"-d" "target/test-doc-blocks/test"]}

;; for consistent linting we use a specific version of clj-kondo through the jvm
:clj-kondo {:extra-deps {clj-kondo/clj-kondo {:mvn/version "2022.05.29"}}
:clj-kondo {:extra-deps {clj-kondo/clj-kondo {:mvn/version "2022.05.31"}}
:main-opts ["-m" "clj-kondo.main"]}

:build {:deps {io.github.clojure/tools.build {:git/tag "v0.8.2" :git/sha "ba1a2bf"}
Expand Down
Loading