Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove generated typescript definitions #386

Merged
merged 5 commits into from
Jun 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
> 0.5%
last 2 versions
Firefox ESR
not dead
not IE 11
not op_mini all
maintained node versions
3 changes: 0 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,6 @@ jobs:
- run:
name: Test
command: npm run test-node
- run:
name: Test types
command: npm run build && npm run test-types

chromium:
docker:
Expand Down
6 changes: 0 additions & 6 deletions .eslintrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,3 @@ overrides:
rules:
max-nested-callbacks: off
mocha/no-exclusive-tests: error
- files: "test/**.ts"
parserOptions:
ecmaVersion: 2020
sourceType: 'module'
rules:
no-unused-expressions: off
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,12 @@ wait.

`@sinonjs/fake-timers` is extracted from [Sinon.JS](https://github.com/sinonjs/sinon.js) and targets the [same runtimes](https://sinonjs.org/releases/latest/#supported-runtimes).

## Help us get our TypeScript definitions production ready!
## Autocomplete, IntelliSense and TypeScript definitions

In version 7 we introduced TypeScript definitions that are generated from our JSDoc. This makes importing types from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/sinonjs__fake-timers/index.d.ts) superfluous, but we have just gotten started and we need your work for this to be up to the same quality. Until that happens typings from DefinitelyTyped still can be used:

```sh
npm install -D @types/sinonjs__fake-timers
```

Add this to tsconfig.json
Version 7 introduced JSDoc to the codebase. This should provide autocomplete and type suggestions in supporting IDEs. If you need more elaborate type support, TypeScript definitions for the Sinon projects are independently maintained by the Definitely Types community:

```
{
"compilerOptions": {
...
"paths": {
...
"@sinonjs/fake-timers": ["node_modules/@types/sinonjs__fake-timers"]
}
}
}
npm install -D @types/sinonjs__fake-timers
```

## Installation
Expand Down
Loading