@ethlete/cli 3.0.0-next.22 → 3.0.0-next.24

package/src/lib/design/system/complete-command.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.designComplete = exports.COMPLETE_USAGE = void 0;
+const complete_1 = require("./complete");
+const resolve_product_1 = require("./resolve-product");
+const cli_args_1 = require("./sketch/cli-args");
+const sketch_1 = require("./sketch/sketch");
+exports.COMPLETE_USAGE = 'complete <layer>/<name> [--product <name>]';
+/** `et design complete <layer>/<name>` exits 1 while a control the part declares lacks a drawn, reviewed state or surface. */
+const designComplete = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { target, argv, invocation } = options;
+    const args = (0, cli_args_1.argsOf)(argv, ['--product']);
+    const usage = `usage: ${invocation} ${exports.COMPLETE_USAGE}`;
+    if (typeof args === 'string' || args.positional.length !== 1) {
+        if (typeof args === 'string')
+            console.error(args);
+        console.error(usage);
+        return 2;
+    }
+    const config = (0, cli_args_1.configOf)(target);
+    if (typeof config === 'string') {
+        console.error(config);
+        return 1;
+    }
+    const parsed = (0, sketch_1.parseTarget)(args.positional[0]);
+    if (typeof parsed === 'string') {
+        console.error(parsed);
+        return 1;
+    }
+    const product = (0, cli_args_1.oneProductOf)({ target, config, asked: args.values['--product'] });
+    if (typeof product === 'string') {
+        console.error(product);
+        return 1;
+    }
+    const part = (0, resolve_product_1.partKeyOf)(parsed);
+    const result = yield (0, complete_1.completenessOf)({ target, config, product, part, chromiumOf: options.chromiumOf });
+    if ('problem' in result) {
+        console.error(result.problem);
+        return 1;
+    }
+    if ('unavailable' in result) {
+        console.error(`design complete needs a browser: ${result.unavailable}`);
+        return 1;
+    }
+    for (const gap of result.gaps)
+        console.error((0, complete_1.completenessGapLineOf)(gap));
+    if (result.gaps.length > 0) {
+        console.error(`${part} in ${product.name} is not design complete: ${result.gaps.length} gap(s)`);
+        return 1;
+    }
+    console.log(`${part} in ${product.name} is design complete`);
+    return 0;
+});
+exports.designComplete = designComplete;
+//# sourceMappingURL=complete-command.js.map

package/src/lib/design/system/complete-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complete-command.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/design/system/complete-command.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,yCAAmE;AACnE,uDAA8C;AAC9C,gDAAmE;AACnE,4CAA8C;AAEjC,QAAA,cAAc,GAAG,4CAA4C,CAAC;AAE3E,8HAA8H;AACvH,MAAM,cAAc,GAAG,CAAO,OAKpC,EAAE,EAAE;IACH,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAA,iBAAM,EAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,UAAU,IAAI,sBAAc,EAAE,CAAC;IAEvD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,mBAAQ,EAAC,MAAM,CAAC,CAAC;IAEhC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,uBAAY,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAElF,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG,IAAA,2BAAS,EAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,MAAM,IAAA,yBAAc,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAEvG,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,aAAa,IAAI,MAAM,EAAE,CAAC;QAC5B,OAAO,CAAC,KAAK,CAAC,oCAAoC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAExE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI;QAAE,OAAO,CAAC,KAAK,CAAC,IAAA,gCAAqB,EAAC,GAAG,CAAC,CAAC,CAAC;IAEzE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,OAAO,OAAO,CAAC,IAAI,4BAA4B,MAAM,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC;QAEjG,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,OAAO,CAAC,IAAI,qBAAqB,CAAC,CAAC;IAE7D,OAAO,CAAC,CAAC;AACX,CAAC,CAAA,CAAC;AApEW,QAAA,cAAc,kBAoEzB"}

package/src/lib/design/system/complete.d.ts

@@ -0,0 +1,73 @@
+import { chromiumOf } from '../browser';
+import { DesignConfig } from '../paths';
+import { ResolvedProduct } from './resolve-product';
+/** One requirement of a part that `design complete` finds without evidence. `target` is `<part>[.<control>[.<requirement>]]`. */
+export type CompletenessGap = {
+    code: string;
+    target: string;
+    detail: string;
+};
+/**
+ * An element of a drawn frame that looks interactive. `control` is a native control, an interactive role or a known
+ * SDK control; `unclassified` has a pointer cursor or a matched `:hover` rule and sits in no control. `marked` is the
+ * `data-et-control` that declares it, `within` every `data-et-control` around it, nearest first.
+ */
+export type FoundControl = {
+    kind: 'control' | 'unclassified';
+    what: string;
+    path: string;
+    marked: string | null;
+    within: string[];
+};
+/** What one drawn frame of a state shows of the controls and surfaces its markup marks. */
+export type SeenFrame = {
+    state: string;
+    interaction: string | null;
+    controls: {
+        id: string;
+        forced: {
+            interaction: string;
+            differs: boolean;
+            still?: string[];
+        }[];
+    }[];
+    surfaces: {
+        id: string;
+        shown: boolean;
+    }[];
+    found?: FoundControl[];
+};
+/** The gaps of each part a control names in `part`, or why it could not be checked. */
+export type ReferencedParts = Record<string, CompletenessGap[] | string>;
+/**
+ * The gaps of one part, from its `controls` declaration, its state names and what each drawn frame showed.
+ * A part that is not `reviewed` (its files differ from its merged.json hash) has no reviewed evidence at all.
+ */
+export declare const completenessGapsOf: (options: {
+    part: string;
+    controls: unknown;
+    states: string[];
+    frames: SeenFrame[];
+    reviewed: boolean;
+    grid?: unknown;
+    referenced?: ReferencedParts;
+}) => CompletenessGap[];
+export declare const completenessGapLineOf: (gap: CompletenessGap) => string;
+/**
+ * Draws every state of one part, at rest and in each interaction it declares, once at its first preset or width,
+ * and answers the gaps of its `controls` declaration, or why it could not draw. A part a control names in `part`
+ * is checked the same way, and its gaps fail the control.
+ */
+export declare const completenessOf: (options: {
+    target: string;
+    config: DesignConfig;
+    product: ResolvedProduct;
+    part: string;
+    chromiumOf?: typeof chromiumOf;
+}) => Promise<{
+    gaps: CompletenessGap[];
+} | {
+    unavailable: string;
+} | {
+    problem: string;
+}>;