tomseldon / word-to-markdown Goto Github PK

Content service exposes getDocumentAsHtml method, but actually just gets the selected text.

Since moving to using TypeScript, the coverage reports either fail or are wrong. This needs to be fixed so we can go back to failing CI builds at a certain threshold (see #20).

Need to set an appropriate threshold value. Probably 90% per file.

Add Gulp task to lint / check code style

Should be able to run a Gulp task to run unit tests:

• Continuously, to enable TDD
• Single run, for CI

Blocked as we need an OOXML to HTML parser. For desktop, we can get the selected text using HTML as the coercion type. This isn't available using the online version of Word.

• Create Gulp task(s) to run Protractor
• Add sample feature file / steps to confirm that Protractor can run correctly

Could use Jasmine or Cucumber to write the tests. Preference for Cucumber, but not sure having the tests written in Gherkin adds much value in this case.

• Set up Sauce Labs account for this repo
• Configure Travis to run the end-to-end tests with Sauce Labs

We can use this gist https://gist.github.com/chaosmail/938d7db693f72adb287b

Files should meet the threshold set in #20

Change repo name from hackathon to word-to-markdown.

For desktop, we can get the selected text using HTML as the coercion type. It's unknown if this is available on the mobile version. If not, we need to investigate what coercion types are available and if we'll need an additional parser.

Blocked as no linting or code style checks in place yet

Fix issues with:

• Source files
• Config file(s)
• Unit tests
• Gulp tasks

The app is bootstrapped when Office.initialise is called. This is never called in non-Office environments (such as for developing in-browser or running e2e tests).

To work around this right now we just set a timeout for a time when the app should have been bootstrapped and if it hasn't, we expose a function on window to manually bootstrap the app.

This makes development a pain and ideally it should be an automatic bootstrapping process when in a dev or test environment.

Proposed solution:

Set an environment var at build time which we can read in app.module.js. If it's test or development then we should bootstrap the app on document.ready rather than Office.initialise.

App can be incrementally changed over to TypeScript. This is a nice to have and I'll probably look at this after first release.

Blocked as no linting or code style checks in place yet

Existing set of features aren't covered by any functional tests. There should be some in place to help protect against regression.

For desktop, we can get the selected text using HTML as the coercion type. It's unknown if this is available on the mobile version. If not, we need to investigate what coercion types are available and if we'll need an additional parser.

Blocked as we need an OOXML to HTML parser.

When converting the HTML returned by getSelectedDataAsync it contains a comment with formatting and style data. This isn't being stripped away when converting to markdown.