doc-detective 3.0.2 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -14
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -69,21 +69,23 @@ You can find test and config samples in the [samples](https://github.com/doc-det
69
69
 
70
70
  ## Concepts
71
71
 
72
- - [**Test specification**](https://doc-detective.com/docs/references/schemas/specification.html): A group of tests to run in one or more contexts. Conceptually parallel to a document.
73
- - [**Test**](https://doc-detective.com/docs/references/schemas/test.html): A sequence of steps to perform. Conceptually parallel to a procedure.
72
+ - **Test specification**: A group of tests to run in one or more contexts. Conceptually parallel to a document.
73
+ - [**Test**](https://doc-detective.com/docs/get-started/tests): A sequence of steps to perform. Conceptually parallel to a procedure.
74
74
  - **Step**: A portion of a test that includes a single action. Conceptually parallel to a step in a procedure.
75
75
  - **Action**: The task a performed in a step. Doc Detective supports a variety of actions:
76
- - [**checkLink**](https://doc-detective.com/docs/references/schemas/checkLink.html): Check if a URL returns an acceptable status code from a GET request.
77
- - [**find**](https://doc-detective.com/docs/references/schemas/find.html): Check if an element exists with the specified selector.
78
- - [**goTo**](https://doc-detective.com/docs/references/schemas/goTo.html): Navigate to a specified URL.
79
- - [**httpRequest**](https://doc-detective.com/docs/references/schemas/httpRequest.html): Perform a generic HTTP request, for example to an API.
80
- - [**runShell**](https://doc-detective.com/docs/references/schemas/runShell.html): Perform a native shell command.
81
- - [**saveScreenshot**](https://doc-detective.com/docs/references/schemas/saveScreenshot.html): Take a screenshot in PNG format.
82
- - [**setVariables**](https://doc-detective.com/docs/references/schemas/setVariables.html): Load environment variables from a `.env` file.
83
- - [**startRecording**](https://doc-detective.com/docs/references/schemas/startRecording.html) and [**stopRecording**](https://doc-detective.com/docs/references/schemas/stopRecording.html): Capture a video of test execution.
84
- - [**typeKeys**](https://doc-detective.com/docs/references/schemas/typeKeys.html): Type keys. To type special keys, begin and end the string with `$` and use the special key’s enum. For example, to type the Escape key, enter `$ESCAPE$`.
85
- - [**wait**](https://doc-detective.com/docs/references/schemas/wait.html): Pause before performing the next action.
86
- - [**Context**](https://doc-detective.com/docs/references/schemas/context.html): An application and platforms that support the tests.
76
+ - [**checkLink**](https://doc-detective.com/docs/get-started/actions/checkLink): Check if a URL returns an acceptable status code from a GET request.
77
+ - [**click**](https://doc-detective.com/docs/get-started/actions/click): Click an element with the specified text or selector.
78
+ - [**find**](https://doc-detective.com/docs/get-started/actions/find): Check if an element exists with the specified text or selector and optionally interact with it.
79
+ - [**goTo**](https://doc-detective.com/docs/get-started/actions/goTo): Navigate to a specified URL.
80
+ - [**httpRequest**](https://doc-detective.com/docs/get-started/actions/httpRequest): Perform a generic HTTP request, for example to an API.
81
+ - [**runCode**](https://doc-detective.com/docs/get-started/actions/runCode): Execute code, such as how it appears in a code block.
82
+ - [**runShell**](https://doc-detective.com/docs/get-started/actions/runShell): Perform a native shell command.
83
+ - [**screenshot**](https://doc-detective.com/docs/get-started/actions/screenshot): Take a screenshot in PNG format.
84
+ - [**loadVariables**](https://doc-detective.com/docs/get-started/actions/loadVariables): Load environment variables from a `.env` file.
85
+ - [**record**](https://doc-detective.com/docs/get-started/actions/record) and [**stopRecord**](https://doc-detective.com/docs/get-started/actions/stopRecord): Capture a video of test execution.
86
+ - [**type**](https://doc-detective.com/docs/get-started/actions/type): Type keys. To type special keys, begin and end the string with `$` and use the special key’s enum. For example, to type the Escape key, enter `$ESCAPE$`.
87
+ - [**wait**](https://doc-detective.com/docs/get-started/actions/wait): Pause before performing the next action.
88
+ - [**Context**](https://doc-detective.com/docs/get-started/config/contexts): A combination of platform and application to run tests on.
87
89
 
88
90
  ## Develop
89
91
 
@@ -105,4 +107,4 @@ Looking to help out? See our [contributions guide](CONTRIBUTIONS.md) for more in
105
107
 
106
108
  ## License
107
109
 
108
- This project uses the [MIT license](https://github.com/doc-detective/doc-detective/blob/master/LICENSE).
110
+ This project uses the [AGPL-3.0 license](https://github.com/doc-detective/doc-detective/blob/master/LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "doc-detective",
3
- "version": "3.0.2",
3
+ "version": "3.0.3",
4
4
  "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
5
5
  "bin": {
6
6
  "doc-detective": "src/index.js"
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@ffmpeg-installer/ffmpeg": "^1.1.0",
36
36
  "doc-detective-common": "^3.0.2",
37
- "doc-detective-core": "^3.0.4",
37
+ "doc-detective-core": "^3.0.5",
38
38
  "yargs": "^17.7.2"
39
39
  },
40
40
  "devDependencies": {