create-donobu-plugin 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +54 -54
- package/package.json +1 -1
package/index.js
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
-
import { mkdir, writeFile, readFile } from
|
|
4
|
-
import { join, dirname } from
|
|
5
|
-
import { createRequire } from
|
|
3
|
+
import { mkdir, writeFile, readFile } from 'fs/promises';
|
|
4
|
+
import { join, dirname } from 'path';
|
|
5
|
+
import { createRequire } from 'module';
|
|
6
6
|
|
|
7
7
|
async function getDonobuVersions() {
|
|
8
8
|
try {
|
|
9
9
|
// Find the donobu package.json by resolving the module path
|
|
10
10
|
const require = createRequire(import.meta.url);
|
|
11
|
-
const donobuPath = require.resolve(
|
|
11
|
+
const donobuPath = require.resolve('donobu');
|
|
12
12
|
// Navigate up to find package.json (donobu path might point to dist/main.js)
|
|
13
13
|
const donobuDir = dirname(donobuPath);
|
|
14
|
-
let packageJsonPath = join(donobuDir,
|
|
14
|
+
let packageJsonPath = join(donobuDir, 'package.json');
|
|
15
15
|
|
|
16
16
|
try {
|
|
17
|
-
await readFile(packageJsonPath,
|
|
17
|
+
await readFile(packageJsonPath, 'utf8');
|
|
18
18
|
} catch {
|
|
19
19
|
// If not found, try going up one more directory
|
|
20
|
-
packageJsonPath = join(dirname(donobuDir),
|
|
20
|
+
packageJsonPath = join(dirname(donobuDir), 'package.json');
|
|
21
21
|
}
|
|
22
22
|
|
|
23
|
-
const packageJsonContent = await readFile(packageJsonPath,
|
|
23
|
+
const packageJsonContent = await readFile(packageJsonPath, 'utf8');
|
|
24
24
|
const donobuPackageJson = JSON.parse(packageJsonContent);
|
|
25
25
|
|
|
26
26
|
return {
|
|
@@ -28,19 +28,19 @@ async function getDonobuVersions() {
|
|
|
28
28
|
playwrightVersion:
|
|
29
29
|
donobuPackageJson.devDependencies?.playwright ||
|
|
30
30
|
donobuPackageJson.dependencies?.playwright ||
|
|
31
|
-
donobuPackageJson.peerDependencies?.playwright?.replace(/^>=/,
|
|
32
|
-
|
|
31
|
+
donobuPackageJson.peerDependencies?.playwright?.replace(/^>=/, '') ||
|
|
32
|
+
'1.53.2',
|
|
33
33
|
playwrightTestVersion:
|
|
34
|
-
donobuPackageJson.devDependencies?.[
|
|
35
|
-
donobuPackageJson.dependencies?.[
|
|
36
|
-
donobuPackageJson.peerDependencies?.[
|
|
34
|
+
donobuPackageJson.devDependencies?.['@playwright/test'] ||
|
|
35
|
+
donobuPackageJson.dependencies?.['@playwright/test'] ||
|
|
36
|
+
donobuPackageJson.peerDependencies?.['@playwright/test']?.replace(
|
|
37
37
|
/^>=/,
|
|
38
|
-
|
|
38
|
+
''
|
|
39
39
|
) ||
|
|
40
|
-
|
|
40
|
+
'1.53.2',
|
|
41
41
|
};
|
|
42
42
|
} catch (error) {
|
|
43
|
-
console.error(
|
|
43
|
+
console.error('Could not read the Donobu package.json file!');
|
|
44
44
|
throw error;
|
|
45
45
|
}
|
|
46
46
|
}
|
|
@@ -54,8 +54,8 @@ async function createPluginStructure(pluginName) {
|
|
|
54
54
|
console.log(`Using Playwright version: ${versions.playwrightVersion}`);
|
|
55
55
|
// Create directory structure
|
|
56
56
|
await mkdir(pluginDir, { recursive: true });
|
|
57
|
-
await mkdir(join(pluginDir,
|
|
58
|
-
console.log(
|
|
57
|
+
await mkdir(join(pluginDir, 'src'), { recursive: true });
|
|
58
|
+
console.log('Creating files...');
|
|
59
59
|
await createTemplateFiles(pluginDir, pluginName, versions);
|
|
60
60
|
console.log(`\nPlugin "${pluginName}" created successfully!`);
|
|
61
61
|
console.log(`\nNext steps:`);
|
|
@@ -69,71 +69,71 @@ async function createTemplateFiles(pluginDir, pluginName, versions) {
|
|
|
69
69
|
// Create package.json
|
|
70
70
|
const packageJson = {
|
|
71
71
|
name: pluginName,
|
|
72
|
-
version:
|
|
72
|
+
version: '1.0.0',
|
|
73
73
|
private: true,
|
|
74
|
-
type:
|
|
75
|
-
description:
|
|
76
|
-
main:
|
|
77
|
-
types:
|
|
74
|
+
type: 'module',
|
|
75
|
+
description: 'Custom tools for use by Donobu.',
|
|
76
|
+
main: './dist/index.mjs',
|
|
77
|
+
types: './dist/index.d.ts',
|
|
78
78
|
exports: {
|
|
79
|
-
|
|
79
|
+
'.': './dist/index.mjs',
|
|
80
80
|
},
|
|
81
|
-
files: [
|
|
81
|
+
files: ['dist'],
|
|
82
82
|
scripts: {
|
|
83
|
-
clean:
|
|
83
|
+
clean: 'rm -rf dist',
|
|
84
84
|
build:
|
|
85
|
-
|
|
85
|
+
'npm run clean && npm install && tsc -p tsconfig.json && node esbuild.config.mjs',
|
|
86
86
|
},
|
|
87
|
-
license:
|
|
87
|
+
license: 'UNLICENSED',
|
|
88
88
|
devDependencies: {
|
|
89
89
|
donobu: `^${versions.donobuVersion}`,
|
|
90
90
|
playwright: versions.playwrightVersion,
|
|
91
|
-
|
|
92
|
-
typescript:
|
|
93
|
-
esbuild:
|
|
91
|
+
'@playwright/test': versions.playwrightTestVersion,
|
|
92
|
+
typescript: '^5.8.3',
|
|
93
|
+
esbuild: '^0.25.6',
|
|
94
94
|
},
|
|
95
95
|
peerDependencies: {
|
|
96
96
|
donobu: `>=${versions.donobuVersion}`,
|
|
97
97
|
playwright: `>=${versions.playwrightVersion}`,
|
|
98
|
-
|
|
98
|
+
'@playwright/test': `>=${versions.playwrightTestVersion}`,
|
|
99
99
|
},
|
|
100
100
|
peerDependenciesMeta: {
|
|
101
101
|
playwright: {
|
|
102
102
|
optional: false,
|
|
103
103
|
},
|
|
104
|
-
|
|
104
|
+
'@playwright/test': {
|
|
105
105
|
optional: false,
|
|
106
106
|
},
|
|
107
107
|
},
|
|
108
108
|
dependencies: {
|
|
109
|
-
zod:
|
|
109
|
+
zod: '^3.25.76',
|
|
110
110
|
},
|
|
111
111
|
};
|
|
112
112
|
|
|
113
113
|
await writeFile(
|
|
114
|
-
join(pluginDir,
|
|
114
|
+
join(pluginDir, 'package.json'),
|
|
115
115
|
JSON.stringify(packageJson, null, 2)
|
|
116
116
|
);
|
|
117
117
|
|
|
118
118
|
// Create tsconfig.json
|
|
119
119
|
const tsConfig = {
|
|
120
120
|
compilerOptions: {
|
|
121
|
-
target:
|
|
122
|
-
module:
|
|
123
|
-
moduleResolution:
|
|
124
|
-
rootDir:
|
|
125
|
-
outDir:
|
|
121
|
+
target: 'ES2020',
|
|
122
|
+
module: 'NodeNext',
|
|
123
|
+
moduleResolution: 'NodeNext',
|
|
124
|
+
rootDir: './src',
|
|
125
|
+
outDir: './dist',
|
|
126
126
|
declaration: true,
|
|
127
127
|
strict: true,
|
|
128
128
|
esModuleInterop: true,
|
|
129
129
|
skipLibCheck: true,
|
|
130
130
|
forceConsistentCasingInFileNames: true,
|
|
131
131
|
},
|
|
132
|
-
include: [
|
|
132
|
+
include: ['src/**/*'],
|
|
133
133
|
};
|
|
134
134
|
|
|
135
135
|
await writeFile(
|
|
136
|
-
join(pluginDir,
|
|
136
|
+
join(pluginDir, 'tsconfig.json'),
|
|
137
137
|
JSON.stringify(tsConfig, null, 2)
|
|
138
138
|
);
|
|
139
139
|
|
|
@@ -151,7 +151,7 @@ await build({
|
|
|
151
151
|
});
|
|
152
152
|
`;
|
|
153
153
|
|
|
154
|
-
await writeFile(join(pluginDir,
|
|
154
|
+
await writeFile(join(pluginDir, 'esbuild.config.mjs'), esbuildConfig);
|
|
155
155
|
|
|
156
156
|
// Create src/index.ts
|
|
157
157
|
const indexTs = `import type { Tool } from "donobu";
|
|
@@ -165,10 +165,10 @@ export async function loadCustomTools(
|
|
|
165
165
|
}
|
|
166
166
|
`;
|
|
167
167
|
|
|
168
|
-
await writeFile(join(pluginDir,
|
|
168
|
+
await writeFile(join(pluginDir, 'src', 'index.ts'), indexTs);
|
|
169
169
|
|
|
170
170
|
// Create src/createTool.ts
|
|
171
|
-
const createToolTs = `import { z } from "zod";
|
|
171
|
+
const createToolTs = `import { z } from "zod/v4";
|
|
172
172
|
import type { ToolCallContext, ToolCallResult, Tool } from "donobu";
|
|
173
173
|
import { PluginDependencies } from "./PluginDependencies.js";
|
|
174
174
|
|
|
@@ -244,7 +244,7 @@ export interface CreateToolOptions<
|
|
|
244
244
|
}
|
|
245
245
|
`;
|
|
246
246
|
|
|
247
|
-
await writeFile(join(pluginDir,
|
|
247
|
+
await writeFile(join(pluginDir, 'src', 'createTool.ts'), createToolTs);
|
|
248
248
|
|
|
249
249
|
// Create src/PluginDependencies.ts
|
|
250
250
|
const pluginDepsTs = `export interface PluginDependencies {
|
|
@@ -254,7 +254,7 @@ export interface CreateToolOptions<
|
|
|
254
254
|
`;
|
|
255
255
|
|
|
256
256
|
await writeFile(
|
|
257
|
-
join(pluginDir,
|
|
257
|
+
join(pluginDir, 'src', 'PluginDependencies.ts'),
|
|
258
258
|
pluginDepsTs
|
|
259
259
|
);
|
|
260
260
|
|
|
@@ -274,24 +274,24 @@ A custom Donobu plugin with tools for browser automation.
|
|
|
274
274
|
3. Restart Donobu to see your tools
|
|
275
275
|
`;
|
|
276
276
|
|
|
277
|
-
await writeFile(join(pluginDir,
|
|
277
|
+
await writeFile(join(pluginDir, 'README.md'), readme);
|
|
278
278
|
}
|
|
279
279
|
|
|
280
280
|
async function main() {
|
|
281
281
|
const pluginName = process.argv[2];
|
|
282
282
|
|
|
283
283
|
if (!pluginName) {
|
|
284
|
-
console.error(
|
|
285
|
-
console.error(
|
|
286
|
-
console.error(
|
|
287
|
-
console.error(
|
|
284
|
+
console.error('Usage: create-donobu-plugin <plugin-name>');
|
|
285
|
+
console.error('');
|
|
286
|
+
console.error('Example:');
|
|
287
|
+
console.error(' npm create donobu-plugin my-awesome-plugin');
|
|
288
288
|
process.exit(1);
|
|
289
289
|
}
|
|
290
290
|
|
|
291
291
|
// Validate plugin name
|
|
292
292
|
if (!/^[a-z0-9-_]+$/.test(pluginName)) {
|
|
293
293
|
console.error(
|
|
294
|
-
|
|
294
|
+
'Plugin name must contain only lowercase letters, numbers, hyphens, and underscores'
|
|
295
295
|
);
|
|
296
296
|
process.exit(1);
|
|
297
297
|
}
|
|
@@ -299,7 +299,7 @@ async function main() {
|
|
|
299
299
|
try {
|
|
300
300
|
await createPluginStructure(pluginName);
|
|
301
301
|
} catch (error) {
|
|
302
|
-
console.error(
|
|
302
|
+
console.error('Failed to create plugin:', error.message);
|
|
303
303
|
process.exit(1);
|
|
304
304
|
}
|
|
305
305
|
}
|