create-selfchecks 0.1.1

package/dist/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}

package/dist/bin.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+import path from "node:path";
+import { createSelfchecksProject } from "./index.js";
+const args = process.argv.slice(2);
+if (args.includes("--help") || args.includes("-h")) {
+    printHelp();
+    process.exit(0);
+}
+const skipInstall = args.includes("--skip-install");
+const positionalArgs = args.filter((argument) => !argument.startsWith("-"));
+const unknownOptions = args.filter((argument) => argument.startsWith("-") && argument !== "--skip-install");
+if (unknownOptions.length > 0) {
+    fail(`Unknown option: ${unknownOptions[0]}`);
+}
+else if (positionalArgs.length > 1) {
+    fail("Expected at most one target directory.");
+}
+else {
+    const targetDir = positionalArgs[0] ?? "selfchecks-project";
+    createSelfchecksProject({ install: !skipInstall, targetDir })
+        .then((result) => {
+        const relativeDir = path.relative(process.cwd(), result.targetDir) || ".";
+        const displayDir = path.isAbsolute(targetDir) ? result.targetDir : relativeDir;
+        process.stdout.write(`\nCreated Selfchecks project in ${result.targetDir}\n\n`);
+        process.stdout.write("Next steps:\n");
+        if (relativeDir !== ".") {
+            process.stdout.write(`  cd ${JSON.stringify(displayDir)}\n`);
+        }
+        if (!result.installed) {
+            process.stdout.write("  npm install\n");
+        }
+        process.stdout.write("  npx playwright install chromium\n");
+        process.stdout.write("  npm test\n");
+    })
+        .catch((error) => {
+        fail(error instanceof Error ? error.message : String(error));
+    });
+}
+function printHelp() {
+    process.stdout.write(`Usage: create-selfchecks [directory] [options]
+
+Create a minimal Selfchecks project with a browser check for
+https://selfchecks.github.io/.
+
+Arguments:
+  directory       Target directory (default: selfchecks-project)
+
+Options:
+  --skip-install  Create files without running npm install
+  -h, --help      Display this help
+`);
+}
+function fail(message) {
+    process.stderr.write(`${message}\n`);
+    process.exitCode = 1;
+}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export type CreateSelfchecksOptions = {
+    install?: boolean;
+    targetDir: string;
+};
+export type CreateSelfchecksResult = {
+    installed: boolean;
+    projectName: string;
+    targetDir: string;
+};
+export declare function createSelfchecksProject(options: CreateSelfchecksOptions): Promise<CreateSelfchecksResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC,CAyBjC"}

package/dist/index.js

@@ -0,0 +1,55 @@
+import { spawn } from "node:child_process";
+import { mkdir, readdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { createPackageJson, starterFiles } from "./templates.js";
+export async function createSelfchecksProject(options) {
+    const targetDir = path.resolve(options.targetDir);
+    const projectName = normalizePackageName(path.basename(targetDir));
+    await ensureEmptyDirectory(targetDir);
+    const files = {
+        ...starterFiles,
+        "package.json": createPackageJson(projectName),
+    };
+    for (const [relativePath, content] of Object.entries(files)) {
+        const filePath = path.join(targetDir, relativePath);
+        await mkdir(path.dirname(filePath), { recursive: true });
+        await writeFile(filePath, content, "utf8");
+    }
+    const install = options.install ?? true;
+    if (install) {
+        await installDependencies(targetDir);
+    }
+    return { installed: install, projectName, targetDir };
+}
+async function ensureEmptyDirectory(targetDir) {
+    await mkdir(targetDir, { recursive: true });
+    const entries = await readdir(targetDir);
+    if (entries.length > 0) {
+        throw new Error(`Target directory is not empty: ${targetDir}`);
+    }
+}
+async function installDependencies(targetDir) {
+    const npmCommand = process.platform === "win32" ? "npm.cmd" : "npm";
+    await new Promise((resolve, reject) => {
+        const child = spawn(npmCommand, ["install", "--no-audit", "--no-fund"], {
+            cwd: targetDir,
+            stdio: "inherit",
+        });
+        child.once("error", reject);
+        child.once("close", (status) => {
+            if (status === 0) {
+                resolve();
+                return;
+            }
+            reject(new Error(`npm install exited with status ${status ?? "unknown"}.`));
+        });
+    });
+}
+function normalizePackageName(value) {
+    const normalized = value
+        .trim()
+        .toLowerCase()
+        .replace(/[^a-z0-9._-]+/g, "-")
+        .replace(/^[._-]+|[._-]+$/g, "");
+    return normalized || "selfchecks-project";
+}

package/dist/templates.d.ts

@@ -0,0 +1,12 @@
+export declare const SELFCHECKS_PACKAGE_VERSION = "0.1.1";
+export declare const starterFiles: {
+    readonly ".gitignore": "node_modules/\nplaywright-report/\ntest-results/\n.selfchecks/\n";
+    readonly "README.md": "# Selfchecks starter\n\nThis project was created with `create-selfchecks` and checks that the Selfchecks\nwebsite is available.\n\n```bash\nnpx playwright install chromium\nnpm test\n\nexport SELFCHECKS_URL=https://checks.example.com\nexport SELFCHECKS_API_TOKEN=replace-with-a-secret\nnpm run selfchecks -- deploy --project starter --root .\n```\n";
+    readonly "checkly.config.ts": "import { defineConfig } from \"@selfchecks/selfchecks\";\nimport { Frequency } from \"@selfchecks/selfchecks/constructs\";\n\nexport default defineConfig({\n  projectName: \"Selfchecks starter\",\n  logicalId: \"selfchecks-starter\",\n  checks: {\n    activated: true,\n    frequency: Frequency.EVERY_10M,\n    checkMatch: \"**/*.check.ts\",\n    browserChecks: {\n      testMatch: \"**/*.spec.ts\",\n    },\n  },\n});\n";
+    readonly "checks/homepage.check.ts": "import { BrowserCheck, Frequency } from \"@selfchecks/selfchecks/constructs\";\n\nnew BrowserCheck(\"selfchecks-homepage\", {\n  name: \"Selfchecks homepage\",\n  activated: true,\n  frequency: Frequency.EVERY_10M,\n  tags: [\"starter\", \"browser\"],\n  code: {\n    entrypoint: \"homepage.spec.ts\",\n  },\n});\n";
+    readonly "checks/homepage.spec.ts": "import { expect, test } from \"@playwright/test\";\n\ntest(\"selfchecks.github.io is available\", async ({ page }) => {\n  const response = await page.goto(\"https://selfchecks.github.io/\");\n\n  expect(response?.ok()).toBe(true);\n  await expect(page).toHaveTitle(/Selfchecks/i);\n});\n";
+    readonly "playwright.config.ts": "import { defineConfig } from \"@playwright/test\";\n\nexport default defineConfig({\n  testDir: \"./checks\",\n  timeout: 60_000,\n  use: {\n    screenshot: \"only-on-failure\",\n    trace: \"retain-on-failure\",\n  },\n});\n";
+    readonly "tsconfig.json": "{\n  \"compilerOptions\": {\n    \"lib\": [\"ESNext\", \"DOM\", \"DOM.Iterable\"],\n    \"module\": \"NodeNext\",\n    \"moduleResolution\": \"NodeNext\",\n    \"noEmit\": true,\n    \"strict\": true,\n    \"target\": \"ES2022\",\n    \"types\": [\"node\"]\n  },\n  \"include\": [\"**/*.ts\"]\n}\n";
+};
+export declare function createPackageJson(projectName: string): string;
+//# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,UAAU,CAAC;AAElD,eAAO,MAAM,YAAY;;;;;;;;CAiFf,CAAC;AAEX,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAyB7D"}

package/dist/templates.js

@@ -0,0 +1,105 @@
+export const SELFCHECKS_PACKAGE_VERSION = "0.1.1";
+export const starterFiles = {
+    ".gitignore": `node_modules/
+playwright-report/
+test-results/
+.selfchecks/
+`,
+    "README.md": `# Selfchecks starter
+
+This project was created with \`create-selfchecks\` and checks that the Selfchecks
+website is available.
+
+\`\`\`bash
+npx playwright install chromium
+npm test
+
+export SELFCHECKS_URL=https://checks.example.com
+export SELFCHECKS_API_TOKEN=replace-with-a-secret
+npm run selfchecks -- deploy --project starter --root .
+\`\`\`
+`,
+    "checkly.config.ts": `import { defineConfig } from "@selfchecks/selfchecks";
+import { Frequency } from "@selfchecks/selfchecks/constructs";
+
+export default defineConfig({
+  projectName: "Selfchecks starter",
+  logicalId: "selfchecks-starter",
+  checks: {
+    activated: true,
+    frequency: Frequency.EVERY_10M,
+    checkMatch: "**/*.check.ts",
+    browserChecks: {
+      testMatch: "**/*.spec.ts",
+    },
+  },
+});
+`,
+    "checks/homepage.check.ts": `import { BrowserCheck, Frequency } from "@selfchecks/selfchecks/constructs";
+
+new BrowserCheck("selfchecks-homepage", {
+  name: "Selfchecks homepage",
+  activated: true,
+  frequency: Frequency.EVERY_10M,
+  tags: ["starter", "browser"],
+  code: {
+    entrypoint: "homepage.spec.ts",
+  },
+});
+`,
+    "checks/homepage.spec.ts": `import { expect, test } from "@playwright/test";
+
+test("selfchecks.github.io is available", async ({ page }) => {
+  const response = await page.goto("https://selfchecks.github.io/");
+
+  expect(response?.ok()).toBe(true);
+  await expect(page).toHaveTitle(/Selfchecks/i);
+});
+`,
+    "playwright.config.ts": `import { defineConfig } from "@playwright/test";
+
+export default defineConfig({
+  testDir: "./checks",
+  timeout: 60_000,
+  use: {
+    screenshot: "only-on-failure",
+    trace: "retain-on-failure",
+  },
+});
+`,
+    "tsconfig.json": `{
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "strict": true,
+    "target": "ES2022",
+    "types": ["node"]
+  },
+  "include": ["**/*.ts"]
+}
+`,
+};
+export function createPackageJson(projectName) {
+    return `${JSON.stringify({
+        name: projectName,
+        version: "0.0.0",
+        private: true,
+        type: "module",
+        scripts: {
+            selfchecks: "selfchecks",
+            test: "playwright test",
+            typecheck: "tsc --noEmit",
+        },
+        dependencies: {
+            "@playwright/test": "1.58.2",
+        },
+        devDependencies: {
+            "@selfchecks/selfchecks": SELFCHECKS_PACKAGE_VERSION,
+            "@selfchecks/selfchecks-cli": SELFCHECKS_PACKAGE_VERSION,
+            "@types/node": "^20.19.1",
+            typescript: "^5.8.3",
+        },
+    }, null, 2)}\n`;
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "create-selfchecks",
+  "version": "0.1.1",
+  "description": "Create a minimal Selfchecks project",
+  "type": "module",
+  "files": [
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "dist/**/*.js"
+  ],
+  "bin": "./dist/bin.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/selfchecks/selfchecks.git",
+    "directory": "packages/create-selfchecks"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node -e \"require('node:fs').chmodSync('dist/bin.js', 0o755)\"",
+    "test": "vitest run --root ../.. packages/create-selfchecks/src/index.test.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
+  }
+}