ionic-team / ionic-team/capacitor-plugin-registry

feat: allow maintainers to provide additional meta information

Open
#34 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
9
Forks
13
PR merge metrics
No merged PRs in 30d

Description

There should be a way to provide the Capacitor Plugin Registry with additional information about a plugin that is not available via npm.
This can be the case either if the information is not available on npm or if the plugin is distributed via another npm registry.
Examples of such information are:
- What platforms are supported? (For example, the package `@capawesome/capacitor-photo-editor` only supports Android, but Android and iOS are shown).
- Is the package currently being maintained?
- Who is the author?
- Link to the GitHub repository
- Link to the installation instructions
- ...

Plugin authors could easily provide this information via JSON files (similar to the [React Native Directory](https://github.com/react-native-community/directory#how-do-i-add-a-library)).

One possible scheme would be:

```json
{
"githubUrl": "https://github.com/capawesome-team/capacitor-plugins",
"npmPkg": "@capawesome-team/capacitor-nfc",
"author": "Robin Genz",
"license": "MIT License",
"platforms": ["android", "ios", "web"],
"private": true,
"unmaintained": false,
...
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.