From 881d780287d9c04f438828967e7a5745fa6e4bb2 Mon Sep 17 00:00:00 2001 From: Erik Demaine Date: Fri, 10 Aug 2018 06:29:16 -0400 Subject: [PATCH] Rename Screenshotter -> screenshotter (#1573) Fix #1570 --- .circleci/config.yml | 2 +- CONTRIBUTING.md | 2 +- dockers/{Screenshotter => screenshotter}/README.md | 8 ++++---- dockers/{Screenshotter => screenshotter}/screenshotter.js | 0 dockers/{Screenshotter => screenshotter}/screenshotter.sh | 0 package.json | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) rename dockers/{Screenshotter => screenshotter}/README.md (91%) rename dockers/{Screenshotter => screenshotter}/screenshotter.js (100%) rename dockers/{Screenshotter => screenshotter}/screenshotter.sh (100%) diff --git a/.circleci/config.yml b/.circleci/config.yml index d2406e19..ad691d44 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -29,7 +29,7 @@ screenshotter: &screenshotter - run: name: Verify screenshots and generate diffs and new screenshots - command: node dockers/Screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new + command: node dockers/screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new - store_artifacts: path: test/screenshotter/new diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bec6126..626b9487 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,7 +97,7 @@ You can view the report in `coverage/lcov-report/index.html`. To ensure the final output looks good, we screenshot different expressions. These tests can be run by using the -[Screenshotter docker](https://github.com/Khan/KaTeX/tree/master/dockers/Screenshotter). +[screenshotter docker](https://github.com/Khan/KaTeX/tree/master/dockers/screenshotter). The screenshot tests should be run if you add anything more significant than individual symbols. These tests are not automatically run, so please remember! diff --git a/dockers/Screenshotter/README.md b/dockers/screenshotter/README.md similarity index 91% rename from dockers/Screenshotter/README.md rename to dockers/screenshotter/README.md index d7ae9750..811dc504 100644 --- a/dockers/Screenshotter/README.md +++ b/dockers/screenshotter/README.md @@ -21,7 +21,7 @@ are encouraged to reproduce the steps from `screenshotter.sh` manually. Example run for Firefox: container=$(docker run -d -P selenium/standalone-firefox:2.46.0) - node dockers/Screenshotter/screenshotter.js -b firefox -c ${container} + node dockers/screenshotter/screenshotter.js -b firefox -c ${container} # possibly repeat the above command as often as you need, then eventually docker stop ${container} docker rm ${container} @@ -33,7 +33,7 @@ For Chrome, simply replace both occurrences of `firefox` with `chrome`. It is possible to run `screenshotter.js` without the use of Docker: yarn add selenium-webdriver - node dockers/Screenshotter/screenshotter.js + node dockers/screenshotter/screenshotter.js This will generate screenshots using the Firefox installed on your system. Browsers other than Firefox can be targeted using the `--browser` option. @@ -62,8 +62,8 @@ to specify a list of cases which are not being processed. Examples: - node dockers/Screenshotter/screenshotter.js -i Sqrt,SqrtRoot - dockers/Screenshotter/screenshotter.sh --exclude=GreekLetters + node dockers/screenshotter/screenshotter.js -i Sqrt,SqrtRoot + dockers/screenshotter/screenshotter.sh --exclude=GreekLetters # How to run screenshotter tests diff --git a/dockers/Screenshotter/screenshotter.js b/dockers/screenshotter/screenshotter.js similarity index 100% rename from dockers/Screenshotter/screenshotter.js rename to dockers/screenshotter/screenshotter.js diff --git a/dockers/Screenshotter/screenshotter.sh b/dockers/screenshotter/screenshotter.sh similarity index 100% rename from dockers/Screenshotter/screenshotter.sh rename to dockers/screenshotter/screenshotter.sh diff --git a/package.json b/package.json index 693e554b..faf24b7d 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,7 @@ "test:jest:update": "jest --updateSnapshot", "test:jest:coverage": "jest --coverage", "test:screenshots": "yarn test:screenshots:update --verify", - "test:screenshots:update": "yarn prestart && dockers/Screenshotter/screenshotter.sh", + "test:screenshots:update": "yarn prestart && dockers/screenshotter/screenshotter.sh", "test:perf": "yarn prestart && NODE_ENV=test node test/perf-test.js", "clean": "rm -rf dist/ node_modules/", "clean-install": "yarn clean && yarn",