@nichoth/tap-ssc
v0.6.8
Published
Run tests in a browser environment from the command line
Downloads
928
Maintainers
nichothReadme
tap ssc
Run tests in a browser environment from the command line.
The interface is inspired by tape-run. Just pipe some JS into the tap-ssc command, and your tests will run in a browser environment.
Instead of electron, a dependency of tape-run, this uses @socketsupply/socket to create a browser-like environment.
install
npm i -D @nichoth/tap-sscuse
Bundle your client side JS, then pipe it into this tool, which is installed as the tap-ssc command.
Your tests will be running in a browser environment, but all tap output will go to the terminal.
Use it as a part of package.json scripts:
"scripts": {
"test": "esbuild --bundle test/index.js | tap-ssc"
},Or on the command line:
npx esbuild --bundle test/index.js | npx tap-sscexample
// example/test/index.js
import { test } from '@nichoth/tapzero'
test('browser environment', t => {
t.ok(window, 'window should exist')
})Then in the terminal:
npx esbuild --bundle test/index.js | npx tap-sscsee this example
pass in your own html file
[!NOTE]
This is in progress.
Use command line argument --html=filename.html
esbuild --bundle --platform=browser --format=esm test/html.js | tap-ssc --html=test.html | tap-arcIn your html, be sure to include a script tag pointing at bundle.js:
<script charset="utf-8" src="bundle.js" type="module"></script>This is useful if your application code depends on another file that you are linking to via HTML, eg
<head>
<meta charset="UTF-8">
<title>tests</title>
<script src="https://example.com/my-js-dependency/dist/index.umd.min.js"></script>
</head>
<body>
<script src="bundle.js"></script>
</body>how does this work?
We build an ssc binary once after you install this package
The package binary, ./cli.js, takes javascript that is piped to stdin, and writes it to a file at the right location -- target + /bundle.js. Then it runs the ssc binary and pipes the output to stdout.
test this module
This will use the example directory to install this as a dependency, then run a given test.
A passing test
npm test | npx tap-arcA failing test
npm run test-failA test that throws an error
npm run test-err