feat: add create plugin command #3800
Conversation
- `tns plugin create` command - add documentation - add tests
|
run ci |
rosen-vladimirov
left a comment
rosen-vladimirov
left a comment
There was a problem hiding this comment.
Can you please rebase your changes on the latest master, this will make your build green
lib/commands/plugin/create-plugin.ts
Outdated
| const cwd = path.join(projectDir, "src"); | ||
| try { | ||
| spinner.start(); | ||
| await this.$childProcess.exec("npm i", { cwd: cwd }); |
There was a problem hiding this comment.
Instead of using childProcess.exec, you can use the $npm:
https://github.com/NativeScript/nativescript-cli/blob/master/lib/node-package-manager.ts#L18
For example:
await this.$npm.install(cwd, cwd);
lib/commands/plugin/create-plugin.ts
Outdated
| } | ||
|
|
||
| let gitHubUsername = config.username; | ||
| if (!gitHubUsername) { |
There was a problem hiding this comment.
maybe you can extract part of this method to a separate methods, which will make the code easier to read, for example:
const gitHubUsername = await this.getGitHubUsernam(config.username);
const pluginNameSource = await this.getPluginNameSource(config.pluginName);
lib/commands/plugin/create-plugin.ts
Outdated
|
|
||
| const params = `gitHubUsername=${gitHubUsername} pluginName=${pluginNameSource} initGit=y`; | ||
| // run postclone script manually and kill it if it takes more than 10 sec | ||
| const outputScript = (await this.$childProcess.exec(`node scripts/postclone ${params}`, { cwd: cwd, timeout: 10000 })); |
There was a problem hiding this comment.
this could cause issues in case any of the parameters has a space in it. I recommend using childProcess.spawn:
const pathToPostCloneScript = path.join("scripts", "postclone");
const params = [ pathToPostCloneScript, `gitHubUsername=${gitHubUsername}`, `pluginName=${pluginNameSource}`, "initGit=y"];
await this.$childProcess.spawnFromEvent(process.execPath, params, "close", { cwd, timeout: 10000 });
lib/options.ts
Outdated
| watch: { type: OptionType.Boolean, default: true }, | ||
| background: { type: OptionType.String } | ||
| background: { type: OptionType.String }, | ||
| username: {type: OptionType.String}, |
There was a problem hiding this comment.
can you please format this changes (Alt + Shift +F in Visual Studio Code)
- $npm.install replaces $childProcess.exec("npm i")
- extract prompts to separate functions
- $childProcess.spawnFromEvent replaces $childProcess.exec
- formatting
- update tests
|
run ci |
rosen-vladimirov
left a comment
rosen-vladimirov
left a comment
There was a problem hiding this comment.
Great contribution! Thank you!
PR Checklist
What is the new behavior?
tns plugin createcommand added to CLI. The command will clone the plugin seed and execute the initial seed configuration script to prepare a new project for developing a NativeScript plugin.