@zappie/check 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @zappie/check
+
+## 0.1.1
+
+### Patch Changes
+
+- eeccfed: First release on npm. `zappie check` and `zappie verify` now work in any project that installs these as dev dependencies. `@zappie/verify` takes `@playwright/test` as a peer dependency.
+- Updated dependencies [38f23ac]
+- Updated dependencies [1e6f420]
+- Updated dependencies [eeccfed]
+  - @zappie/sdk@0.1.1
+  - @zappie/tokens@0.1.1
+  - eslint-plugin-zappie@0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zappie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,51 @@
-# Temporary Holding Version
+# @zappie/check
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The checks behind `zappie check`. They look over a Zappie storefront project before you ship it, and report each problem with how to fix it.
+
+```sh
+npm install --save-dev @zappie/check
+npx zappie check
+```
+
+## What it checks
+
+`zappie check` runs these steps in order and stops at the first that fails. Pass `--all` to run every step anyway.
+
+| Step        | What it looks at                                                                            |
+| ----------- | ------------------------------------------------------------------------------------------- |
+| `config`    | `zappie.config.ts` and `theme.json`, against the SDK and token rules                        |
+| `allowlist` | Every npm dependency is on Zappie's package allowlist or in `packages.allow` in your config |
+| `lint`      | The `eslint-plugin-zappie` rules                                                            |
+| `types`     | A TypeScript check of the project                                                           |
+| `test`      | Your project's tests                                                                        |
+| `build`     | A production build                                                                          |
+| `secrets`   | No secret keys or tokens in your source or build                                            |
+| `budgets`   | Built JavaScript and CSS sizes, against Zappie's default budgets or the ones in your config |
+
+Add `--json` for a machine-readable result. Its shape is the JSON Schema at `@zappie/check/schema/check-result.v1.json`.
+
+## From code
+
+```ts
+import { runCheck } from "@zappie/check";
+
+const result = await runCheck({
+  cwd: process.cwd(),
+  packageManager: "npm",
+  all: true,
+});
+console.log(result.result); // "passed" or "failed"
+```
+
+## Docs
+
+- [CLI: zappie check](https://docs.zappie.ai/cli/check)
+- [Lint rules](https://docs.zappie.ai/lint)
+
+## Status
+
+`@zappie/check` is at `0.x`. Its steps and result can change in a minor release while it settles. Each change is listed in `CHANGELOG.md`.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+type CheckResultValue = "passed" | "failed" | "skipped";
+type CheckProblem = {
+    rule?: string;
+    file?: string;
+    line?: number;
+    message: string;
+    fix: string | null;
+};
+type CheckStepName = "config" | "allowlist" | "lint" | "types" | "test" | "build" | "secrets" | "budgets";
+type CheckStep = {
+    name: CheckStepName;
+    result: CheckResultValue;
+    problems: CheckProblem[];
+};
+type CheckResult = {
+    result: Exclude<CheckResultValue, "skipped">;
+    steps: CheckStep[];
+};
+type PackageManager = "pnpm" | "npm" | "yarn" | "bun";
+type CheckOptions = {
+    cwd: string;
+    all?: boolean;
+    packageManager: PackageManager;
+    signal?: AbortSignal;
+};
+type StepOptions = Omit<CheckOptions, "all">;
+
+type AllowlistSource = {
+    load(signal?: AbortSignal): Promise<readonly string[]>;
+};
+declare const BUILTIN_ALLOWLIST_SOURCE: AllowlistSource;
+declare function checkAllowlist({ cwd, signal }: StepOptions, source?: AllowlistSource): Promise<CheckStep>;
+
+declare function checkBudgets({ cwd, signal, }: StepOptions): Promise<CheckStep>;
+
+declare function checkBuild({ cwd, packageManager, signal, }: StepOptions): Promise<CheckStep>;
+
+type LoadedConfig = {
+    value: unknown;
+    source: string;
+    file: string;
+};
+declare function supportsTypeScriptImport(version?: string): boolean;
+declare function loadConfig(cwd: string): Promise<LoadedConfig>;
+declare function checkConfig({ cwd, signal, }: StepOptions): Promise<CheckStep>;
+
+declare function checkLint({ cwd, signal, }: StepOptions): Promise<CheckStep>;
+
+declare function runCheck(options: CheckOptions): Promise<CheckResult>;
+
+declare const SECRET_FILE_SIZE_CAP: number;
+type SecretFinding = CheckProblem & {
+    severity: "error" | "warning";
+};
+declare function scanSecrets(dir: string): Promise<SecretFinding[]>;
+declare function checkSecrets({ cwd, signal, }: StepOptions): Promise<CheckStep>;
+
+declare function checkTests({ cwd, packageManager, signal, }: StepOptions): Promise<CheckStep>;
+
+declare function checkTypes(options: StepOptions): Promise<CheckStep>;
+
+export { type AllowlistSource, BUILTIN_ALLOWLIST_SOURCE, type CheckOptions, type CheckProblem, type CheckResult, type CheckResultValue, type CheckStep, type CheckStepName, type PackageManager, SECRET_FILE_SIZE_CAP, type SecretFinding, type StepOptions, checkAllowlist, checkBudgets, checkBuild, checkConfig, checkLint, checkSecrets, checkTests, checkTypes, loadConfig, runCheck, scanSecrets, supportsTypeScriptImport };