Skip to content

Commit

Permalink
build(deps-dev): cspell package
Browse files Browse the repository at this point in the history
  • Loading branch information
cdcabrera committed Jan 28, 2023
1 parent 9c1825d commit 3aaefe4
Show file tree
Hide file tree
Showing 4 changed files with 592 additions and 15 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The basic requirements:

## Use

Generate a "happy path" mock server from [apidoc](http://apidocjs.com/) `@apiSucceessExample` annotations. Once the
Generate a "happy path" mock server from [apidoc](http://apidocjs.com/) `@apiSuccessExample` annotations. Once the
server is setup correctly you should be able update your code comments/annotations and have the mock(s) update with a
browser refresh.

Expand All @@ -30,13 +30,13 @@ browser refresh.
NPM install...

```shell
$ npm i apidock-mock
$ npm i apidoc-mock
```

or Yarn

```shell
$ yarn add apidock-mock
$ yarn add apidoc-mock
```

#### Usage
Expand Down Expand Up @@ -89,7 +89,7 @@ From there you should be able to navigate to
**Using ApiDocs**
> The v0.5X.X+ range of ApiDocs, now, requires the description with its updated template (i.e. `@api {get} /hello/world/ [a description]`) if you want the docs to display. If you don't use that aspect of this package you can continue to leave it out.
1. Setup your API annotations first. `@apiSucceessExample` is the only apiDoc example currently implemented.
1. Setup your API annotations first. `@apiSuccessExample` is the only apiDoc example currently implemented.
```js
/**
* @api {get} /hello/world/ Get
Expand Down
16 changes: 16 additions & 0 deletions cspell.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"language": "en",
"words": [
"apidoc",
"apidocs",
"apimock",
"cdcabrera",
"codecov",
"delayresponse",
"forcestatus",
"forcedstatus",
"randomresponse",
"randomsuccess",
"randomerror"
]
}
10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,17 @@
"release": "changelog",
"start": "./bin/cli.js -w ./data",
"start:dev": "nodemon --watch data --watch src './bin/cli.js -w ./data'",
"test": "run-s -l test:lint test:ci",
"test": "run-s -l test:lint test:spell* test:ci",
"test:ci": "export CI=true; jest --collectCoverage",
"test:clearCache": "jest --clearCache",
"test:deps": "rm -rf ./.docs; run-s test",
"test:dev": "rm -rf ./.docs; eslint ./src; jest --watch",
"test:dev": "rm -rf ./.docs; eslint ./src; run-s test:spell test:local",
"test:integration": "jest --roots=./tests",
"test:integration-dev": "jest --roots=./tests --watchAll",
"test:lint": "eslint ./src ./bin ./data"
"test:lint": "eslint ./src ./bin ./data",
"test:local": "jest --watch",
"test:spell-docs": "cspell ./README.md ./CONTRIBUTING.md --config ./cspell.config.json",
"test:spell": "cspell './src/**/*.js' './tests/**/*.js' --config ./cspell.config.json"
},
"jest": {
"roots": [
Expand Down Expand Up @@ -68,6 +71,7 @@
},
"devDependencies": {
"changelog-light": "^0.2.3",
"cspell": "^6.18.1",
"eslint": "^8.31.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-babel": "^5.3.1",
Expand Down
Loading

0 comments on commit 3aaefe4

Please sign in to comment.