Skip to content

Commit febfbe3

Browse files
committed
Documentation updates
* Add plugin info and more interface descriptions to api.md * Mention TS reference directives in README * Add content to reporters section in extending.md * Update doc formatting
1 parent 612c9d4 commit febfbe3

14 files changed

+1231
-1051
lines changed

README.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Intern is a complete test system for JavaScript designed to help you write and
2020
run consistent, high-quality test cases for your JavaScript libraries and
2121
applications. It can be used to test _any_ JavaScript code.
2222

23-
* Plain JavaScript code, in any module format (or no module format!)
24-
* Web pages generated by server-side languages (like Java, PHP, or Ruby)
25-
* Native or hybrid iOS, Android, and Firefox OS applications
23+
- Plain JavaScript code, in any module format (or no module format!)
24+
- Web pages generated by server-side languages (like Java, PHP, or Ruby)
25+
- Native or hybrid iOS, Android, and Firefox OS applications
2626

2727
Intern is minimally prescriptive and enforces only a basic set of best practices
2828
designed to ensure your tests stay maintainable over time. Its extensible
@@ -81,20 +81,27 @@ following to your `tsconfig.json`:
8181

8282
```json
8383
{
84-
"compilerOptions": {
85-
"types": ["intern"]
86-
}
84+
"compilerOptions": {
85+
"types": ["intern"]
86+
}
8787
}
8888
```
8989

90+
Alternatively, add a triple-slash directive to the top of your suite files:
91+
92+
```ts
93+
/// <reference types="intern" />
94+
```
95+
9096
## Compatibility
9197

9298
Intern can run unit tests in most browsers that support ECMAScript 5, including
9399
mobile browsers on Android and iOS, and in Node 6+. Note that Internet Explorer
94-
9 is currently not supported.
100+
9 is not supported.
95101

96-
Intern’s self-tests run against IE 10 and 11, Firefox 33 and current, Chrome 38
97-
and current, and Safari 9 and 10, as well as Node 6 and 8.
102+
Intern’s self-tests run against IE 10 and 11, Firefox 36 and current, Chrome 38
103+
and current, and Safari 9 and 10, as well as the latest LTS and current versions
104+
of Node.
98105

99106
Intern can run functional tests using WebDriver-compatible applications and
100107
services, including Selenium, Appium, Selendroid. It has built-in support for
@@ -106,24 +113,24 @@ cloud testing services from [BrowserStack](https://browserstack.com),
106113

107114
## More information
108115

109-
* [Getting started](docs/getting_started.md) - Setting up Intern to test a
110-
project
111-
* [Changes from Intern 3](docs/changes_from_3.md) - Major changes from Intern
112-
3 to Intern 4
113-
* [How To](docs/how_to.md) - Quick answers to common questions
114-
* [Concepts](docs/concepts.md) - General testing concepts and definitions
115-
* [Architecture](docs/architecture.md) - How Intern is organized
116-
* [Configuration](docs/configuration.md) - How to configure Intern
117-
* [Writing tests](docs/writing_tests.md) - The various ways of writing tests
118-
with Intern
119-
* [Running](docs/running.md) - How to run Intern
120-
* [Extending](docs/extending.md) - Extending Intern with reporters and other
121-
plugins
122-
* [API](docs/api.md) - Summary API documentation
123-
* [Continuous integration](docs/ci.md) - Using Intern with CI systems
124-
* [Developing](docs/developing.md) - For Intern developers
125-
* [Contributing](CONTRIBUTING.md) - How to contribute to Intern development
126-
<!-- end-github-only -->
116+
- [Getting started](docs/getting_started.md) - Setting up Intern to test a
117+
project
118+
- [Changes from Intern 3](docs/changes_from_3.md) - Major changes from Intern 3
119+
to Intern 4
120+
- [How To](docs/how_to.md) - Quick answers to common questions
121+
- [Concepts](docs/concepts.md) - General testing concepts and definitions
122+
- [Architecture](docs/architecture.md) - How Intern is organized
123+
- [Configuration](docs/configuration.md) - How to configure Intern
124+
- [Writing tests](docs/writing_tests.md) - The various ways of writing tests
125+
with Intern
126+
- [Running](docs/running.md) - How to run Intern
127+
- [Extending](docs/extending.md) - Extending Intern with reporters and other
128+
plugins
129+
- [API](docs/api.md) - Summary API documentation
130+
- [Continuous integration](docs/ci.md) - Using Intern with CI systems
131+
- [Developing](docs/developing.md) - For Intern developers
132+
- [Contributing](CONTRIBUTING.md) - How to contribute to Intern development
133+
<!-- end-github-only -->
127134

128135
## Get help
129136

0 commit comments

Comments
 (0)