-
-
Notifications
You must be signed in to change notification settings - Fork 574
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
Add TypeScript type definitions #801
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1ceb0c0
Add dtslint and @types/node
skovy 15e044e
Assert the types are valid in CI
skovy e33ed5f
Create the tsconfig for validating types
skovy 2525ff8
Port (copy/paste) existing types from DefinitelyTyped
skovy fb241dc
Add the types key and include in the package
skovy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,4 +10,5 @@ script: | |
- npm run test | ||
after_script: | ||
- npm run coveralls | ||
- npm run dtslint | ||
sudo: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
// TypeScript Version: 3.0 | ||
|
||
/// <reference types="node" /> | ||
|
||
import * as fs from "fs"; | ||
import { EventEmitter } from "events"; | ||
|
||
/** | ||
* The object's keys are all the directories (using absolute paths unless the `cwd` option was | ||
* used), and the values are arrays of the names of the items contained in each directory. | ||
*/ | ||
export interface WatchedPaths { | ||
[directory: string]: string[]; | ||
} | ||
|
||
export class FSWatcher extends EventEmitter implements fs.FSWatcher { | ||
/** | ||
* Constructs a new FSWatcher instance with optional WatchOptions parameter. | ||
*/ | ||
constructor(options?: WatchOptions); | ||
|
||
/** | ||
* Add files, directories, or glob patterns for tracking. Takes an array of strings or just one | ||
* string. | ||
*/ | ||
add(paths: string | string[]): void; | ||
|
||
/** | ||
* Stop watching files, directories, or glob patterns. Takes an array of strings or just one | ||
* string. | ||
*/ | ||
unwatch(paths: string | string[]): void; | ||
|
||
/** | ||
* Returns an object representing all the paths on the file system being watched by this | ||
* `FSWatcher` instance. The object's keys are all the directories (using absolute paths unless | ||
* the `cwd` option was used), and the values are arrays of the names of the items contained in | ||
* each directory. | ||
*/ | ||
getWatched(): WatchedPaths; | ||
|
||
/** | ||
* Removes all listeners from watched files. | ||
*/ | ||
close(): void; | ||
} | ||
|
||
export interface WatchOptions { | ||
/** | ||
* Indicates whether the process should continue to run as long as files are being watched. If | ||
* set to `false` when using `fsevents` to watch, no more events will be emitted after `ready`, | ||
* even if the process continues to run. | ||
*/ | ||
persistent?: boolean; | ||
|
||
/** | ||
* ([anymatch](https://github.com/es128/anymatch)-compatible definition) Defines files/paths to | ||
* be ignored. The whole relative or absolute path is tested, not just filename. If a function | ||
* with two arguments is provided, it gets called twice per path - once with a single argument | ||
* (the path), second time with two arguments (the path and the | ||
* [`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats) object of that path). | ||
*/ | ||
ignored?: any; | ||
|
||
/** | ||
* If set to `false` then `add`/`addDir` events are also emitted for matching paths while | ||
* instantiating the watching as chokidar discovers these file paths (before the `ready` event). | ||
*/ | ||
ignoreInitial?: boolean; | ||
|
||
/** | ||
* When `false`, only the symlinks themselves will be watched for changes instead of following | ||
* the link references and bubbling events through the link's path. | ||
*/ | ||
followSymlinks?: boolean; | ||
|
||
/** | ||
* The base directory from which watch `paths` are to be derived. Paths emitted with events will | ||
* be relative to this. | ||
*/ | ||
cwd?: string; | ||
|
||
/** | ||
* If set to true then the strings passed to .watch() and .add() are treated as literal path | ||
* names, even if they look like globs. Default: false. | ||
*/ | ||
disableGlobbing?: boolean; | ||
|
||
/** | ||
* Whether to use fs.watchFile (backed by polling), or fs.watch. If polling leads to high CPU | ||
* utilization, consider setting this to `false`. It is typically necessary to **set this to | ||
* `true` to successfully watch files over a network**, and it may be necessary to successfully | ||
* watch files in other non-standard situations. Setting to `true` explicitly on OS X overrides | ||
* the `useFsEvents` default. | ||
*/ | ||
usePolling?: boolean; | ||
|
||
/** | ||
* Whether to use the `fsevents` watching interface if available. When set to `true` explicitly | ||
* and `fsevents` is available this supercedes the `usePolling` setting. When set to `false` on | ||
* OS X, `usePolling: true` becomes the default. | ||
*/ | ||
useFsEvents?: boolean; | ||
|
||
/** | ||
* If relying upon the [`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats) object that | ||
* may get passed with `add`, `addDir`, and `change` events, set this to `true` to ensure it is | ||
* provided even in cases where it wasn't already available from the underlying watch events. | ||
*/ | ||
alwaysStat?: boolean; | ||
|
||
/** | ||
* If set, limits how many levels of subdirectories will be traversed. | ||
*/ | ||
depth?: number; | ||
|
||
/** | ||
* Interval of file system polling. | ||
*/ | ||
interval?: number; | ||
|
||
/** | ||
* Interval of file system polling for binary files. ([see list of binary extensions](https://gi | ||
* thub.com/sindresorhus/binary-extensions/blob/master/binary-extensions.json)) | ||
*/ | ||
binaryInterval?: number; | ||
|
||
/** | ||
* Indicates whether to watch files that don't have read permissions if possible. If watching | ||
* fails due to `EPERM` or `EACCES` with this set to `true`, the errors will be suppressed | ||
* silently. | ||
*/ | ||
ignorePermissionErrors?: boolean; | ||
|
||
/** | ||
* `true` if `useFsEvents` and `usePolling` are `false`). Automatically filters out artifacts | ||
* that occur when using editors that use "atomic writes" instead of writing directly to the | ||
* source file. If a file is re-added within 100 ms of being deleted, Chokidar emits a `change` | ||
* event rather than `unlink` then `add`. If the default of 100 ms does not work well for you, | ||
* you can override it by setting `atomic` to a custom value, in milliseconds. | ||
*/ | ||
atomic?: boolean | number; | ||
|
||
/** | ||
* can be set to an object in order to adjust timing params: | ||
*/ | ||
awaitWriteFinish?: AwaitWriteFinishOptions | boolean; | ||
} | ||
|
||
export interface AwaitWriteFinishOptions { | ||
/** | ||
* Amount of time in milliseconds for a file size to remain constant before emitting its event. | ||
*/ | ||
stabilityThreshold?: number; | ||
|
||
/** | ||
* File size polling interval. | ||
*/ | ||
pollInterval?: number; | ||
} | ||
|
||
/** | ||
* produces an instance of `FSWatcher`. | ||
*/ | ||
export function watch( | ||
paths: string | string[], | ||
options?: WatchOptions | ||
): FSWatcher; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
import * as fs from "fs"; | ||
import chokidar from "chokidar"; | ||
|
||
const watcher = chokidar.watch("file, dir, or glob", { | ||
ignored: /[\/\\]\./, | ||
persistent: true | ||
}); | ||
|
||
const log = console.log.bind(console); | ||
|
||
watcher | ||
.on("add", (path: string) => { | ||
log("File", path, "has been added"); | ||
}) | ||
.on("addDir", (path: string) => { | ||
log("Directory", path, "has been added"); | ||
}) | ||
.on("change", (path: string) => { | ||
log("File", path, "has been changed"); | ||
}) | ||
.on("unlink", (path: string) => { | ||
log("File", path, "has been removed"); | ||
}) | ||
.on("unlinkDir", (path: string) => { | ||
log("Directory", path, "has been removed"); | ||
}) | ||
.on("error", (error: any) => { | ||
log("Error happened", error); | ||
}) | ||
.on("ready", () => { | ||
log("Initial scan complete. Ready for changes."); | ||
}) | ||
.on("raw", (event: string, path: string, details: any) => { | ||
log("Raw event info:", event, path, details); | ||
}); | ||
|
||
// 'add', 'addDir' and 'change' events also receive stat() results as second | ||
// argument when available: http://nodejs.org/api/fs.html#fs_class_fs_stats | ||
watcher.on("change", (path: string, stats: fs.Stats) => { | ||
if (stats) { | ||
console.log("File", path, "changed size to", stats.size); | ||
} | ||
}); | ||
|
||
// Watch new files. | ||
watcher.add("new-file"); | ||
watcher.add(["new-file-2", "new-file-3", "**/other-file*"]); | ||
|
||
// Un-watch some files. | ||
watcher.unwatch("new-file*"); | ||
|
||
// Only needed if watching is `persistent: true`. | ||
watcher.close(); | ||
|
||
// One-liner | ||
chokidar | ||
.watch(".", { ignored: /[\/\\]\./ }) | ||
.on("all", (event: string, path: string) => { | ||
console.log(event, path); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"compilerOptions": { | ||
"module": "commonjs", | ||
"lib": ["es6"], | ||
"noImplicitAny": true, | ||
"noImplicitThis": true, | ||
"strictNullChecks": true, | ||
"strictFunctionTypes": true, | ||
"noEmit": true, | ||
"esModuleInterop": true, | ||
"baseUrl": ".", | ||
"paths": { "chokidar": ["."] } | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Defining the specific version here works here. But I wanted to dump everything below that I looked into because someone more knowledgeable about
dtslint
might know more?From what I understand, by default
dtslint
will check all minor versions starting from2.0
up tonext
. Currently, that is2.0
,2.1
, ...,3.3
,next
(will be3.4.
).@types/parsimmon
is a depedency ofdtslint
: (seems like types generally aredevDependencies
)yarn why @types/parsimmon
And running
dtslint
without the version defined here was erroring:Output of dtslint types
I also tried adding
"files": ["index.d.ts", "test.ts"]
totypes/tsconfig.json
to only run against those files and"exclude": ["../node_modules"]
and"exclude": ["node_modules"]
but none worked for me.Lastly, the current version of TS is
3.3
but going above3.0
here errored withError: Don't use
// TypeScript Versionfor newer TS versions, use typesVerisons instead
. It seemstypeVersions
isn't necessary currently since only a single version of types will be provided? (see here for more info ontypeVersions
)