o2r-project / erc-checker

JavaScript library and CLI tool for ERC validation and comparison result checking
https://o2r.info/erc-checker/
Apache License 2.0
0 stars 4 forks source link

First version of erc-checker for HTML files, images only #2

Closed Timmimim closed 7 years ago

Timmimim commented 7 years ago

What I have done so far:


Next planned steps will be:

  1. ERC execution and retrieving the reproduced HTML paper
  2. defining output locations for original, reproduced and diff-ed HTML files, plus name-conventions; current output locations are only chosen for testing
  3. at some point updating the main README.md to a reasonable level
nuest commented 7 years ago

I understand your excitement, but please change the title of the PR to something more descriptive and consequently more useful.

nuest commented 7 years ago

So, I assume the tests are still under development. Looking forward to see updates on this PR.

Another question: _Why is SH_Script_Extract_Original_Paper_Before_Container-Start/extract_original_paper_from_ERC.sh a shell script and not written in JavaScript?_

Timmimim commented 7 years ago

Tests are under development, I have not worked with Mocha before and am learning it now. Along with writing tests, I will change the name and structure of the current test-files directory.

_extract_original_paper_from_ERC.sh_ was built as a shell script during development to speed up the task of, well, extracting the original paper from the image.tar file of any ERC. It can be rewritten to JavaScript, of course, and I will do so ASAP.

Then, after rewriting the shell script into JS and writing tests, I will update the README.md file.

nuest commented 7 years ago

Well, if the shell script is only a util script for development, then I am fine with it being a shell script! It was just not clear to me if that script was targeted at developers or users.

I'd recommend leaving it a shell script then, but not documenting it in the main README not to confuse regular users... maybe add a developer readme, and put the shell script into a dir /etc ?

Timmimim commented 7 years ago

README.md is updated, and test/ now includes a test for the check request handling in index.js.