https://github.com/jcs-elpa/ic
Pretty print to debug
https://github.com/jcs-elpa/ic
debug elisp emacs ic logger
Last synced: 2 months ago
JSON representation
Pretty print to debug
- Host: GitHub
- URL: https://github.com/jcs-elpa/ic
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2023-11-25T07:08:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-23T00:09:22.000Z (2 months ago)
- Last Synced: 2025-04-23T01:21:26.298Z (2 months ago)
- Topics: debug, elisp, emacs, ic, logger
- Language: Emacs Lisp
- Homepage:
- Size: 67.4 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/ic)
# ic
> Pretty print to debug
[](https://github.com/jcs-elpa/ic/actions/workflows/test.yml)
## 🔨 Usage
Pretty print anything.
```elisp
(ic-message (lambda (&rest _) (message "hello")))
```
Output,
```
(lambda
(&rest _)
(message "hello"))
```
## 🔧 Customization
### 🧪 Variables
- `ic-log` If non-nil, output the message.
- `ic-inhibit-clear` - If nil, clear messages buffer before logging.
### 🧪 Functions
- `ic-message` - Output to stderr. (see [message][])
- `ic-princ` - Output to stdout (see [princ][]).
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone or make pull requests to this repository. Or you can
clone the project and establish your branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
eask install-deps --dev
```
To test the package's installation:
```sh
eask package
eask install
```
To test compilation:
```sh
eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
eask lint checkdoc
```
The standard `package` linter:
```sh
eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
See [`LICENSE`](./LICENSE.txt) for details.
[message]: https://www.gnu.org/software/emacs/manual/html_node/eintr/message.html
[princ]: https://www.gnu.org/software/emacs/manual/html_node/elisp/Output-Functions.html