@gooddata/plugin-toolkit

Plugin Development Toolkit

   

This package is a part of the GoodData.UI SDK. To learn more, check the source monorepo.

This package implements GoodData Plugin Development Toolkit (PDT). The primary entry point to the toolkit is its CLI tool called gdc-plugins. Through this CLI tool you can currently:

• Create a new project to develop a Dashboard Plugin
• Add configuration for the Dashboard Plugin into a workspace of your choice
• Configure an existing dashboard to use a Dashboard Plugin available in a workspace

Read more about Dashboard Plugins in official documentation.

Plugin Naming Convention

Plugin names must use snake_case (underscores) instead of kebab-case (hyphens). This is because plugin names are converted to snake_case internally for use in module federation identifiers, directory names, and asset file names.

Valid names:

• my_plugin
• dashboard_plugin
• custom_analytics_plugin

Invalid names:

• my-plugin (kebab-case - use my_plugin instead)
• dashboard-plugin (kebab-case - use dashboard_plugin instead)

License

(C) 2017-2022 GoodData Corporation

This project is under MIT License. See LICENSE.