chore: leave a link to Testplane config docs

Author: KuznetsovRoman

__fixtures/config/jsConfig.js

@@ -1,3 +1,4 @@
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 module.exports = {
     gridUrl: 'local',
     baseUrl: 'http://localhost',

__fixtures/config/withComments.js

@@ -1,3 +1,4 @@
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 module.exports = {
     // some comment
     // other comment

__fixtures/config/withEverything.js

@@ -3,6 +3,7 @@ import path from "path";
 
 const isCi = Boolean(process.env.CI);
 
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 export default {
     gridUrl: "local",
     baseUrl: "http://localhost",

__fixtures/config/withExpressions.js

@@ -1,3 +1,4 @@
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 module.exports = {
     foo: Boolean(100 + 500 * 1),
     bar: 4,

__fixtures/config/withModules.js

@@ -2,4 +2,5 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 module.exports = {};

__fixtures/config/withTypescript.js

@@ -2,4 +2,5 @@ import fs from "fs";
 import os from "os";
 import path from "path";
 
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 export default {} satisfies import("testplane").ConfigInput;

__fixtures/config/withVariables.js

@@ -2,4 +2,5 @@ const isCi = process.env.CI;
 const numbersSum = 100 + 500;
 const somePath = path.resolve(os.homedir(), ".some-folder");
 
+// Read more about configuring Testplane at https://testplane.io/docs/v8/config/main/
 module.exports = {};

src/constants/index.ts

@@ -0,0 +1 @@
+export const TESTPLANE_CONFIG_URL = "https://testplane.io/docs/v8/config/main/";

src/fsUtils.ts

@@ -2,6 +2,7 @@ import _ from "lodash";
 import fs from "fs";
 import path from "path";
 import { defaultTestplaneTestsDir } from "./constants/defaultTestplaneConfig";
+import { TESTPLANE_CONFIG_URL } from "./constants";
 import type { TestplaneConfig } from "./types/testplaneConfig";
 
 const createDirectory = (path: string): Promise<string | undefined> => fs.promises.mkdir(path, { recursive: true });
@@ -123,7 +124,8 @@ export const writeTestplaneConfig = async (dirPath: string, testplaneConfig: Tes
         .map(variable => `const ${variable} = ${variables[variable]};`)
         .join("\n");
 
-    const configBody = template.getExportConfig(getObjectRepr(omittedConfig));
+    const rawConfigBody = template.getExportConfig(getObjectRepr(omittedConfig));
+    const configBody = `// Read more about configuring Testplane at ${TESTPLANE_CONFIG_URL}\n${rawConfigBody}`;
 
     const configContents = [configImports, configVariables, configBody].filter(Boolean).join("\n\n");
     const configFileName = template.fileName;