mirror of
https://github.com/embarklabs/embark.git
synced 2025-01-11 22:34:24 +00:00
3693ebd90d
Many packages in the monorepo did not specify all of their dependencies; they
were effectively relying on resolution in the monorepo's root
`node_modules`. In a production release of `embark` and `embark[js]-*` packages
this can lead to broken packages.
To fix the problem currently and to help prevent it from happening again, make
use of the `eslint-plugin-import` package's `import/no-extraneous-dependencies`
and `import/no-unresolved` rules. In the root `tslint.json` set
`"no-implicit-dependencies": true`, wich is the tslint equivalent of
`import/no-extraneous-dependencies`; there is no tslint equivalent for
`import/no-unresolved`, but we will eventually replace tslint with an eslint
configuration that checks both `.js` and `.ts` files.
For `import/no-unresolved` to work in our monorepo setup, in most packages add
an `index.js` that has:
```js
module.exports = require('./dist'); // or './dist/lib' in some cases
```
And point `"main"` in `package.json` to `"./index.js"`. Despite what's
indicated in npm's documentation for `package.json`, it's also necessary to add
`"index.js"` to the `"files"` array.
Make sure that all `.js` files that can and should be linted are in fact
linted. For example, files in `packages/embark/src/cmd/` weren't being linted
and many test suites weren't being linted.
Bump all relevant packages to `eslint@6.8.0`.
Fix all linter errors that arose after these changes.
Implement a `check-yarn-lock` script that's run as part of `"ci:full"` and
`"qa:full"`, and can manually be invoked via `yarn cylock` in the root of the
monorepo. The script exits with error if any specifiers are found in
`yarn.lock` for `embark[js][-*]` and/or `@embarklabs/*` (with a few exceptions,
cf. `scripts/check-yarn-lock.js`).
34 lines
1.0 KiB
JavaScript
34 lines
1.0 KiB
JavaScript
const {readFileSync} = require('fs');
|
|
const {join} = require('path');
|
|
|
|
try {
|
|
const yarnLock = readFileSync(join(__dirname, '..', 'yarn.lock')).toString();
|
|
const embarkPkgs = yarnLock.match(/embark(js)?(-\S+)?@|@embarklabs\/\S+@/g);
|
|
const badSpecTest = spec => (
|
|
!(spec.startsWith('embark-test-contract-') ||
|
|
spec.startsWith('@embarklabs/ethereumjs-wallet'))
|
|
);
|
|
if (embarkPkgs &&
|
|
embarkPkgs.some(badSpecTest)) {
|
|
let badSpecs = [...(new Set(embarkPkgs))]
|
|
.filter(badSpecTest)
|
|
.map(spec => spec.slice(0, -1));
|
|
const plur = badSpecs.length > 1;
|
|
console.error();
|
|
console.error(
|
|
[
|
|
`Found specifier${plur ? 's' : ''} for ${badSpecs.join(', ')} in the`,
|
|
`root yarn.lock file.\n\nThis probably happened because some package's`,
|
|
`version and/or dev/Deps specifiers need to be adjusted relative to`,
|
|
`the current versions in the master branch.`
|
|
].join(' ')
|
|
);
|
|
console.error();
|
|
process.exit(1);
|
|
}
|
|
process.exit(0);
|
|
} catch(e) {
|
|
console.error(e);
|
|
process.exit(1);
|
|
}
|