Skip to content

docs: add typescript & angular usage section #10

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 2 commits into from
Dec 18, 2020

Conversation

brrianalexis
Copy link
Member

  • Documentation
  • Ready to be merged

@codecov
Copy link

codecov bot commented Dec 15, 2020

Codecov Report

Merging #10 (7ae0816) into master (8e61829) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #10   +/-   ##
=======================================
  Coverage   99.49%   99.49%           
=======================================
  Files          21       21           
  Lines         596      596           
=======================================
  Hits          593      593           
  Misses          3        3           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8e61829...7ae0816. Read the comment docs.

Copy link

@IanIsFluent IanIsFluent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks! Just some tiny changes suggested 👍

README.md Outdated
@@ -122,7 +124,19 @@ beforeAll(() => {
});
```

That's it! You're good to go.
### With Karma and TypeScript in an Angular project
Copy link

@IanIsFluent IanIsFluent Dec 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To match the title above this should be 'With TypeScript'.

Maybe add (eg. Angular)? nah, I think the difference is really the language...

README.md Outdated
That's it! You're good to go.
### With Karma and TypeScript in an Angular project

Add to the existing `types` array in `tsconfig.spec.json`: `"@testing-library/jasmine-dom"`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "@testing-library/jasmine-dom" to types in the tests tsconfig (tsconfig.spec.json in an Angular project).

Example:

compilerOptions:
  types: ["jasmine", "node", "@testing-library/jasmine-dom"],.

README.md Outdated

Add to the existing `types` array in `tsconfig.spec.json`: `"@testing-library/jasmine-dom"`

In your tests setup file, import jasmine-dom like so:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In your tests setup file (test.ts in an Angular project), import jasmine-dom and add to the Jasmine matchers like so:

Copy link

@IanIsFluent IanIsFluent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@brrianalexis brrianalexis merged commit 2443072 into testing-library:master Dec 18, 2020
@brrianalexis brrianalexis deleted the angular-docs branch December 18, 2020 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants