-
Notifications
You must be signed in to change notification settings - Fork 884
/
cli.ts
110 lines (98 loc) · 3.46 KB
/
cli.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Any modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import Path from 'path';
import Fs from 'fs';
import execa from 'execa';
import { PROCESS_WORKING_DIR, REPO_ROOT } from '@osd/cross-platform';
import { run, createFailError, createFlagError } from '@osd/dev-utils';
import { snakeCase } from './casing';
import { askQuestions, getDefaultAnswers } from './ask_questions';
import { renderTemplates } from './render_template';
export function runCli() {
run(
async ({ log, flags }) => {
const name = flags.name || undefined;
if (name && typeof name !== 'string') {
throw createFlagError(`expected one --name flag`);
}
if (flags.yes && !name) {
throw createFlagError(`passing --yes requires that you specify a name`);
}
const overrides = {
name,
ui: typeof flags.ui === 'boolean' ? flags.ui : undefined,
server: typeof flags.server === 'boolean' ? flags.server : undefined,
};
const answers = flags.yes ? getDefaultAnswers(overrides) : await askQuestions(overrides);
const outputDir = answers.internal
? Path.resolve(answers.internalLocation, snakeCase(answers.name))
: Path.resolve(REPO_ROOT, 'plugins', snakeCase(answers.name));
if (Fs.existsSync(outputDir)) {
throw createFailError(`Target output directory [${outputDir}] already exists`);
}
// process the template directory, creating the actual plugin files
await renderTemplates({
outputDir,
answers,
});
// init git repo in third party plugins
if (!answers.internal) {
await execa('git', ['init', outputDir]);
}
log.success(
`🎉\n\nYour plugin has been created in ${Path.relative(PROCESS_WORKING_DIR, outputDir)}\n`
);
},
{
usage: 'node scripts/generate_plugin',
description: `
Generate a fresh OpenSearch Dashboards plugin in the plugins/ directory
`,
flags: {
string: ['name'],
boolean: ['yes', 'ui', 'server'],
default: {
ui: null,
server: null,
},
alias: {
y: 'yes',
u: 'ui',
s: 'server',
},
help: `
--yes, -y Answer yes to all prompts, requires passing --name
--name Set the plugin name
--ui Generate a UI plugin
--server Generate a Server plugin
`,
},
}
);
}