@grafana/plugin-types-bundler 0.0.1 → 0.0.2-canary.1162.c54d7e1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.0.1 (Wed Sep 25 2024)
+
+#### 🐛 Bug Fix
+
+- Types Bundler: Add package [#1092](https://github.com/grafana/plugin-tools/pull/1092) ([@jackw](https://github.com/jackw) [@leventebalogh](https://github.com/leventebalogh))
+
+#### Authors: 2
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Levente Balogh ([@leventebalogh](https://github.com/leventebalogh))

package/README.md

@@ -5,6 +5,8 @@
 
 `@grafana/plugin-types-bundler` is a cli tool that can be used to bundle types from the source code of a Grafana plugin. This single file will wrap all the types up into a single d.ts file which can then be shared with other Grafana plugins.
 
+It is recommended that you create a separate `.ts` file that exports only the types you want to expose rather than run this tool against the plugins `module.{ts,tsx}` file.
+
 ## Install
 
 ```

package/dist/bin/run.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import { existsSync } from 'fs';
+import { generateTypes } from '../bundleTypes.js';
+import { parsedArgs } from '../utils.js';
+const { entryPoint, tsConfig, outDir } = parsedArgs;
+if (entryPoint === undefined) {
+    console.error('Please provide the path for the entry types file as an argument.');
+    console.error('(E.g. "npx @grafana/plugin-types-bundler ./src/types/index.ts")');
+    process.exit(1);
+}
+if (!existsSync(entryPoint)) {
+    console.error(`File not found: ${entryPoint}`);
+    process.exit(1);
+}
+const startTime = Date.now().valueOf();
+try {
+    console.log('⚡️ Starting to bundle types for plugin...');
+    generateTypes({ entryPoint, tsConfig, outDir });
+}
+catch (error) {
+    console.error('Error while bundling types:', error);
+    process.exit(1);
+}
+const endTime = Date.now().valueOf();
+console.log(`📦 Types bundled successfully (${endTime - startTime}ms)`);

package/dist/bundleTypes.js

@@ -0,0 +1,41 @@
+import { getImportsInfo } from '@grafana/levitate';
+import { generateDtsBundle } from 'jackw-dts-bundle-gen-test';
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { extname, join } from 'node:path';
+export const generateTypes = ({ entryPoint, tsConfig, outDir }) => {
+    if (!entryPoint) {
+        throw new Error('Please provide the path for the entry types file as an argument.');
+    }
+    const entryPoints = [
+        {
+            filePath: entryPoint,
+            libraries: {
+                inlinedLibraries: getImportedPackages(entryPoint),
+            },
+        },
+    ];
+    const options = {
+        preferredConfigPath: tsConfig,
+    };
+    const dts = generateDtsBundle(entryPoints, options);
+    const cleanedDts = cleanDTS(dts);
+    mkdirSync(outDir, { recursive: true });
+    writeFileSync(join(outDir, 'index.d.ts'), cleanedDts);
+};
+function getImportedPackages(entryPoint) {
+    const { imports } = getImportsInfo(entryPoint);
+    const npmPackages = imports
+        .map((importInfo) => importInfo.packageName)
+        .filter((packageName) => isBareSpecifier(packageName));
+    return Array.from(new Set(npmPackages));
+}
+function cleanDTS(dtsContent) {
+    let dtsString = dtsContent.join('\n');
+    dtsString = dtsString.replace('export {};', '');
+    return dtsString.trim() + '\n';
+}
+function isBareSpecifier(packageName) {
+    const isRelative = packageName.startsWith('./') || packageName.startsWith('../') || packageName.startsWith('/');
+    const hasExtension = extname(packageName) !== '';
+    return !isRelative && !hasExtension;
+}

package/dist/utils.js

@@ -0,0 +1,20 @@
+import parseArgs from 'minimist';
+import { join } from 'node:path';
+const args = process.argv.slice(2);
+export const parsedArgs = parseArgs(args, {
+    alias: {
+        entryPoint: 'entry-point',
+        tsConfig: 'ts-config',
+        outDir: 'out-dir',
+    },
+    string: ['entryPoint', 'tsConfig', 'outDir'],
+    unknown: (arg) => {
+        console.error(`Unknown argument: ${arg}`);
+        process.exit(1);
+    },
+    default: {
+        entryPoint: undefined,
+        tsConfig: join(process.cwd(), 'tsconfig.json'),
+        outDir: join(process.cwd(), 'dist'),
+    },
+});

package/package.json

@@ -1,18 +1,31 @@
 {
   "name": "@grafana/plugin-types-bundler",
-  "version": "0.0.1",
+  "version": "0.0.2-canary.1162.c54d7e1.0",
   "description": "Bundle grafana plugin typescript types for sharing with other plugins",
-  "main": "index.js",
+  "bin": "./dist/bin/run.js",
+  "type": "module",
+  "exports": {
+    "node": {
+      "import": "./dist/bundleTypes.js"
+    },
+    "default": "./dist/bundleTypes.js"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "vitest --passWithNoTests",
+    "build": "tsc --project tsconfig.json && chmod +x ./dist/bin/run.js",
+    "dev": "tsc --project tsconfig.json --watch",
+    "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
+    "lint:fix": "npm run lint -- --fix",
+    "typecheck": "tsc --noEmit"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "repository": {
     "directory": "packages/plugin-types-bundler",
-    "url": "git+https://github.com/grafana/plugin-tools.git"
+    "url": "https://github.com/grafana/plugin-tools"
   },
   "keywords": [
     "grafana",
@@ -28,5 +41,13 @@
   },
   "engines": {
     "node": ">=18.8.0"
-  }
+  },
+  "dependencies": {
+    "@grafana/levitate": "^0.14.0",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "20.10.1",
+    "jackw-dts-bundle-gen-test": "^9.5.1",
+    "minimist": "^1.2.8"
+  },
+  "gitHead": "c54d7e126ed18fae732238d624be590298414276"
 }

package/src/bin/run.ts

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import { existsSync } from 'fs';
+import { generateTypes } from '../bundleTypes.js';
+import { parsedArgs } from '../utils.js';
+
+const { entryPoint, tsConfig, outDir } = parsedArgs;
+
+// Check if the first argument is present
+if (entryPoint === undefined) {
+  console.error('Please provide the path for the entry types file as an argument.');
+  console.error('(E.g. "npx @grafana/plugin-types-bundler ./src/types/index.ts")');
+  process.exit(1);
+}
+
+// Check if the file exists
+if (!existsSync(entryPoint)) {
+  console.error(`File not found: ${entryPoint}`);
+  process.exit(1);
+}
+
+const startTime = Date.now().valueOf();
+try {
+  console.log('⚡️ Starting to bundle types for plugin...');
+  generateTypes({ entryPoint, tsConfig, outDir });
+} catch (error) {
+  console.error('Error while bundling types:', error);
+  process.exit(1);
+}
+
+const endTime = Date.now().valueOf();
+console.log(`📦 Types bundled successfully (${endTime - startTime}ms)`);

package/src/bundleTypes.ts

@@ -0,0 +1,49 @@
+import { getImportsInfo } from '@grafana/levitate';
+import { EntryPointConfig, generateDtsBundle } from 'jackw-dts-bundle-gen-test';
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { extname, join } from 'node:path';
+import type { ParsedArgs } from './utils.js';
+
+export const generateTypes = ({ entryPoint, tsConfig, outDir }: ParsedArgs) => {
+  if (!entryPoint) {
+    throw new Error('Please provide the path for the entry types file as an argument.');
+  }
+
+  const entryPoints: EntryPointConfig[] = [
+    {
+      filePath: entryPoint,
+      libraries: {
+        inlinedLibraries: getImportedPackages(entryPoint),
+      },
+    },
+  ];
+  const options = {
+    preferredConfigPath: tsConfig,
+  };
+  const dts = generateDtsBundle(entryPoints, options);
+  const cleanedDts = cleanDTS(dts);
+
+  mkdirSync(outDir, { recursive: true });
+  writeFileSync(join(outDir, 'index.d.ts'), cleanedDts);
+};
+
+function getImportedPackages(entryPoint: string) {
+  const { imports } = getImportsInfo(entryPoint);
+  const npmPackages = imports
+    .map((importInfo) => importInfo.packageName)
+    .filter((packageName) => isBareSpecifier(packageName));
+  // Remove duplicates
+  return Array.from(new Set(npmPackages));
+}
+
+function cleanDTS(dtsContent: string[]) {
+  let dtsString = dtsContent.join('\n');
+  dtsString = dtsString.replace('export {};', '');
+  return dtsString.trim() + '\n';
+}
+
+function isBareSpecifier(packageName: string) {
+  const isRelative = packageName.startsWith('./') || packageName.startsWith('../') || packageName.startsWith('/');
+  const hasExtension = extname(packageName) !== '';
+  return !isRelative && !hasExtension;
+}

package/src/utils.ts

@@ -0,0 +1,28 @@
+import parseArgs from 'minimist';
+import { join } from 'node:path';
+
+const args = process.argv.slice(2);
+
+export type ParsedArgs = {
+  entryPoint?: string;
+  tsConfig: string;
+  outDir: string;
+};
+
+export const parsedArgs = parseArgs<ParsedArgs>(args, {
+  alias: {
+    entryPoint: 'entry-point',
+    tsConfig: 'ts-config',
+    outDir: 'out-dir',
+  },
+  string: ['entryPoint', 'tsConfig', 'outDir'],
+  unknown: (arg) => {
+    console.error(`Unknown argument: ${arg}`);
+    process.exit(1);
+  },
+  default: {
+    entryPoint: undefined,
+    tsConfig: join(process.cwd(), 'tsconfig.json'),
+    outDir: join(process.cwd(), 'dist'),
+  },
+});

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "exclude": ["node_modules"],
+  "extends": "../../tsconfig.base.json",
+  "include": ["src"]
+}

package/index.js

@@ -1 +0,0 @@
-console.log('@grafana/plugin-types-bundler');