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

Add a registry for CLI Plugins #2

Closed
plwalters opened this issue May 15, 2015 · 7 comments
Closed

Add a registry for CLI Plugins #2

plwalters opened this issue May 15, 2015 · 7 comments
Assignees

Comments

@plwalters
Copy link
Contributor

The registry should contain basic information about each plugin that is available for the CLI. To allow the registry to expand with additional properties, I propose we use an array of objects instead of a simple key:value pair. Example -

{
  "plugins": [
    "i18next": {
      "endpoint": "github",    // where to start looking?  github, npm, gist
      "location": "/zewa666/aurelia-i18next",   // where is it in the end point?
      "libs": [
        "installer", "editor"
      ]    // what libs should be installed in the cli/lib directory?
    }
  ]
}
@plwalters plwalters self-assigned this May 15, 2015
@zewa666
Copy link
Member

zewa666 commented May 15, 2015

Hmm not sure if my comment here #1 might fits in better in this issue.

Could you elaborate on the libs section?

@plwalters
Copy link
Contributor Author

My first thought was how do we tell the cli what should be made available namespaced under this plugin. As an example for i18next we may want some generate lang de that generates German language. The lib is named installer in this case and so the cli would know to add it to the libs folder under an i18next directory and also have a way to extend the current list of commands so a dev could aurelia i18next generate lang de or something.

@plwalters
Copy link
Contributor Author

Alright for now I am going to use this method until I hear otherwise :)

@plwalters
Copy link
Contributor Author

Copying over @zewa666 's comment from the other issue -

Great, installing through JSPM would also be a better alternative to the current Github download approach.

With regards to cli what would you say if we expand that to an object which might contain the commands?

Like:

{
  "plugins": [
      {  
        "name": "i18next",
        "endpoint": "github",    // where to start looking?  github, npm, gist
        "location": "/zewa666/aurelia-i18next",   // where is it in the end point?
        "cli": {
          commands: {
            parse: 'NAME_OF_EXPORTED_METHOD_FROM_INDEX',
            nextCmd: '...'
          }
        }
      }
  ]
}

EDIT:
It would be also nice to include a property like demo with the path to a working example. Might be helpful for pages listing all plugins (like the FAQ)

@plwalters
Copy link
Contributor Author

@zewa666 @ahmedshuhel @EisenbergEffect What do you guys think about including the cli plugins directly in the plugin registry instead of in a separate registry

@ahmedshuhel
Copy link

@PWKad I think it's an excellent idea under the circumstances. All the plugins are the part of larger Aurelia ecosystem. So having a common registry totally make sense.

@plwalters
Copy link
Contributor Author

This issue is closed and we will incorporate the plugins into the main registry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants