aboutsummaryrefslogtreecommitdiff
path: root/benchmark/bench/_template.js
diff options
context:
space:
mode:
Diffstat (limited to 'benchmark/bench/_template.js')
-rw-r--r--benchmark/bench/_template.js12
1 files changed, 12 insertions, 0 deletions
diff --git a/benchmark/bench/_template.js b/benchmark/bench/_template.js
new file mode 100644
index 000000000..ae96d72ad
--- /dev/null
+++ b/benchmark/bench/_template.js
@@ -0,0 +1,12 @@
+/** Default project to run for this benchmark if not specified */
+export const defaultProject = 'project-name';
+
+/**
+ * Run benchmark on `projectDir` and write results to `outputFile`.
+ * Use `console.log` to report the results too. Logs that start with 10 `=`
+ * and end with 10 `=` will be extracted by CI to display in the PR comment.
+ * Usually after the first 10 `=` you'll want to add a title like `#### Test`.
+ * @param {URL} _projectDir
+ * @param {URL} _outputFile
+ */
+export async function run(_projectDir, _outputFile) {}