https://github.com/universaldatatool/udt-plugin-discovery
API for discovering and searching for UDT plugins
https://github.com/universaldatatool/udt-plugin-discovery
Last synced: 2 months ago
JSON representation
API for discovering and searching for UDT plugins
- Host: GitHub
- URL: https://github.com/universaldatatool/udt-plugin-discovery
- Owner: UniversalDataTool
- Created: 2020-12-19T21:14:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-19T21:24:16.000Z (over 5 years ago)
- Last Synced: 2024-10-29T18:42:31.894Z (over 1 year ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UDT Plugin Discovery
This provides a simple api for discovering npm packages that are valid UDT plugins. It is used inside the Universal Data Tool to get plugins.
# Usage
## Get all UDT plugins
`GET https://plugin-discovery.universaldatatool.com/api?q=delete-samples`
```javascript
{
"plugins": [
{
"name": "udt-transform-delete-samples",
"description": "...",
"version": "1.0.7",
"keywords": ["udt-plugin", "udt-transform"]
}
]
}
```
## Listing Your Plugin
Make sure your plugin has a package.json file that includes `keywords` with `"udt-plugin"`, for example:
```javascript
{
"name": "udt-transform-delete-samples",
"version": "1.0.7",
"main": "plugin-config.js",
"repository": "git@github.com:UniversalDataTool/udt-transform-delete-samples.git",
"license": "MIT",
"type": "module",
"scripts:": {
"start": "udt-plugin start"
},
"keywords": [
"udt-plugin",
"udt-transform"
],
"dependencies": {
"udt-plugin": "0.0.1"
}
}
```
Then publish your plugin to npm using `npm publish`. The discovery service will always
return the latest version of your plugin.
# FAQ
## Why isn't my plugin appearing in the discovery tool?
Check to see that your package appears on [npms.io](https://npms.io). Our api updates as their api updates.