Import the JS Envs projects from the Scala.js core repository.

[sjrd]

This is the initial import of the JS Envs projects (scalajs-js-envs, scalajs-js-envs-test-kit and scalajs-env-nodejs) from the Scala.js core repository. The history of this commit reflects the entire history of relevant files from the core repo, filter-branch'ed to appear as if they had always been in this repo. This commit adds the specific setup of the build and tests.

---

This has been done similarly to scala-js/scala-js-env-phantomjs#1 and scala-js/scala-js-env-jsdom-nodejs#1.

The history was obtained as follows, starting from commit scala-js/scala-js@c82fa8c of the core repo.

First, we identified all the paths where relevant files have lived in the past, through renamings along their history. A useful command:

$ git log --stat -- js-envs nodejs-env/ js-envs-test-kit/ js-envs-test-suite tools/jvm/src/main/scala/scala/scalajs/tools/env/ tools/shared/src/main/scala/scala/scalajs/tools/env/ tools/src/main/scala/scala/scalajs/tools/env/ sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/ sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/JSUtils.scala sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/ tools/jvm/src/test/scala/scala/scalajs/tools/env/ tools/shared/src/test/scala/scala/scalajs/tools/env/ tools/src/test/scala/scala/scalajs/tools/env/

This is the list:

js-envs/
nodejs-env/
js-envs-test-kit/
js-envs-test-suite/
tools/shared/src/main/scala/scala/scalajs/tools/env/
tools/shared/src/test/scala/scala/scalajs/tools/env/
tools/jvm/src/main/scala/scala/scalajs/tools/env/
tools/jvm/src/test/scala/scala/scalajs/tools/env/
tools/src/main/scala/scala/scalajs/tools/env/
tools/src/test/scala/scala/scalajs/tools/env/
sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/JSUtils.scala
sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/
sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/

Based on that, we filter-branch'ed to keep only those files, using the following incantation, inspired by http://stackoverflow.com/a/6006679/1829647:

git filter-branch \
    --prune-empty \
    --index-filter '
  git ls-tree -z -r --name-only --full-tree $GIT_COMMIT \
    | grep -z -v "^js-envs/" \
    | grep -z -v "^nodejs-env/" \
    | grep -z -v "^js-envs-test-kit/" \
    | grep -z -v "^js-envs-test-suite/" \
    | grep -z -v "^tools/shared/src/main/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^tools/shared/src/test/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^tools/jvm/src/main/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^tools/jvm/src/test/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^tools/src/main/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^tools/src/test/scala/scala/scalajs/tools/env/" \
    | grep -z -v "^sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/JSUtils.scala$" \
    | grep -z -v "^sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/" \
    | grep -z -v "^sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/" \
    | xargs -0 -r git rm -r --cached
  ' HEAD

That gave the result visible in https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-1. However that includes the files specific to Rhino, PhantomJS and JSDOMNodeJSEnv, which we want to get rid off. We do this with:

git filter-branch \
    --prune-empty \
    --index-filter '
  git rm -r --cached --ignore-unmatch \
    js-envs/src/main/scala/org/scalajs/jsenv/jsdomnodejs/ \
    js-envs/src/main/scala/org/scalajs/jsenv/nodejs/JSDOMNodeJSEnv.scala \
    js-envs/src/main/scala/org/scalajs/jsenv/phantomjs/ \
    js-envs/src/main/scala/org/scalajs/jsenv/RetryingComJSEnv.scala \
    js-envs/src/main/scala/org/scalajs/jsenv/rhino/ \
    js-envs/src/test/scala/org/scalajs/jsenv/test/JSDOMNodeJSEnvTest.scala \
    js-envs/src/test/scala/org/scalajs/jsenv/test/PhantomJSTest.scala \
    js-envs/src/test/scala/org/scalajs/jsenv/test/RetryingComJSEnvTest.scala \
    js-envs/src/test/scala/org/scalajs/jsenv/test/RhinoJSEnvTest.scala \
    js-envs-test-suite/src/test/scala/org/scalajs/jsenv/test/JSDOMNodeJSEnvTest.scala \
    js-envs-test-suite/src/test/scala/org/scalajs/jsenv/test/PhantomJSTest.scala \
    js-envs-test-suite/src/test/scala/org/scalajs/jsenv/test/PhantomJSWithCustomInitFilesTest.scala \
    js-envs-test-suite/src/test/scala/org/scalajs/jsenv/test/RetryingComJSEnvTest.scala \
    js-envs-test-suite/src/test/scala/org/scalajs/jsenv/test/RhinoJSEnvTest.scala \
    sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/phantomjs/ \
    sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/rhino/ \
    sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/env/nodejs/JSDOMNodeJSEnv.scala \
    sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/JSDOMNodeJSEnvTest.scala \
    sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/PhantomJSTest.scala \
    sbt-plugin/src/test/scala/scala/scalajs/sbtplugin/test/env/RhinoJSEnvTest.scala
  ' HEAD

giving https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-2

Unfortunately, --prune-empty does not prune empty merge commits. We fixed that using the solution found in http://stackoverflow.com/a/38420284/1829647:

git filter-branch --prune-empty --parent-filter 'sed "s/-p //g" | xargs -r git show-branch --independent | sed "s/\</-p /g"'

giving https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-3

Now, we had a clean history, except that it was orphaned wrt. the Initial commit of this repository, which is e9d986c. To have a nice PR with a history that appears to have come from the Initial commit, we reattached the first commit to the Initial commit using:

git filter-branch --parent-filter 'sed "s/^\$/-p e9d986c60d0e44853f4c0faa9d901995a3f239f9/"' HEAD

which yielded https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-4.

Almost there, except that now the files from the Initial commit have been removed in the first meaningful commit of the filter-branch. We restored them using:

git filter-branch --index-filter 'git reset e9d986c60d0e44853f4c0faa9d901995a3f239f9 -- .gitignore LICENSE README.md'

giving the history in https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-5.

As a final polish, we rewrite, in commit messages, references to tickets of the form #123 to scala-js/scala-js#123, so that they point to issues in the scala-js/scala-js repository. This is done using the following incantation:

git filter-branch --msg-filter 'sed -r -e "s/(#[0-9]+)/scala-js\/scala-js\1/g"'

and gives the result in https://github.com/sjrd/scala-js-js-envs/commits/import-from-core-step-6.

This PR is one commit on top of that final step.

[sjrd]

The two changes here are necessary because the file was not compiling as is. It turns out we were not running jsEnvsTestKit/test in the core repo!

[sjrd]

Note that I deactivate fatal warnings in Scaladoc, because links to the JavaDoc, including in @throws sections, do not work and report errors. We could fix this by doing all the heavy machinery that we do in scala-js/scala-js to patch up the JavaDoc links, but I found that overkill right now.