diff --git a/packages/cli/scripts/compile-rules.ts b/packages/cli/scripts/compile-rules.ts index 83a3d94f..5bb8d37b 100644 --- a/packages/cli/scripts/compile-rules.ts +++ b/packages/cli/scripts/compile-rules.ts @@ -1,5 +1,5 @@ /* eslint-disable no-console */ -import { readFile, writeFile, mkdir } from 'fs/promises'; +import { mkdir, readFile, writeFile } from 'fs/promises'; import { join } from 'path'; const EXAMPLES_DIR = join(__dirname, '../gen/'); @@ -12,6 +12,11 @@ const EXAMPLE_CONFIGS: Record< string, { templateString: string; exampleConfigPath: string } > = { + CHECKLY_CONFIG: { + templateString: '// INSERT CHECKLY CONFIG EXAMPLE HERE //', + exampleConfigPath: + '../../../examples/boilerplate-project/checkly.config.ts', + }, BROWSER_CHECK: { templateString: '// INSERT BROWSER CHECK EXAMPLE HERE //', exampleConfigPath: diff --git a/packages/cli/src/rules/checkly.rules.template.md b/packages/cli/src/rules/checkly.rules.template.md index 47fd4a18..c70491b6 100644 --- a/packages/cli/src/rules/checkly.rules.template.md +++ b/packages/cli/src/rules/checkly.rules.template.md @@ -33,6 +33,10 @@ Here is an example directory tree of what that would look like: The `checkly.config.ts` at the root of your project defines a range of defaults for all your checks. +```typescript +// INSERT CHECKLY CONFIG EXAMPLE HERE // +``` + ## Check and Monitor Constructs ### API Check