Pimp the docs linter (and assorted changes) (#2553)
### Pimp the docs linter (and assorted changes) #### `scripts/lint-docs.js` - Add an optional cache for faster runs - Add a final report - Don't return anything from `exec()` - Cover more files #### `scripts/_command.js` - Look for a "--cache" option #### `package.json` scripts - Added `watch:lint-docs` - Added `cleanup:lint` to remove the eslint and lint-docs cache files - Changed `lint:docs` to use the `--cache` option - Added `test:js` so that we can run the test suite without the linter - Changed `test` to defer to `test:js` #### Actual lint fixes: - Bad link in a migration guide - The unicode dashes in the "https://en.wikipedia.org/wiki/Subject–verb–object" are not escaped by marked ### Some more lint-docs pimping #### `scripts/lint-docs.js` - some code reorg and cleanup (take a hint from the local coding conventions) - fix misc bugs - pass a User-Agent header to the requests - even nicer reporting #### `package.json` - bump the @babel/parser dep to the latest #### Docs - tweaks based on lints missed due to previous bugs ### Docs: use the github page for velocity.js, the home page has too many errors. Co-Authored-By: Isiah Meadows <contact@isiahmeadows.com>
This commit is contained in:
parent
d257025253
commit
4a3a486d80
11 changed files with 182 additions and 62 deletions
|
|
@ -10,7 +10,7 @@ Noiseless testing framework
|
|||
- ~360 LOC including the CLI runner
|
||||
- terser and faster test code than with mocha, jasmine or tape
|
||||
- test code reads like bullet points
|
||||
- assertion code follows [SVO](https://en.wikipedia.org/wiki/Subject–verb–object) structure in present tense for terseness and readability
|
||||
- assertion code follows [SVO](https://en.wikipedia.org/wiki/Subject%E2%80%93verb%E2%80%93object) structure in present tense for terseness and readability
|
||||
- supports:
|
||||
- test grouping
|
||||
- assertions
|
||||
|
|
@ -98,10 +98,10 @@ o.spec("math", function() {
|
|||
The `o.spy()` method can be used to create a stub function that keeps track of its call count and received parameters
|
||||
|
||||
```javascript
|
||||
//code to be tested
|
||||
// code to be tested
|
||||
function call(cb, arg) {cb(arg)}
|
||||
|
||||
//test suite
|
||||
// test suite
|
||||
var o = require("ospec")
|
||||
|
||||
o.spec("call()", function() {
|
||||
|
|
@ -119,13 +119,13 @@ o.spec("call()", function() {
|
|||
A spy can also wrap other functions, like a decorator:
|
||||
|
||||
```javascript
|
||||
//code to be tested
|
||||
// code to be tested
|
||||
var count = 0
|
||||
function inc() {
|
||||
count++
|
||||
}
|
||||
|
||||
//test suite
|
||||
// test suite
|
||||
var o = require("ospec")
|
||||
|
||||
o.spec("call()", function() {
|
||||
|
|
@ -194,7 +194,7 @@ This can also be changed on a per-test basis using the `o.timeout(delay)` functi
|
|||
|
||||
```javascript
|
||||
o("setTimeout calls callback", function(done, timeout) {
|
||||
o.timeout(500) //wait 500ms before bailing out of the test
|
||||
o.timeout(500) // wait 500ms before bailing out of the test
|
||||
|
||||
setTimeout(done, 300)
|
||||
})
|
||||
|
|
@ -258,7 +258,7 @@ o.spec("math", function() {
|
|||
})
|
||||
})
|
||||
|
||||
//tests only run after async hooks complete
|
||||
// tests only run after async hooks complete
|
||||
o("addition", function() {
|
||||
acc += 1
|
||||
|
||||
|
|
@ -303,12 +303,12 @@ o.spec("math", function() {
|
|||
### Running the test suite
|
||||
|
||||
```javascript
|
||||
//define a test
|
||||
// define a test
|
||||
o("addition", function() {
|
||||
o(1 + 1).equals(2)
|
||||
})
|
||||
|
||||
//run the suite
|
||||
// run the suite
|
||||
o.run()
|
||||
```
|
||||
|
||||
|
|
@ -433,7 +433,7 @@ Starts an assertion. There are six types of assertion: `equals`, `notEquals`, `d
|
|||
|
||||
Assertions have this form:
|
||||
|
||||
```
|
||||
```javascript
|
||||
o(actualValue).equals(expectedValue)
|
||||
```
|
||||
|
||||
|
|
@ -441,13 +441,13 @@ As a matter of convention, the actual value should be the first argument and the
|
|||
|
||||
Assertions can also accept an optional description curried parameter:
|
||||
|
||||
```
|
||||
```javascript
|
||||
o(actualValue).equals(expectedValue)("this is a description for this assertion")
|
||||
```
|
||||
|
||||
Assertion descriptions can be simplified using ES6 tagged template string syntax:
|
||||
|
||||
```
|
||||
```javascript
|
||||
o(actualValue).equals(expectedValue) `this is a description for this assertion`
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue