Skip to content

docs(readme): add missing packages #2741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackw wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −11
Open

docs(readme): add missing packages #2741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading