-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Auto generate TypeScript definition to allow chaining #884
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
02f0986
Generate type definitions that allow chaining
ivogabe cf9a7b4
Add `notRegex` to TypeScript definitions
ivogabe 724f1e4
Change ava to AVA
ivogabe 4cf7bd5
Address PR feedback & linting errors
ivogabe a275089
Address code review
ivogabe 7a3b4ed
Add types/generated.d.ts to gitignore
ivogabe 54a8324
Add TS generation script as republish script
ivogabe 984184b
Support Node 4 in TS generation script
ivogabe ef6e73f
Fix linting issue
ivogabe 43cd1f8
Run TS generation script on old NodeJS versions using Babel
ivogabe 353d104
Merge remote-tracking branch 'avajs/master' into types-generator
ivogabe 8008357
Use babel-node
ivogabe d7c4fcb
Accept PromiseLike instead of Promise (#960)
ivogabe 322445d
Configure babel-node
ivogabe 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 hidden or 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 |
---|---|---|
|
@@ -2,3 +2,4 @@ node_modules | |
.nyc_output | ||
coverage | ||
bench/.results | ||
types/generated.d.ts |
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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 hidden or 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 hidden or 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,124 @@ | ||
export default test; | ||
|
||
export type ErrorValidator | ||
= (new (...args: any[]) => any) | ||
| RegExp | ||
| string | ||
| ((error: any) => boolean); | ||
|
||
export interface Observable { | ||
subscribe(observer: (value: {}) => void): void; | ||
} | ||
|
||
export type Test = (t: TestContext) => PromiseLike<void> | Iterator<any> | Observable | void; | ||
export type ContextualTest = (t: ContextualTestContext) => PromiseLike<void> | Iterator<any> | Observable | void; | ||
export type CallbackTest = (t: CallbackTestContext) => void; | ||
export type ContextualCallbackTest = (t: ContextualCallbackTestContext) => void; | ||
|
||
export interface AssertContext { | ||
/** | ||
* Passing assertion. | ||
*/ | ||
pass(message?: string): void; | ||
/** | ||
* Failing assertion. | ||
*/ | ||
fail(message?: string): void; | ||
/** | ||
* Assert that value is truthy. | ||
*/ | ||
truthy(value: any, message?: string): void; | ||
/** | ||
* Assert that value is falsy. | ||
*/ | ||
falsy(value: any, message?: string): void; | ||
/** | ||
* DEPRECATED, use `truthy`. Assert that value is truthy. | ||
*/ | ||
ok(value: any, message?: string): void; | ||
/** | ||
* DEPRECATED, use `falsy`. Assert that value is falsy. | ||
*/ | ||
notOk(value: any, message?: string): void; | ||
/** | ||
* Assert that value is true. | ||
*/ | ||
true(value: boolean, message?: string): void; | ||
/** | ||
* Assert that value is false. | ||
*/ | ||
false(value: boolean, message?: string): void; | ||
/** | ||
* Assert that value is equal to expected. | ||
*/ | ||
is<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* Assert that value is not equal to expected. | ||
*/ | ||
not<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* Assert that value is deep equal to expected. | ||
*/ | ||
deepEqual<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* Assert that value is not deep equal to expected. | ||
*/ | ||
notDeepEqual<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* Assert that function throws an error or promise rejects. | ||
* DEPRECATED, use `deepEqual`. Assert that value is deep equal to expected. | ||
* @param error Can be a constructor, regex, error message or validation function. | ||
*/ | ||
same<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* DEPRECATED use `notDeepEqual`. Assert that value is not deep equal to expected. | ||
*/ | ||
notSame<U>(value: U, expected: U, message?: string): void; | ||
/** | ||
* Assert that function throws an error or promise rejects. | ||
* @param error Can be a constructor, regex, error message or validation function. | ||
*/ | ||
throws(value: PromiseLike<any>, error?: ErrorValidator, message?: string): Promise<any>; | ||
throws(value: () => void, error?: ErrorValidator, message?: string): any; | ||
/** | ||
* Assert that function doesn't throw an error or promise resolves. | ||
*/ | ||
notThrows<U>(value: PromiseLike<U>, message?: string): Promise<U>; | ||
notThrows(value: () => void, message?: string): void; | ||
/** | ||
* Assert that contents matches regex. | ||
*/ | ||
regex(contents: string, regex: RegExp, message?: string): void; | ||
/** | ||
* Assert that contents does not match regex. | ||
*/ | ||
notRegex(contents, regex, message?: string): void; | ||
/** | ||
* Assert that error is falsy. | ||
*/ | ||
ifError(error: any, message?: string): void; | ||
} | ||
export interface TestContext extends AssertContext { | ||
/** | ||
* Plan how many assertion there are in the test. | ||
* The test will fail if the actual assertion count doesn't match planned assertions. | ||
*/ | ||
plan(count: number): void; | ||
|
||
skip: AssertContext; | ||
} | ||
export interface CallbackTestContext extends TestContext { | ||
/** | ||
* End the test. | ||
*/ | ||
end(): void; | ||
} | ||
export interface ContextualTestContext extends TestContext { | ||
context: any; | ||
} | ||
export interface ContextualCallbackTestContext extends CallbackTestContext { | ||
context: any; | ||
} | ||
|
||
export function test(name: string, run: ContextualTest): void; | ||
export function test(run: ContextualTest): void; |
Oops, something went wrong.
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.
Should we wrap these options in a generator function? So we aren't exporting a mutable copy?
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.
@jamestalmage Doesn't matter. It's for internal use only.