[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/with-simulated-input 6f338aeaed 003/134: Add a README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/with-simulated-input 6f338aeaed 003/134: Add a README |
Date: |
Mon, 10 Jan 2022 22:59:57 -0500 (EST) |
branch: elpa/with-simulated-input
commit 6f338aeaedc9a4f5cd3d2dbee9742ceb01a66728
Author: Ryan C. Thompson <rct@thompsonclan.org>
Commit: Ryan C. Thompson <rct@thompsonclan.org>
Add a README
---
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..c7cb9208d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# with-simulated-input
+
+[![Build
Status](https://travis-ci.org/DarwinAwardWinner/with-simulated-input.svg?branch=master)](https://travis-ci.org/DarwinAwardWinner/with-simulated-input)
+<!-- (Not in MELPA yet) [![MELPA
Stable](https://stable.melpa.org/packages/with-simulated-input-badge.svg)](https://stable.melpa.org/#/with-simulated-input)
-->
+
+This package provides a single Emacs Lisp macro,
+`with-simulated-input`, which evaluates one or more forms while
+simulating a sequence of input events for those forms to read. The
+result is the same as if you had evaluated the forms and then manually
+typed in the same input. This macro is useful for non-interactive
+testing of normally interactive commands and functions, such as
+`completing-read`.
+
+For example:
+
+```elisp
+(with-simulated-input
+ "hello SPC world RET"
+ (read-string "Say hello: "))
+```
+
+This would return the string `"hello world"`.
+
+<!-- Get it from MELPA: https://stable.melpa.org/#/with-simulated-input -->
+
+## Running the tests
+
+This package comes with a test suite. If you want to run it yourself,
+first install the [cask](http://cask.readthedocs.io/en/latest/)
+dependency manager. Then, from the package directory, run `cask
+install` to install all the development dependencies, in
+particular [ert-runner](https://github.com/rejeep/ert-runner.el).
+Finally, to run the tests, execute `cask exec ert-runner`. You should
+see something like this:
+
+```
+$ cask exec ert-runner
+.
+
+Ran 1 test in 0.015 seconds
+````
+
+Please run the tests before submitting any pull requests, and note in
+the pull request whether any of the tests fail.
- [nongnu] elpa/with-simulated-input 26927ea680 049/134: Specify test directory explicitly, (continued)
- [nongnu] elpa/with-simulated-input 26927ea680 049/134: Specify test directory explicitly, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 93e55eddee 053/134: Fix linter issues and remove unused dependencies, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input ff6bf569b1 057/134: Remove redundant buttercup dependency, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input c377a673c8 127/134: Prefix unused variables with underscores, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 63297040ad 052/134: Switch from Cask to Eldev, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input a5c955085d 055/134: Fix some warnings in test file, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 0d5e910f19 061/134: Add an error message for unhandled case, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 228732caf5 063/134: Enable undercover in CI, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 2a83333b6d 121/134: Update the edebug spec to include characters, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 166a00980a 131/134: Remove some unused test code, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 6f338aeaed 003/134: Add a README,
ELPA Syncer <=
- [nongnu] elpa/with-simulated-input 5a67067ae0 002/134: Initial version, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 4fec23e53b 001/134: Inital empty commit, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 9a2ba67eba 009/134: Switch to using buttercup as the test suite, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 9d7afd6e6c 007/134: Delete some extraneous whitespace, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 322dc7ed95 008/134: Add some more tests, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 4c68e02cc1 010/134: Allow evaluating lisp forms while simulating input, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 5701347987 013/134: Update the readme with new instructions for running tests, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input ad9eaf2252 014/134: Add info on idle simulation to README, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 4932368712 016/134: Add MELPA links, ELPA Syncer, 2022/01/10
- [nongnu] elpa/with-simulated-input 33b40e59a1 018/134: Fix indentation, ELPA Syncer, 2022/01/10