diff --git a/packages/grafana-data/README.md b/packages/grafana-data/README.md index 3176bb45b5d..76401653d06 100644 --- a/packages/grafana-data/README.md +++ b/packages/grafana-data/README.md @@ -1,3 +1,3 @@ # Grafana Data Library -The core data components \ No newline at end of file +This package holds the root data types and functions used within Grafana. \ No newline at end of file diff --git a/packages/grafana-runtime/README.md b/packages/grafana-runtime/README.md index f01cd35537c..852cc3327e9 100644 --- a/packages/grafana-runtime/README.md +++ b/packages/grafana-runtime/README.md @@ -1,3 +1,3 @@ # Grafana Runtime library -Interfaces that let you use the runtime... \ No newline at end of file +This package allows access to grafana services. It requires Grafana to be running already and the functions to be imported as externals. \ No newline at end of file diff --git a/packages/grafana-runtime/package.json b/packages/grafana-runtime/package.json index a811e9965aa..3ce6061298e 100644 --- a/packages/grafana-runtime/package.json +++ b/packages/grafana-runtime/package.json @@ -3,9 +3,7 @@ "version": "6.3.0-alpha.0", "description": "Grafana Runtime Library", "keywords": [ - "typescript", - "react", - "react-component" + "grafana" ], "main": "src/index.ts", "scripts": { diff --git a/packages/grafana-toolkit/package.json b/packages/grafana-toolkit/package.json index 8f6d65e710a..dbc667de0db 100644 --- a/packages/grafana-toolkit/package.json +++ b/packages/grafana-toolkit/package.json @@ -3,9 +3,9 @@ "version": "6.3.0-alpha.2", "description": "Grafana Toolkit", "keywords": [ - "typescript", - "react", - "react-component" + "grafana", + "cli", + "plugins" ], "bin": { "grafana-toolkit": "./bin/grafana-toolkit.js" diff --git a/packages/grafana-toolkit/src/config/utils/pluginValidation.test.ts b/packages/grafana-toolkit/src/config/utils/pluginValidation.test.ts index f971f5b3f78..6a898bc0dc4 100644 --- a/packages/grafana-toolkit/src/config/utils/pluginValidation.test.ts +++ b/packages/grafana-toolkit/src/config/utils/pluginValidation.test.ts @@ -3,7 +3,7 @@ import { getPluginJson, validatePluginJson } from './pluginValidation'; describe('pluginValdation', () => { describe('plugin.json', () => { test('missing plugin.json file', () => { - expect(() => getPluginJson(`${__dirname}/mocks/missing-plugin-json`)).toThrow('plugin.json file is missing!'); + expect(() => getPluginJson(`${__dirname}/mocks/missing-plugin.json`)).toThrowError(); }); }); diff --git a/packages/grafana-toolkit/src/config/utils/pluginValidation.ts b/packages/grafana-toolkit/src/config/utils/pluginValidation.ts index 217b60ccafd..4f459aef303 100644 --- a/packages/grafana-toolkit/src/config/utils/pluginValidation.ts +++ b/packages/grafana-toolkit/src/config/utils/pluginValidation.ts @@ -22,15 +22,24 @@ export const validatePluginJson = (pluginJson: any) => { if (!pluginJson.info.version) { throw new Error('Plugin info.version is missing in plugin.json'); } + + const types = ['panel', 'datasource', 'app']; + const type = pluginJson.type; + if (!types.includes(type)) { + throw new Error('Invalid plugin type in plugin.json: ' + type); + } + + if (!pluginJson.id.endsWith('-' + type)) { + throw new Error('[plugin.json] id should end with: -' + type); + } }; -export const getPluginJson = (root: string = process.cwd()): PluginJSONSchema => { +export const getPluginJson = (path: string): PluginJSONSchema => { let pluginJson; - try { - pluginJson = require(path.resolve(root, 'src/plugin.json')); + pluginJson = require(path); } catch (e) { - throw new Error('plugin.json file is missing!'); + throw new Error('Unable to find: ' + path); } validatePluginJson(pluginJson); diff --git a/packages/grafana-toolkit/src/config/webpack.plugin.config.ts b/packages/grafana-toolkit/src/config/webpack.plugin.config.ts index 3d08f3e5526..79e461b2b4a 100644 --- a/packages/grafana-toolkit/src/config/webpack.plugin.config.ts +++ b/packages/grafana-toolkit/src/config/webpack.plugin.config.ts @@ -83,8 +83,8 @@ const getCommonPlugins = (options: WebpackConfigurationOptions) => { { from: '../LICENSE', to: '.' }, { from: 'img/*', to: '.' }, { from: '**/*.json', to: '.' }, - // { from: '**/*.svg', to: '.' }, - // { from: '**/*.png', to: '.' }, + { from: '**/*.svg', to: '.' }, + { from: '**/*.png', to: '.' }, { from: '**/*.html', to: '.' }, ], { logLevel: options.watch ? 'silent' : 'warn' } diff --git a/packages/grafana-ui/package.json b/packages/grafana-ui/package.json index 53728cb7b8f..030377923a5 100644 --- a/packages/grafana-ui/package.json +++ b/packages/grafana-ui/package.json @@ -3,7 +3,7 @@ "version": "6.3.0-alpha.1", "description": "Grafana Components Library", "keywords": [ - "typescript", + "grafana", "react", "react-component" ],