Michael Bradley, Jr 3693ebd90d fix: ensure that packages properly specify their dependencies
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`).
2020-02-25 14:52:10 -06:00

31 lines
766 B
JavaScript

const {join} = require('path');
const {promisify} = require('util');
const rimraf = promisify(require('rimraf'));
const dappPath = process.env.DAPP_PATH || process.cwd();
const green = (text) => '\x1b[32m' + text + '\x1b[0m';
exports.paths = new Set([
'.embark',
'chains.json',
'coverage',
'dist',
'embarkArtifacts',
'node_modules/.cache'
]);
exports.reset = async ({
doneMessage = green('Done!'),
removePaths = exports.paths
} = {}) => {
const completePaths = [...removePaths].map(relative => join(dappPath, relative));
console.log(green('Removing the following files:\n'));
completePaths.forEach(path => console.log(`${path}`));
await Promise.all(
completePaths.map(path => rimraf(path))
);
console.log(`\n${doneMessage}`);
};