docopt.clj

KO | EN

gitlite — search

#hacktoberfest #go #android #rust #deep-learning #linux #windows #cli #kubernetes #awesome-list #pytorch #security #ios #openai

(★ 84)

Clojure implementation of the docopt description language

File Explorer

Download Latest Version (.zip)

- common.clj
- naval_fate_dynamic.clj
- naval_fate_env.clj
- - core.clj
  - match.clj
  - optionsblock.clj
  - usageblock.clj
  - util.clj
- - core_test.clj
  - extra_testcases.docopt
.gitignore
CHANGELOG.md
deps.edn
LICENSE
project.clj
README.md
test_runner.clj

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# docopt.clj

[![Clojars Project](https://img.shields.io/clojars/v/dev.nubank/docopt.svg)](https://clojars.org/dev.nubank/docopt)

Clojure implementation of the [docopt](http://docopt.org/) description language.

Forked from [@signalpillar](https://github.com/signalpillar)'s [fork](https://github.com/signalpillar/docopt.clj) of docopt, [originally](https://github.com/docopt/docopt.clj/) by [@postamar](https://github.com/postamar).

## Usage

### babashka

In order to add `docopt.clj` to the classpath, you can either

- Use an environment variable
  ``` bash
  cd babashka
  export BABASHKA_CLASSPATH=$(clojure -Spath -Sdeps '{:deps {dev.nubank/docopt {:mvn/version "0.6.1-fix7"}}}')
  ./naval_fate_env.clj
  ```

- Dynamically include it with `(require '[babashka.classpath :refer [add-classpath])`
  ``` bash
  cd babashka
  ./naval_fate_dynamic.clj
  ```
  
`babashka/common.clj` contains an example of how to call docopt's entrypoint function.

In both cases, the output should be

``` bash
$ ./naval_fate_env.clj ship Unicorn move $'20°37\'42.0"N' $'70°52\'25.0"W' 
{"--drifting" false,
 "--help" false,
 "--moored" false,
 "--speed" "10",
 "--version" false,
 "<lat>" "20°37'42.0\"N",
 "<long>" "70°52'25.0\"W",
 "<name>" "Unicorn",
 "mine" false,
 "move" true,
 "new" false,
 "remove" false,
 "set" false,
 "ship" true}
```

### tools.deps

Save the following script as `test-script` and make it executable with `chmod +x`:

``` clojure
#!/bin/sh
#_(
  DEPS='
   {:deps {dev.nubank/docopt {:mvn/version "0.6.1-fix7"}}}
   '

OPTS='
  -J-Xms256m -J-Xmx256m
  -J-client
  -J-Dclojure.spec.skip-macros=true
  '

exec clojure $OPTS -Sdeps "$DEPS" -i "$0" -m docopt.example "$@"
)

(ns docopt.example
  (:require [docopt.core :as docopt]))

(def usage "Test application.

Usage: test-script [options]

Options:
  --an-arg <something>  An argument")
(defn -main [& args]
  (docopt/docopt usage args
                 (fn [arg-map]
                   (println arg-map)
                   (println (arg-map "--an-arg")))))
```

```bash
$ chmod +x test-script
$ ./test-script --an-arg test
{--an-arg test}
test
$ ./test-script # displays the help text
Test application.

Usage: testapp [options]

Options:
  --an-arg <something>  An argument
```

## Tests

Run `lein test` to validate all tests.
The tests are automatically downloaded from the language-agnostic
`testcases.docopt` file in the reference implementation, master branch commit 
[511d1c57b5](https://github.com/docopt/docopt/tree/511d1c57b59cd2ed663a9f9e181b5160ce97e728).
Please feel free to (re)open an issue in case this implementation falls behind.

## License

[MIT license](LICENSE).

docopt.clj

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

docopt.clj

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README