create-selfchecks 0.1.4 → 0.1.5

package/README.md

@@ -0,0 +1,61 @@
+# create-selfchecks
+
+Create a minimal [Selfchecks](https://selfchecks.github.io/) project with one browser
+check for `https://selfchecks.github.io/`.
+
+## Quick start
+
+```bash
+npx create-selfchecks my-checks
+cd my-checks
+npx playwright install chromium
+npm test
+```
+
+Without a directory argument, the command creates `./selfchecks-project`. The target
+directory must be empty.
+
+## Options
+
+```text
+Usage: create-selfchecks [directory] [options]
+
+Options:
+  --skip-install  Create files without running npm install
+  -h, --help      Display help
+```
+
+Node.js 20 or newer is required.
+
+## Generated project
+
+The starter includes:
+
+- a Selfchecks configuration;
+- a `BrowserCheck` definition;
+- a Playwright test that opens `https://selfchecks.github.io/`;
+- TypeScript and Playwright configuration;
+- scripts for local tests, typechecking, and remote deployment.
+
+To deploy the generated check, configure your Selfchecks server and use the included
+CLI:
+
+```bash
+export SELFCHECKS_URL=https://checks.example.com
+export SELFCHECKS_API_TOKEN=replace-with-a-secret
+npm run selfchecks -- deploy --project my-project --root .
+```
+
+## Programmatic API
+
+```ts
+import { createSelfchecksProject } from "create-selfchecks";
+
+await createSelfchecksProject({
+  targetDir: "./my-checks",
+  install: false,
+});
+```
+
+See the [Selfchecks getting started guide](https://selfchecks.github.io/getting-started.html)
+for the next steps.

package/dist/templates.d.ts

@@ -1,4 +1,4 @@
-export declare const SELFCHECKS_PACKAGE_VERSION = "0.1.4";
+export declare const SELFCHECKS_PACKAGE_VERSION = "0.1.5";
 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";

package/dist/templates.js

@@ -1,4 +1,4 @@
-export const SELFCHECKS_PACKAGE_VERSION = "0.1.4";
+export const SELFCHECKS_PACKAGE_VERSION = "0.1.5";
 export const starterFiles = {
     ".gitignore": `node_modules/
 playwright-report/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-selfchecks",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Create a minimal Selfchecks project",
   "type": "module",
   "files": [