apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Build: Reduce repetition in rollup configs (#93916)

Browse Source 
* build(packages): add extendable pieces of rollup config

* build(packages): rewrite rollup configs to make use of extendable parts
pull/101268/head
Jack Westbrook 4 months ago committed by GitHub
parent 047136c830
commit eca045bc11
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 109 additions and 348 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 50
      packages/grafana-data/rollup.config.ts
  2. 50
      packages/grafana-e2e-selectors/rollup.config.ts
  3. 50
      packages/grafana-flamegraph/rollup.config.ts
  4. 1
      packages/grafana-icons/package.json
  5. 42
      packages/grafana-icons/rollup.config.ts
  6. 51
      packages/grafana-prometheus/rollup.config.ts
  7. 50
      packages/grafana-runtime/rollup.config.ts
  8. 57
      packages/grafana-schema/rollup.config.ts
  9. 48
      packages/grafana-ui/rollup.config.ts
  10. 58
      packages/rollup.config.parts.ts

50
packages/grafana-data/rollup.config.ts
Unescape View File

@ -1,53 +1,15 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { entryPoint, plugins, esmOutput, cjsOutput, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-data')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-data/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

50
packages/grafana-e2e-selectors/rollup.config.ts
Unescape View File

@ -1,53 +1,15 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-e2e-selectors')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-e2e-selectors/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

50
packages/grafana-flamegraph/rollup.config.ts
Unescape View File

@ -1,53 +1,15 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-flamegraph')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-ui/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

1
packages/grafana-icons/package.json
Unescape View File

@ -16,6 +16,7 @@
"types": "src/index.ts", "types": "src/index.ts",
"publishConfig": { "publishConfig": {
"main": "dist/index.js", "main": "dist/index.js",
"module": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",
"access": "public" "access": "public"
}, },

42
packages/grafana-icons/rollup.config.ts
Unescape View File

@ -1,45 +1,15 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: esmOutput(pkg, 'grafana-icons'),
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
preserveModules: true,
...legacyOutputDefaults,
},
],
},
{
input: 'src/index.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg, { input: 'src/index.ts' }),
]; ];

51
packages/grafana-prometheus/rollup.config.ts
Unescape View File

@ -1,55 +1,16 @@
import image from '@rollup/plugin-image'; import image from '@rollup/plugin-image';
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins: [...plugins, image()],
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-prometheus')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
image(),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-prometheus/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

50
packages/grafana-runtime/rollup.config.ts
Unescape View File

@ -1,53 +1,15 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import dts from 'rollup-plugin-dts'; import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-runtime')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-runtime/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

57
packages/grafana-schema/rollup.config.ts
Unescape View File

@ -1,57 +1,22 @@
import resolve from '@rollup/plugin-node-resolve';
import { glob } from 'glob'; import { glob } from 'glob';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import { fileURLToPath } from 'node:url'; import { fileURLToPath } from 'node:url';
import path from 'path'; import path from 'path';
import dts from 'rollup-plugin-dts';
import esbuild from 'rollup-plugin-esbuild'; import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
import { nodeExternals } from 'rollup-plugin-node-externals';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const pkg = rq('./package.json'); const pkg = rq('./package.json');
const legacyOutputDefaults = { const [_, noderesolve, esbuild] = plugins;
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins,
nodeExternals({ deps: true, packagePath: './package.json' }), output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-schema')],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: [
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-schema/src`),
...legacyOutputDefaults,
},
],
},
{
input: './dist/esm/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg, { input: './dist/esm/index.d.ts' }),
{ {
input: Object.fromEntries( input: Object.fromEntries(
glob glob
@ -61,13 +26,7 @@ export default [
fileURLToPath(new URL(file, import.meta.url)), fileURLToPath(new URL(file, import.meta.url)),
]) ])
), ),
plugins: [ plugins: [noderesolve, esbuild],
resolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
],
output: { output: {
format: 'esm', format: 'esm',
dir: path.dirname(pkg.publishConfig.module), dir: path.dirname(pkg.publishConfig.module),

48
packages/grafana-ui/rollup.config.ts
Unescape View File

@ -1,12 +1,9 @@
import resolve from '@rollup/plugin-node-resolve';
import { createRequire } from 'node:module'; import { createRequire } from 'node:module';
import path from 'path';
import copy from 'rollup-plugin-copy'; import copy from 'rollup-plugin-copy';
import dts from 'rollup-plugin-dts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
import svg from 'rollup-plugin-svg-import'; import svg from 'rollup-plugin-svg-import';
import { cjsOutput, entryPoint, esmOutput, plugins, tsDeclarationOutput } from '../rollup.config.parts';
const rq = createRequire(import.meta.url); const rq = createRequire(import.meta.url);
const icons = rq('../../public/app/core/icons/cached.json'); const icons = rq('../../public/app/core/icons/cached.json');
const pkg = rq('./package.json'); const pkg = rq('./package.json');
@ -15,51 +12,18 @@ const iconSrcPaths = icons.map((iconSubPath) => {
return `../../public/img/icons/${iconSubPath}.svg`; return `../../public/img/icons/${iconSubPath}.svg`;
}); });
const legacyOutputDefaults = {
esModule: true,
interop: 'compat',
};
export default [ export default [
{ {
input: 'src/index.ts', input: entryPoint,
plugins: [ plugins: [
nodeExternals({ deps: true, packagePath: './package.json' }), ...plugins,
svg({ stringify: true }), svg({ stringify: true }),
resolve(),
copy({ copy({
targets: [{ src: iconSrcPaths, dest: './dist/public/' }], targets: [{ src: iconSrcPaths, dest: './dist/public/' }],
flatten: false, flatten: false,
}), }),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
], ],
output: [ output: [cjsOutput(pkg), esmOutput(pkg, 'grafana-ui')],
{
format: 'cjs',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.main),
...legacyOutputDefaults,
},
{
format: 'esm',
sourcemap: true,
dir: path.dirname(pkg.publishConfig.module),
preserveModules: true,
// @ts-expect-error (TS cannot assure that `process.env.PROJECT_CWD` is a string)
preserveModulesRoot: path.join(process.env.PROJECT_CWD, `packages/grafana-ui/src`),
...legacyOutputDefaults,
},
],
},
{
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
}, },
tsDeclarationOutput(pkg),
]; ];

58
packages/rollup.config.parts.ts
Unescape View File

@ -0,0 +1,58 @@
// This file contains the common parts of the rollup configuration that are shared across multiple packages.
import nodeResolve from '@rollup/plugin-node-resolve';
import { dirname, resolve } from 'node:path';
import dts from 'rollup-plugin-dts';
import esbuild from 'rollup-plugin-esbuild';
import { nodeExternals } from 'rollup-plugin-node-externals';
// This is the path to the root of the grafana project
// Prefer PROJECT_CWD env var set by yarn berry
const projectCwd = process.env.PROJECT_CWD ?? '../../';
export const entryPoint = 'src/index.ts';
// Plugins that are shared across all rollup configurations. Their order can affect build output.
// Externalising and resolving modules should happen before transformation.
export const plugins = [
nodeExternals({ deps: true, packagePath: './package.json' }),
nodeResolve(),
esbuild({
target: 'es2018',
tsconfig: 'tsconfig.build.json',
}),
];
// Generates a rollup configuration for commonjs output.
export function cjsOutput(pkg) {
return {
format: 'cjs',
sourcemap: true,
dir: dirname(pkg.publishConfig.main),
esModule: true,
interop: 'compat',
};
}
// Generate a rollup configuration for es module output.
export function esmOutput(pkg, pkgName) {
return {
format: 'esm',
sourcemap: true,
dir: dirname(pkg.publishConfig.module),
preserveModules: true,
preserveModulesRoot: resolve(projectCwd, `packages/${pkgName}/src`),
};
}
// Generate a rollup configuration for rolling up typescript declaration files into a single file.
export function tsDeclarationOutput(pkg, overrides = {}) {
return {
input: './compiled/index.d.ts',
plugins: [dts()],
output: {
file: pkg.publishConfig.types,
format: 'es',
},
...overrides,
};
}
Write Preview
Loading…
Cancel
Save