README update

main
BraydonKains 3 years ago
parent ab01ce3b44
commit a62dd90535

@ -1,5 +1,12 @@
# js-test
`js-test` will be a minimal JavaScript test runner. It will be able to run tests from the CLI or programatically. The aim of this library is to enable JavaScript developers to write test code in very plain JavaScript without needing to learn a whole testing framework. The test code written to be run by this package will look largely like plain JavaScript. The aim will be to enforce very little opinions on the developer.
This project is still under development. I am still making some fundamental architecture decisions. The code in this repo will mostly be my scratch attempts at coming up with something usable.
# js-test
`js-test` is a minimal JavaScript test runner. The aim of this library is to enable JavaScript developers to write test code in very plain JavaScript. To write test files with this language all one needs to do is:
1. Export functions whose names start with the word "test"
2. Name the file to match the format `*.test.{js,cjs,mjs}`
Then running `js-test` will run all the test files it can find in your project.
Future plans:
* Programmatic test running API, potentially separating that package from the CLI
* Support for custom test file patterns
* Prettier CLI output
Loading…
Cancel
Save