[Documentation] Limitation imposed by design

[stephanwlee]

Mendel made some design choice that does not allow certain patterns. Document them.

[irae]

One suggestion:

Invariant: Can't variate package.json runtime: If package.json exists on a variation, it should exist also on "base" and both should point at the same file/module and have the same "name". For instance, here are a list of invalid repo configurations:

$ find src/client -type f -name package\.json
./variations/foo/some-component/package.json
# Should throw, since base/foo//some-component/package.json don't exist on base/some-component/package.json

$ find src/client -type f -name package\.json
./base/some-component/package.json # → {"name": "foo"}
./variations/foo/some-component/package.json # → {"name": "bar"}
# Should throw because name mismatch on the same path.

$ find src/client -type f -name package\.json
./base/some-component/package.json # → {"main": "foo.js"}
./variations/foo/some-component/package.json # → {"main": "foo/index.js"}
# Should throw because path mismatch between variations