From d25d547802175306d42c3b0af40210cd007dfbdd Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Wed, 24 Jun 2026 10:54:43 +0200 Subject: [PATCH] docs(readme): add missing packages to root readme --- .github/ISSUE_TEMPLATE/bug_report.yml | 10 ++++++++-- README.md | 23 ++++++++++++++--------- 2 files changed, 22 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 897955ac6c..0e363f7ae8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,10 +15,16 @@ body: description: You may select more than one. options: - label: 'Create Plugin' - - label: 'Sign Plugin' + - label: 'ESLint Config' + - label: 'Plugin Docs CLI' + - label: 'Plugin Docs Parser' - label: 'Plugin E2E' - - label: 'Plugin Meta Extractor' - label: 'Plugin ESLint Rules' + - label: 'Plugin Meta Extractor' + - label: 'Plugin Types Bundler' + - label: 'React detect' + - label: 'Sign Plugin' + - label: 'TS Config' validations: required: true - type: textarea diff --git a/README.md b/README.md index ba20ab3afc..592fa1829a 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,23 @@ This is a mono-repo of NPM packages to help plugin developers extend Grafana in amazing ways! -| Package Name | Description | Version | Downloads | -| ---------------------------------------------------------------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| [**`@grafana/create-plugin`**](./packages/create-plugin/README.md) | A CLI tool for scaffolding a new plugin | [![npm](https://img.shields.io/npm/v/@grafana/create-plugin)](https://www.npmjs.com/package/@grafana/create-plugin) | [![npm](https://img.shields.io/npm/dw/@grafana/create-plugin)](https://npmcharts.com/compare/@grafana/create-plugin?interval=7) | -| [**`@grafana/sign-plugin`**](./packages/sign-plugin/README.md) | A CLI tool for signing plugins | [![npm](https://img.shields.io/npm/v/@grafana/sign-plugin)](https://www.npmjs.com/package/@grafana/sign-plugin) | [![npm](https://img.shields.io/npm/dw/@grafana/sign-plugin)](https://npmcharts.com/compare/@grafana/sign-plugin?interval=7) | -| [**`@grafana/plugin-e2e`**](./packages/plugin-e2e/README.md) | Test Grafana plugins with playwright | [![npm](https://img.shields.io/npm/v/@grafana/plugin-e2e)](https://www.npmjs.com/package/@grafana/plugin-e2e) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-e2e)](https://npmcharts.com/compare/@grafana/plugin-e2e?interval=7) | -| [**`@grafana/eslint-plugin-plugins`**](./packages/eslint-plugin-plugins/README.md) | Lint rules for Grafana plugins | [![npm](https://img.shields.io/npm/v/@grafana/eslint-plugin-plugins)](https://www.npmjs.com/package/@grafana/eslint-plugin-plugins) | [![npm](https://img.shields.io/npm/dw/@grafana/eslint-plugin-plugins)](https://npmcharts.com/compare/@grafana/eslint-plugin-plugins?interval=7) | -| [**`@grafana/plugin-types-bundler`**](./packages/plugin-types-bundler/README.md) | Bundle Grafana plugin typescript types | [![npm](https://img.shields.io/npm/v/@grafana/plugin-types-bundler)](https://www.npmjs.com/package/@grafana/plugin-types-bundler) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-types-bundler)](https://npmcharts.com/compare/@grafana/plugin-types-bundler?interval=7) | -| [**`@grafana/tsconfig`**](./packages/tsconfig/README.md) | Grafana's typescript config | [![npm](https://img.shields.io/npm/v/@grafana/tsconfig)](https://www.npmjs.com/package/@grafana/tsconfig) | [![npm](https://img.shields.io/npm/dw/@grafana/tsconfig)](https://npmcharts.com/compare/@grafana/tsconfig?interval=7) | +| Package Name | Description | Version | Downloads | +| ---------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| [**`@grafana/create-plugin`**](./packages/create-plugin/README.md) | A CLI tool for scaffolding a new plugin | [![npm](https://img.shields.io/npm/v/@grafana/create-plugin)](https://www.npmjs.com/package/@grafana/create-plugin) | [![npm](https://img.shields.io/npm/dw/@grafana/create-plugin)](https://npmcharts.com/compare/@grafana/create-plugin?interval=7) | +| [**`@grafana/sign-plugin`**](./packages/sign-plugin/README.md) | A CLI tool for signing plugins | [![npm](https://img.shields.io/npm/v/@grafana/sign-plugin)](https://www.npmjs.com/package/@grafana/sign-plugin) | [![npm](https://img.shields.io/npm/dw/@grafana/sign-plugin)](https://npmcharts.com/compare/@grafana/sign-plugin?interval=7) | +| [**`@grafana/plugin-e2e`**](./packages/plugin-e2e/README.md) | Test Grafana plugins with Playwright | [![npm](https://img.shields.io/npm/v/@grafana/plugin-e2e)](https://www.npmjs.com/package/@grafana/plugin-e2e) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-e2e)](https://npmcharts.com/compare/@grafana/plugin-e2e?interval=7) | +| [**`@grafana/eslint-plugin-plugins`**](./packages/eslint-plugin-plugins/README.md) | Lint rules for Grafana plugins | [![npm](https://img.shields.io/npm/v/@grafana/eslint-plugin-plugins)](https://www.npmjs.com/package/@grafana/eslint-plugin-plugins) | [![npm](https://img.shields.io/npm/dw/@grafana/eslint-plugin-plugins)](https://npmcharts.com/compare/@grafana/eslint-plugin-plugins?interval=7) | +| [**`@grafana/plugin-types-bundler`**](./packages/plugin-types-bundler/README.md) | Bundle Grafana plugin TypeScript types | [![npm](https://img.shields.io/npm/v/@grafana/plugin-types-bundler)](https://www.npmjs.com/package/@grafana/plugin-types-bundler) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-types-bundler)](https://npmcharts.com/compare/@grafana/plugin-types-bundler?interval=7) | +| [**`@grafana/tsconfig`**](./packages/tsconfig/README.md) | Grafana's TypeScript config | [![npm](https://img.shields.io/npm/v/@grafana/tsconfig)](https://www.npmjs.com/package/@grafana/tsconfig) | [![npm](https://img.shields.io/npm/dw/@grafana/tsconfig)](https://npmcharts.com/compare/@grafana/tsconfig?interval=7) | +| [**`@grafana/eslint-config`**](./packages/eslint-config/README.md) | Grafana's ESLint config | [![npm](https://img.shields.io/npm/v/@grafana/eslint-config)](https://www.npmjs.com/package/@grafana/eslint-config) | [![npm](https://img.shields.io/npm/dw/@grafana/eslint-config)](https://npmcharts.com/compare/@grafana/eslint-config?interval=7) | +| [**`@grafana/plugin-meta-extractor`**](./packages/plugin-meta-extractor/README.md) | Extract metadata from plugin source code | [![npm](https://img.shields.io/npm/v/@grafana/plugin-meta-extractor)](https://www.npmjs.com/package/@grafana/plugin-meta-extractor) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-meta-extractor)](https://npmcharts.com/compare/@grafana/plugin-meta-extractor?interval=7) | +| [**`@grafana/plugin-docs-cli`**](./packages/plugin-docs-cli/README.md) | Develop, validate, and preview plugin documentation locally | [![npm](https://img.shields.io/npm/v/@grafana/plugin-docs-cli)](https://www.npmjs.com/package/@grafana/plugin-docs-cli) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-docs-cli)](https://npmcharts.com/compare/@grafana/plugin-docs-cli?interval=7) | +| [**`@grafana/plugin-docs-parser`**](./packages/plugin-docs-parser/README.md) | Parse plugin documentation from Markdown to HAST | [![npm](https://img.shields.io/npm/v/@grafana/plugin-docs-parser)](https://www.npmjs.com/package/@grafana/plugin-docs-parser) | [![npm](https://img.shields.io/npm/dw/@grafana/plugin-docs-parser)](https://npmcharts.com/compare/@grafana/plugin-docs-parser?interval=7) | +| [**`@grafana/react-detect`**](./packages/react-detect/README.md) | Detect if a Grafana plugin is compatible with React 19 | [![npm](https://img.shields.io/npm/v/@grafana/react-detect)](https://www.npmjs.com/package/@grafana/react-detect) | [![npm](https://img.shields.io/npm/dw/@grafana/react-detect)](https://npmcharts.com/compare/@grafana/react-detect?interval=7) | ### Overview -This Mono-repo uses [NPM](https://nodejs.org) for package management, [NX](https://nx.dev/) to efficiently orchestrate tasks across the codebase, and [Auto](https://intuit.github.io/auto/) for streamlined and automated package publishing. We've carefully chosen and integrated these technologies to enhance development workflows. Before diving into the codebase, make sure to consult the [contributing guide](./CONTRIBUTING.md) for a smooth collaboration experience. +This Mono-repo uses [NPM](https://nodejs.org) for package management, [NX](https://nx.dev/) to efficiently orchestrate tasks across the codebase, and [Release Please](https://github.com/googleapis/release-please) for streamlined and automated package publishing. We've carefully chosen and integrated these technologies to enhance development workflows. Before diving into the codebase, make sure to consult the [contributing guide](./CONTRIBUTING.md) for a smooth collaboration experience. ### Additional resources