Skip to content

Commit

Permalink
migrates over to deps.edn, removes project.clj
Browse files Browse the repository at this point in the history
  • Loading branch information
slagyr committed Jan 30, 2024
1 parent b0a6b67 commit fc7b961
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 56 deletions.
4 changes: 0 additions & 4 deletions .travis.yml

This file was deleted.

10 changes: 4 additions & 6 deletions DEPLOY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Step for deployment

1) Run specs `lein spec`
2) Run cljs specs `lein cljs`
1) Run specs `clj -M:test:spec`
2) Run cljs specs `clj -M:test:cljs`
3) Increase version in project.clj
4) Update CHANGES.md with changes in version
5) `lein install`, update some other project to use the new version, try it out (clj and cljs)
5) `clj -T:build install`, update some other project to use the new version, try it out (clj and cljs)
6) `git commit` changes
7) `git tag -a X.Y.Z -m ''`
8) `git push origin master --tags`
9) `lein deploy clojars` (need pgp config, micah may need to do this)
7) `clj -T:build deploy`
10) `bin/doc.sh` - generate and publish new documentation
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2010-2014 Micah Martin
Copyright (c) 2010-2024 Micah Martin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THE SOFTWARE.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# speclj [![Build Status](https://secure.travis-ci.org/slagyr/speclj.png?branch=master)](http://travis-ci.org/slagyr/speclj)
# speclj
### (pronounced "speckle" [spek-uhl]) ###
It's a TDD/BDD framework for [Clojure](http://clojure.org/) and [Clojurescript](http://clojurescript.org/), based on [RSpec](http://rspec.info/).

Expand Down Expand Up @@ -42,7 +42,7 @@ Include speclj in your `:dev` profile `:dependencies` and`:plugins`. Then change
2. Install it:

```bash
$ lein install
$ clj -T:build install
```

# Usage
Expand Down Expand Up @@ -132,6 +132,24 @@ There are many ways to make assertions. Check out the [API Documentation](http:

## Running Specs

### With `deps.edn`
Add a `spec` alias to your `deps.edn`.

```clojure
{
:aliases {:spec {:main-opts ["-m" "speclj.main" "-c"]
:extra-deps {speclj/speclj {:mvn/version "3.4.5"}}
:extra-paths ["spec"]}}
}
```

Run specs.
```bash
clj -M:spec # printing dots
clj -M:spec -a # auto running with doc output
clj -M:spec <OPTIONS>
```

### With Leiningen
Speclj includes a Leiningen task.

Expand Down Expand Up @@ -292,22 +310,20 @@ $ bin/speclj path/to/compiled.js
* Email List: [http://groups.google.com/group/speclj](http://groups.google.com/group/speclj)

# Contributing
speclj uses [Leiningen](https://github.com/technomancy/leiningen) version 2.0.0 or later.

Clone the master branch, build, and run all the tests:

```bash
$ git clone https://github.com/slagyr/speclj.git
$ cd speclj
$ lein spec
$ clj -M:test:spec
```

To make sure tests pass ClojureScript too, make sure you have npm:

```bash
npm install
lein clean
lein cljs
clj -T:build clean
clj -M:test:cljs
```

Make patches and submit them along with an issue (see below).
Expand Down
4 changes: 2 additions & 2 deletions bin/doc.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#! /bin/sh

lein codox
clj -X:test:codox
pushd doc
git checkout gh-pages # To be sure you're on the right branch
git add .
git commit -am "new documentation push."
git push -u origin gh-pages
popd
popd
10 changes: 8 additions & 2 deletions deps.edn
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,18 @@
io.github.clojure/tools.build {:mvn/version "0.9.5"}
org.clojure/clojurescript {:mvn/version "1.11.60"}
}
:extra-paths ["dev" "spec"]}
:extra-paths ["dev" "spec" "target/classes"]}
:spec {:main-opts ["-m" "speclj.main" "-c"]}
:cljs {:main-opts ["-m" "cljs"]}
:cljs {:main-opts ["-m" "speclj.dev.cljs"]}
:build {:extra-deps {io.github.clojure/tools.build {:mvn/version "0.9.5"}
clj-commons/pomegranate {:mvn/version "1.2.23"}}
:ns-default build
:extra-paths ["dev"]}
:codox {:extra-deps {codox/codox {:mvn/version "0.10.8"}}
:exec-fn codox.main/generate-docs
:exec-args {:source-paths ["src"]
:output-path "doc"
:source-uri "https://github.com/slagyr/speclj/blob/master/{filepath}#L{line}"}
}
}
}
1 change: 1 addition & 0 deletions dev/build.clj
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
(println "building" jar-file)
(b/copy-dir {:src-dirs src-dirs
:target-dir class-dir})
(b/copy-file {:src "LICENSE" :target "target/classes/LICENSE"})
(b/jar {:class-dir class-dir
:jar-file jar-file}))

Expand Down
33 changes: 0 additions & 33 deletions project.clj

This file was deleted.

0 comments on commit fc7b961

Please sign in to comment.