diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46d37d0a7..1dc439180 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,11 +93,14 @@ And you should be ready to go! Plugin-tools is a mono-repo consisting of multiple projects. Please refer to their contributing guides to understand how to develop each one. -| Package Name | Readme | -| ------------- | ------------------------------------------------ | -| Create Plugin | [Link](./packages/create-plugin/CONTRIBUTING.md) | -| Sign Plugin | [Link](./packages/sign-plugin/CONTRIBUTING.md) | -| Website | [Link](./docusaurus/website/CONTRIBUTING.md) | +| Package Name | Readme | +| ------------- | -------------------------------------------------------- | +| Create Plugin | [Link](./packages/create-plugin/CONTRIBUTING.md) | +| ESlint Plugin | [Link](./packages/eslint-plugin-plugins/CONTRIBUTING.md) | +| Plugin E2E | [Link](./packages/plugin-e2e/CONTRIBUTING.md) | +| Sign Plugin | [Link](./packages/sign-plugin/CONTRIBUTING.md) | +| TSconfig | [Link](./packages/tsconfig/CONTRIBUTING.md) | +| Website | [Link](./docusaurus/website/CONTRIBUTING.md) | ## Contributor License Agreement (CLA) diff --git a/README.md b/README.md index d7eba8e2a..b4d1cc581 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ This is a mono-repo of NPM packages to help plugin developers extend Grafana in | [**`@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) | ### Overview diff --git a/package-lock.json b/package-lock.json index 22d89b259..76bb69aa2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,6 +15,7 @@ "packages/plugin-meta-extractor", "packages/plugin-types-bundler", "packages/eslint-plugin-plugins", + "packages/tsconfig", "libs/*" ], "devDependencies": { @@ -5501,8 +5502,8 @@ "link": true }, "node_modules/@grafana/tsconfig": { - "version": "2.0.0", - "license": "Apache-2.0" + "resolved": "packages/tsconfig", + "link": true }, "node_modules/@hapi/hoek": { "version": "9.3.0", @@ -34210,6 +34211,11 @@ "engines": { "node": ">=20" } + }, + "packages/tsconfig": { + "name": "@grafana/tsconfig", + "version": "2.0.0", + "license": "Apache-2.0" } } } diff --git a/package.json b/package.json index cdc879c3e..9a3b8854c 100644 --- a/package.json +++ b/package.json @@ -71,6 +71,7 @@ "packages/plugin-meta-extractor", "packages/plugin-types-bundler", "packages/eslint-plugin-plugins", + "packages/tsconfig", "libs/*" ], "lint-staged": { diff --git a/packages/tsconfig/CONTRIBUTING.md b/packages/tsconfig/CONTRIBUTING.md new file mode 100644 index 000000000..7eba2035e --- /dev/null +++ b/packages/tsconfig/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to Grafana / TSconfig + +We are always grateful to receive contributions!
+The following guidelines help you on how to start with the codebase and how to submit your work. + +## Installation + +### Prerequisites + +You need to have `npm` installed. + +### Installing + +```bash +git clone git@github.com:grafana/plugin-tools.git +cd plugin-tools +npm install +``` + +## Overview + +### Folder structure + +_Work in progress._ + +## Development + +Please read the main [contributing guide](../../CONTRIBUTING.md) before contributing any code changes to the project. + +### Commmands + +This package has no build process. When making changes it's best to test it either by linking it: + +```shell +npm link -w @grafana/tsconfig +``` + +Or packing it into a tarball and installing it in a test repo: + +```shell +npm pack -w @grafana/tsconfig +``` diff --git a/packages/tsconfig/LICENSE b/packages/tsconfig/LICENSE new file mode 100644 index 000000000..5a83bb017 --- /dev/null +++ b/packages/tsconfig/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 Grafana Labs + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/tsconfig/README.md b/packages/tsconfig/README.md new file mode 100644 index 000000000..7bd062712 --- /dev/null +++ b/packages/tsconfig/README.md @@ -0,0 +1,31 @@ +# grafana-tsconfig + +> Grafana's [TypeScript](https://typescriptlang.org) config. + +## Installation + +```shell +yarn add @grafana/tsconfig --dev +``` + +or: + +```shell +npm install @grafana/tsconfig --save-dev +``` + +## Usage + +```json +{ + "extends": "@grafana/tsconfig" +} +``` + +or: + +```json +{ + "extends": "@grafana/tsconfig/base.json" +} +``` diff --git a/packages/tsconfig/base.json b/packages/tsconfig/base.json new file mode 100644 index 000000000..5856dbebf --- /dev/null +++ b/packages/tsconfig/base.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "allowSyntheticDefaultImports": true, + "downlevelIteration": true, + "esModuleInterop": true, + "experimentalDecorators": true, + "forceConsistentCasingInFileNames": true, + "importHelpers": true, + "jsx": "react", + "lib": ["dom", "dom.iterable", "es2022"], + "module": "esnext", + "moduleResolution": "node", + "noEmitHelpers": true, + "noImplicitAny": true, + "noImplicitReturns": true, + "noImplicitThis": true, + "noUnusedLocals": true, + "pretty": true, + "skipLibCheck": true, + "sourceMap": true, + "target": "es2018" + } +} diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json new file mode 100644 index 000000000..acc0d1459 --- /dev/null +++ b/packages/tsconfig/package.json @@ -0,0 +1,21 @@ +{ + "author": "Grafana Labs", + "license": "Apache-2.0", + "name": "@grafana/tsconfig", + "version": "2.0.0", + "description": "Grafana's TypeScript config", + "keywords": [ + "grafana", + "typescript", + "config" + ], + "repository": { + "directory": "packages/tsconfig", + "url": "https://github.com/grafana/plugin-tools" + }, + "main": "tsconfig.json", + "files": [ + "base.json", + "tsconfig.json" + ] +} diff --git a/packages/tsconfig/tsconfig.json b/packages/tsconfig/tsconfig.json new file mode 100644 index 000000000..01f03916f --- /dev/null +++ b/packages/tsconfig/tsconfig.json @@ -0,0 +1,8 @@ +{ + "compilerOptions": { + "alwaysStrict": true, + "declaration": true, + "strict": true + }, + "extends": "./base.json" +}