mirror of
https://github.com/embarklabs/embark.git
synced 2026-08-31 03:21:14 +00:00
Michael Bradley, Jr
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`).
36 lines
847 B
JavaScript
36 lines
847 B
JavaScript
const {execSync} = require('child_process');
|
|
const fs = require('fs');
|
|
const {EOL} = require('os');
|
|
const path = require('path');
|
|
|
|
const embarkBinPath = path.resolve(
|
|
path.join(__dirname, '../packages/embark/bin/embark')
|
|
);
|
|
if (!fs.existsSync(embarkBinPath)) process.exit(1);
|
|
|
|
const getStdout = (cmd) => {
|
|
let out;
|
|
try {
|
|
out = execSync(
|
|
cmd,
|
|
{stdio: ['ignore', 'pipe', 'ignore']}
|
|
).toString().trim();
|
|
} catch (e) {
|
|
process.exit(1);
|
|
}
|
|
return out;
|
|
};
|
|
|
|
const npmGlobalBin = getStdout('npm --global bin');
|
|
|
|
if (process.platform === 'win32') {
|
|
fs.writeFileSync(
|
|
path.join(npmGlobalBin, 'embark.cmd'),
|
|
`@node "${embarkBinPath}" %*${EOL}`
|
|
);
|
|
} else {
|
|
const linkPath = path.join(npmGlobalBin, 'embark');
|
|
if (fs.existsSync(linkPath)) fs.unlinkSync(linkPath);
|
|
fs.symlinkSync(embarkBinPath, linkPath);
|
|
}
|