Skip to content

Commit

Permalink
fix(cli): use proper kebab-case name for npm package (#2276)
Browse files Browse the repository at this point in the history
  • Loading branch information
alappe authored and jcesarmobile committed Jan 10, 2020
1 parent ec458c8 commit c9f1511
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion cli/src/tasks/new-plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export async function newPlugin(config: Config) {
{
type: 'input',
name: 'name',
message: 'Plugin NPM name (snake-case):',
message: 'Plugin NPM name (kebab-case):',
validate: function(input) {
if (!input || input.trim() === '') {
return false;
Expand Down
4 changes: 2 additions & 2 deletions site/docs-md/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This starts a wizard prompting you for information about your new plugin. For ex
```bash
npx @capacitor/cli plugin:generate
✏️ Creating new Capacitor plugin
? Plugin NPM name (snake-case): my-plugin
? Plugin NPM name (kebab-case): my-plugin
? Plugin id (domain-style syntax. ex: com.example.plugin) com.ionicframework.myplugin
? Plugin class name (ex: AwesomePlugin) MyPlugin
? description:
Expand All @@ -44,7 +44,7 @@ npx @capacitor/cli plugin:generate
? package.json will be created, do you want to continue? (Y/n)
```

- `Plugin NPM name`: a snake-case name of a package that will be available on npm (not a strict requirement if your package will be on a private npm repo).
- `Plugin NPM name`: a kebab-case name of a package that will be available on npm (not a strict requirement if your package will be on a private npm repo).
- `Plugin ID`: a domain-style identifier. It is primarily used for the package name in Java.
- `Plugin Class Name`: the initial name of the class used in Java and Swift. See the additional note about class names in the [iOS Plugin](ios/) section of this guide.
- `description`: a brief introduction about the plugin.
Expand Down

0 comments on commit c9f1511

Please sign in to comment.