Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[6.x] Preinstall check that mentions 'yarn kbn' (#16572) #16600

Merged
merged 1 commit into from
Feb 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"Yuri Astrakhan <yuri@elastic.co>"
],
"scripts": {
"preinstall": "node ./preinstall_check",
"kbn": "node scripts/kbn",
"test": "grunt test",
"test:dev": "grunt test:dev",
Expand Down
32 changes: 32 additions & 0 deletions preinstall_check.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
const isUsingNpm = process.env.npm_config_git !== undefined;

if (isUsingNpm) {
throw "Use Yarn instead of npm, see Kibana's contributing guidelines";
}

// The value of the `npm_config_argv` env for each command:
//
// - `npm install`: '{"remain":[],"cooked":["install"],"original":[]}'
// - `yarn`: '{"remain":[],"cooked":["install"],"original":[]}'
// - `yarn kbn bootstrap`: '{"remain":[],"cooked":["run","kbn"],"original":["kbn","bootstrap"]}'
const rawArgv = process.env.npm_config_argv;

if (rawArgv === undefined) {
return;
}

try {
const argv = JSON.parse(rawArgv);

if (argv.cooked.includes('kbn')) {
// all good, trying to install deps using `kbn`
return;
}

if (argv.cooked.includes('install')) {
console.log('\nWARNING: When installing dependencies, prefer `yarn kbn bootstrap`\n');
}
} catch (e) {
// if it fails we do nothing, as this is just intended to be a helpful message
}