https://github.com/plandes/clj-nrepl-puget
Configure and use Puget in Cider with Emacs.
https://github.com/plandes/clj-nrepl-puget
Last synced: 8 months ago
JSON representation
Configure and use Puget in Cider with Emacs.
- Host: GitHub
- URL: https://github.com/plandes/clj-nrepl-puget
- Owner: plandes
- License: apache-2.0
- Created: 2017-06-28T15:44:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-13T00:17:18.000Z (about 8 years ago)
- Last Synced: 2025-01-02T04:14:38.647Z (9 months ago)
- Language: Clojure
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Configure and use Puget in Cider
[![Travis CI Build Status][travis-badge]][travis-link]
[travis-link]: https://travis-ci.org/plandes/clj-nrepl-puget
[travis-badge]: https://travis-ci.org/plandes/clj-nrepl-puget.svg?branch=master
Configure and use [Puget](https://github.com/greglook/puget)
in [Cider](https://github.com/clojure-emacs/cider)
with [Emacs](https://www.gnu.org/software/emacs/). Cider provides a Puget
already as an option for pretty printing. In addition there is already
a [lein plugin](https://github.com/greglook/whidbey) to use Puget in a REPL.
So why is this software necessary?
This package provies provides a Puget (and ANSI coloring) in a Cider REPL.
Specifically:
* Puget binds dynamic variables for configuration, which is good, but this
doesn't allow easy configuration via Cider. This package allows a one time
(i.e. REPL startup) to (re)configure.
* Include Emacs Lisp to easily configure the lisp cider project.
## Table of Contents
- [Obtaining](#obtaining)
- [Configuration](#configuration)
- [Usage](#usage)
- [Dynamic Width and Length of Ouptut](#dynamic-width-and-length-of-ouptut)
- [Documentation](#documentation)
- [Building](#building)
- [Changelog](#changelog)
- [License](#license)
- [Emacs Code](#emacs-code)
- [Everything Else](#everything-else)
## Obtaining
In your `project.clj` file, add:
[](https://clojars.org/com.zensols.tools/nrepl-puget/)
## Configuration
In your `profiles.clj` file (or add like configuraiton to `projects.clj`):
```clojure
{:user ...
:dev {:dependencies [[com.zensols.tools/nrepl-puget "0.0.1"]]}}
```
Create your Puget configuration anywhere you want, say for example
`~/.init.clj`:
```clojure
(require '[zensols.nrpuget.core])
(->> {:print-color true
:color-scheme {:keyword [:none]
:delimiter [:blue]
:number [:magenta]
:tag [:black]
:symbol [:red]
:string [:green]
:character [:bold :green]
:boolean [:black]
:nil [:black]}}
zensols.nrpuget.core/set-options!)
```
Add the [Emacs extension](src/emacs/nrepl-puget.el) to your `load-lib`, like
for example in `~/.emacs.d`.
Next, in your [`~/.emacs`](https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html) file
add the following (**note** refer to the configuration file you created
earlier):
```emacs
(require 'nrepl-puget)
(require 'cider)
(defun my-init-cider-connected-hook ()
(let ((src (expand-file-name "~/.init.clj")))
(if (file-exists-p src)
(let* ((buf (find-buffer-visiting src))
(killp (not buf))
(buf (or buf (find-file-noselect src))))
(unwind-protect
(cider-load-file src)
(unless killp
(kill-buffer buf))))))
(add-hook 'cider-connected-hook 'my-init-cider-connected-hook)
(setq cider-pprint-fn "zensols.nrpuget.core/pprint"
cider-repl-use-pretty-printing t)
```
## Usage
After you [configure](#configuration) you'll should see Puget formatting in the
REPL output (i.e. results from evaluation and cider functions like
`cider-pprint-eval-last-sexp`. However, you can optionally get all of your
output through formatting using (for example) `println` but adding the
following to your Clojure source files:
```clojure
(ns example.my-namespace
(:refer-clojure :exclude [println])
(:require [zensols.nrpuget.core :refer (println)]))
(println ['asym #{"hash" :set} "string" 123])
```
Which produces
```clojure
=> [asym #{"hash" :set} "string" 123]
```
## Dynamic Width and Length of Ouptut
Per the Cider use case, `cloijure.pprint/*print-right-margin*` and
`*print-length*` are passed to Puget
when
[`println`](https://plandes.github.io/clj-nrepl-puget/codox/zensols.nrpuget.core.html) is
used. However, these can be overriden by setting `:width-override` and
`:seq-limit-override` (for `*print-length*`).
An example use case is setting the size of your frame:
```emacs
(defun set-width (width)
(set-frame-width frame width)
(let ((width (window-width)))
(-> (format "(zensols.nrpuget.core/option-assoc! :width-override %d)" width)
(nrepl-request:eval #'(lambda (&rest args))
(cider-current-connection)))))
```
## Documentation
API [documentation](https://plandes.github.io/clj-nrepl-puget/codox/index.html).
## Building
To build from source, do the folling:
- Install [Leiningen](http://leiningen.org) (this is just a script)
- Install [GNU make](https://www.gnu.org/software/make/)
- Install [Git](https://git-scm.com)
- Download the source: `git clone https://github.com/clj-nrepl-puget && cd clj-nrepl-puget`
- Download the make include files:
```bash
mkdir ../clj-zenbuild && wget -O - https://api.github.com/repos/plandes/clj-zenbuild/tarball | tar zxfv - -C ../clj-zenbuild --strip-components 1
```
- Build the software: `make jar`
## Changelog
An extensive changelog is available [here](CHANGELOG.md).
## License
Copyright © 2017 Paul Landes
### Emacs Code
The [Emacs Code](src/emacs) is distributed under the GNU General Public
License, version 3.
### Everything Else
Apache License version 2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.