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

Add tests #51

Closed
Mr0grog opened this issue Apr 13, 2023 · 0 comments · Fixed by #52
Closed

Add tests #51

Mr0grog opened this issue Apr 13, 2023 · 0 comments · Fixed by #52
Assignees
Labels
enhancement New feature or request

Comments

@Mr0grog
Copy link
Owner

Mr0grog commented Apr 13, 2023

This tool needs tests! Making changes has always been fiddly, and there should really be some automated tests to make sure things don’t break. Since folks are also looking for library-style and CLI usage in the future (see #42), they need to be able to run both in browsers and in Node.js.

  • Unit tests on the actual conversion of some Google Docs HTML strings → Markdown strings are the most important thing here.
  • Some real simple end-to-end tests (“I pasted something in the paste box and got the right markdown in the output box”) would be great, too, but aren’t critical.
  • We need some fixtures that are actual Google Docs. The HTML formats we get from copying or exporting might change over time, so we really want an actual doc to test against. We might add a script to download the docs as HTML to store in the repo, so we can easily update the fixtures any time.
  • Technologically, Karma + Mocha is probably the most straightforward here, since the tests can be written in a way that aren’t tied to a browser (because we also eventually want CLI usage, which means running in Node.js, too).
@Mr0grog Mr0grog mentioned this issue Apr 13, 2023
7 tasks
@Mr0grog Mr0grog changed the title Have at least some basic tests for the library code. Add tests Apr 13, 2023
@Mr0grog Mr0grog self-assigned this Apr 13, 2023
@Mr0grog Mr0grog added the enhancement New feature or request label Apr 13, 2023
@Mr0grog Mr0grog mentioned this issue Apr 13, 2023
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant