bdruth / grafana-solar

Bundler

Bundler to make developing code easier and scalable.

Table of contents

• Bundler
  • Table of contents
  • Contains
  • Usage
  • Dev site
  • Eslint

Contains

• rollup.js
• Prettier
• TypeScript
• ESLint
• Local development server to run the code live in the browser.

Usage

First you have to install the required dependencies

npm install

Then you start the development script

npm run dev

Go to http://localhost:5000. Change some code in ./src/onInit.ts, ./src/onRender.ts, or ./src/design/html.html, and the website will update.

When the code is ready to be uploaded to Grafana, start the build script

npm run build

Then go to /dist and copy the content of panel-options.json to the panels Import/export option.

Dev site

src/devSite is a folder where most of the configuration for the dev website is.

To add custom series go to src/devSite/data.ts and add createSeries() in series.

Window has been used to get global variables like data, customProperties, ETC.

Eslint

It's recommended to use the current eslint config, but as it's strongly opinionated it might be easier to use a less opinionated config.

Replace the current .eslint.cjs with the below code.

module.exports = {
  env: {
    node: true,
    browser: true,
  },
  extends: [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended",
    "prettier",
  ],
  parser: "@typescript-eslint/parser",
  plugins: ["@typescript-eslint"],
  root: true,
};