crankscript 0.11.13 → 0.12.0

package/src/components/CheckList/Item.d.ts

@@ -4,4 +4,4 @@ export interface ItemProps<TResult> {
     item: CheckListItem<TResult>;
     start: boolean;
 }
-export declare const Item: <TResult>({ item: { runningDescription, waitingDescription, errorDescription, finishedDescription, runner, onFinish, ready, }, start, }: ItemProps<TResult>) => React.JSX.Element;
+export declare const Item: <TResult>({ item: { runningDescription, waitingDescription, errorDescription, finishedDescription, skipDescription, runner, onFinish, ready, quitOnError, skip, }, start, }: ItemProps<TResult>) => React.JSX.Element;

package/src/components/CheckList/Item.js

@@ -2,22 +2,26 @@ import { StatusMessage } from '@inkjs/ui';
 import { Text } from 'ink';
 import React, { useEffect, useRef, useState } from 'react';
 import { Spinner } from '../../components/Spinner.js';
-export const Item = ({ item: { runningDescription, waitingDescription, errorDescription, finishedDescription, runner, onFinish, ready }, start })=>{
+export const Item = ({ item: { runningDescription, waitingDescription, errorDescription, finishedDescription, skipDescription, runner, onFinish, ready, quitOnError = true, skip }, start })=>{
     const executed = useRef(false);
     const interval = useRef(null);
     const [dotCount, setDotCount] = useState(0);
     const [result, setResult] = useState(null);
     const [failedReason, setfailedReason] = useState(null);
+    const [isSkipped, setIsSkipped] = useState(false);
+    // Determine if the task should be skipped
+    const shouldSkip = typeof skip === 'function' ? skip() : skip === true;
     const hasResult = !failedReason && result !== null;
-    const isRunning = !failedReason && !hasResult && start && ready !== false;
+    const isRunning = !failedReason && !hasResult && start && ready !== false && !shouldSkip;
     const isWaiting = !failedReason && !hasResult && (!start || !ready);
     const couldStartButNotReady = !failedReason && !hasResult && start && ready === false;
     useEffect(()=>{
-        if (failedReason) {
+        if (failedReason && quitOnError) {
             process.exit();
         }
     }, [
-        failedReason
+        failedReason,
+        quitOnError
     ]);
     useEffect(()=>{
         if (couldStartButNotReady) {
@@ -41,6 +45,14 @@ export const Item = ({ item: { runningDescription, waitingDescription, errorDesc
         if (!start || executed.current || ready === false) {
             return;
         }
+        // If the task should be skipped, mark it as executed with a success result
+        if (shouldSkip) {
+            executed.current = true;
+            setIsSkipped(true);
+            setResult(true);
+            onFinish == null ? void 0 : onFinish(true);
+            return;
+        }
         runner().then((result)=>{
             executed.current = true;
             if (result === false) {
@@ -51,18 +63,24 @@ export const Item = ({ item: { runningDescription, waitingDescription, errorDesc
             onFinish == null ? void 0 : onFinish(result);
         }).catch((reason)=>{
             setfailedReason(reason.message);
+            setResult(false);
+            onFinish == null ? void 0 : onFinish(false);
         });
     }, [
         errorDescription,
         onFinish,
         runner,
-        start
+        start,
+        shouldSkip
     ]);
     let message = waitingDescription;
     let variant = 'info';
     if (failedReason) {
         message = ` ${failedReason}`;
         variant = 'error';
+    } else if (isSkipped) {
+        message = skipDescription || 'Task skipped';
+        variant = 'info';
     } else if (isRunning) {
         message = runningDescription;
         variant = 'warning';
@@ -79,7 +97,7 @@ export const Item = ({ item: { runningDescription, waitingDescription, errorDesc
         variant: variant
     }, /*#__PURE__*/ React.createElement(Text, {
         bold: !isWaiting,
-        color: isRunning ? 'yellow' : isWaiting ? 'gray' : failedReason ? 'red' : 'green'
+        color: isRunning ? 'yellow' : isWaiting ? 'gray' : failedReason ? 'red' : isSkipped ? 'gray' : 'green'
     }, message, ' ', couldStartButNotReady && `— not ready yet${'.'.repeat(dotCount)}`));
 };
 

package/src/components/CheckList/Item.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../libs/cli/src/components/CheckList/Item.tsx"],"sourcesContent":["import { StatusMessage, StatusMessageProps } from '@inkjs/ui';\nimport { Text } from 'ink';\nimport React, { useEffect, useRef, useState } from 'react';\nimport { Spinner } from '@/cli/components/Spinner.js';\nimport { CheckListItem } from '@/cli/types.js';\n\nexport interface ItemProps<TResult> {\n    item: CheckListItem<TResult>;\n    start: boolean;\n}\n\nexport const Item = <TResult,>({\n    item: {\n        runningDescription,\n        waitingDescription,\n        errorDescription,\n        finishedDescription,\n        runner,\n        onFinish,\n        ready,\n    },\n    start,\n}: ItemProps<TResult>) => {\n    const executed = useRef(false);\n    const interval = useRef<NodeJS.Timeout | null>(null);\n    const [dotCount, setDotCount] = useState(0);\n    const [result, setResult] = useState<TResult | null>(null);\n    const [failedReason, setfailedReason] = useState<string | null>(null);\n    const hasResult = !failedReason && result !== null;\n    const isRunning = !failedReason && !hasResult && start && ready !== false;\n    const isWaiting = !failedReason && !hasResult && (!start || !ready);\n    const couldStartButNotReady =\n        !failedReason && !hasResult && start && ready === false;\n\n    useEffect(() => {\n        if (failedReason) {\n            process.exit();\n        }\n    }, [failedReason]);\n\n    useEffect(() => {\n        if (couldStartButNotReady) {\n            interval.current = setInterval(() => {\n                setDotCount(count => (count + 1) % 4);\n            }, 250);\n        } else {\n            if (interval.current) {\n                clearInterval(interval.current);\n            }\n        }\n\n        return () => {\n            if (interval.current) {\n                clearInterval(interval.current);\n            }\n        };\n    }, [couldStartButNotReady]);\n\n    useEffect(() => {\n        if (!start || executed.current || ready === false) {\n            return;\n        }\n\n        runner()\n            .then(result => {\n                executed.current = true;\n\n                if (result === false) {\n                    setfailedReason(errorDescription);\n\n                    return;\n                }\n\n                setResult(result);\n                onFinish?.(result);\n            })\n            .catch(reason => {\n                setfailedReason(reason.message);\n            });\n    }, [errorDescription, onFinish, runner, start]);\n\n    let message = waitingDescription;\n    let variant: StatusMessageProps['variant'] = 'info';\n\n    if (failedReason) {\n        message = ` ${failedReason}`;\n        variant = 'error';\n    } else if (isRunning) {\n        message = runningDescription;\n        variant = 'warning';\n    } else if (hasResult) {\n        message = finishedDescription(result);\n        variant = 'success';\n    }\n\n    if (isRunning) {\n        return <Spinner label={message} />;\n    }\n\n    return (\n        <StatusMessage variant={variant}>\n            <Text\n                bold={!isWaiting}\n                color={\n                    isRunning\n                        ? 'yellow'\n                        : isWaiting\n                        ? 'gray'\n                        : failedReason\n                        ? 'red'\n                        : 'green'\n                }\n            >\n                {message}{' '}\n                {couldStartButNotReady &&\n                    `— not ready yet${'.'.repeat(dotCount)}`}\n            </Text>\n        </StatusMessage>\n    );\n};\n"],"names":["StatusMessage","Text","React","useEffect","useRef","useState","Spinner","Item","item","runningDescription","waitingDescription","errorDescription","finishedDescription","runner","onFinish","ready","start","executed","interval","dotCount","setDotCount","result","setResult","failedReason","setfailedReason","hasResult","isRunning","isWaiting","couldStartButNotReady","process","exit","current","setInterval","count","clearInterval","then","catch","reason","message","variant","label","bold","color","repeat"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,aAAa,QAA4B,YAAY;AAC9D,SAASC,IAAI,QAAQ,MAAM;AAC3B,OAAOC,SAASC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAC3D,SAASC,OAAO,QAAQ,8BAA8B;AAQtD,OAAO,MAAMC,OAAO,CAAW,EAC3BC,MAAM,EACFC,kBAAkB,EAClBC,kBAAkB,EAClBC,gBAAgB,EAChBC,mBAAmB,EACnBC,MAAM,EACNC,QAAQ,EACRC,KAAK,EACR,EACDC,KAAK,EACY;IACjB,MAAMC,WAAWb,OAAO;IACxB,MAAMc,WAAWd,OAA8B;IAC/C,MAAM,CAACe,UAAUC,YAAY,GAAGf,SAAS;IACzC,MAAM,CAACgB,QAAQC,UAAU,GAAGjB,SAAyB;IACrD,MAAM,CAACkB,cAAcC,gBAAgB,GAAGnB,SAAwB;IAChE,MAAMoB,YAAY,CAACF,gBAAgBF,WAAW;IAC9C,MAAMK,YAAY,CAACH,gBAAgB,CAACE,aAAaT,SAASD,UAAU;IACpE,MAAMY,YAAY,CAACJ,gBAAgB,CAACE,aAAc,CAAA,CAACT,SAAS,CAACD,KAAI;IACjE,MAAMa,wBACF,CAACL,gBAAgB,CAACE,aAAaT,SAASD,UAAU;IAEtDZ,UAAU;QACN,IAAIoB,cAAc;YACdM,QAAQC,IAAI;QAChB;IACJ,GAAG;QAACP;KAAa;IAEjBpB,UAAU;QACN,IAAIyB,uBAAuB;YACvBV,SAASa,OAAO,GAAGC,YAAY;gBAC3BZ,YAAYa,CAAAA,QAAS,AAACA,CAAAA,QAAQ,CAAA,IAAK;YACvC,GAAG;QACP,OAAO;YACH,IAAIf,SAASa,OAAO,EAAE;gBAClBG,cAAchB,SAASa,OAAO;YAClC;QACJ;QAEA,OAAO;YACH,IAAIb,SAASa,OAAO,EAAE;gBAClBG,cAAchB,SAASa,OAAO;YAClC;QACJ;IACJ,GAAG;QAACH;KAAsB;IAE1BzB,UAAU;QACN,IAAI,CAACa,SAASC,SAASc,OAAO,IAAIhB,UAAU,OAAO;YAC/C;QACJ;QAEAF,SACKsB,IAAI,CAACd,CAAAA;YACFJ,SAASc,OAAO,GAAG;YAEnB,IAAIV,WAAW,OAAO;gBAClBG,gBAAgBb;gBAEhB;YACJ;YAEAW,UAAUD;YACVP,4BAAAA,SAAWO;QACf,GACCe,KAAK,CAACC,CAAAA;YACHb,gBAAgBa,OAAOC,OAAO;QAClC;IACR,GAAG;QAAC3B;QAAkBG;QAAUD;QAAQG;KAAM;IAE9C,IAAIsB,UAAU5B;IACd,IAAI6B,UAAyC;IAE7C,IAAIhB,cAAc;QACde,UAAU,CAAC,CAAC,EAAEf,aAAa,CAAC;QAC5BgB,UAAU;IACd,OAAO,IAAIb,WAAW;QAClBY,UAAU7B;QACV8B,UAAU;IACd,OAAO,IAAId,WAAW;QAClBa,UAAU1B,oBAAoBS;QAC9BkB,UAAU;IACd;IAEA,IAAIb,WAAW;QACX,qBAAO,oBAACpB;YAAQkC,OAAOF;;IAC3B;IAEA,qBACI,oBAACtC;QAAcuC,SAASA;qBACpB,oBAACtC;QACGwC,MAAM,CAACd;QACPe,OACIhB,YACM,WACAC,YACA,SACAJ,eACA,QACA;OAGTe,SAAS,KACTV,yBACG,CAAC,eAAe,EAAE,IAAIe,MAAM,CAACxB,UAAU,CAAC;AAI5D,EAAE"}
+{"version":3,"sources":["../../../../../../libs/cli/src/components/CheckList/Item.tsx"],"sourcesContent":["import { StatusMessage, StatusMessageProps } from '@inkjs/ui';\nimport { Text } from 'ink';\nimport React, { useEffect, useRef, useState } from 'react';\nimport { Spinner } from '@/cli/components/Spinner.js';\nimport { CheckListItem } from '@/cli/types.js';\n\nexport interface ItemProps<TResult> {\n    item: CheckListItem<TResult>;\n    start: boolean;\n}\n\nexport const Item = <TResult,>({\n    item: {\n        runningDescription,\n        waitingDescription,\n        errorDescription,\n        finishedDescription,\n        skipDescription,\n        runner,\n        onFinish,\n        ready,\n        quitOnError = true,\n        skip,\n    },\n    start,\n}: ItemProps<TResult>) => {\n    const executed = useRef(false);\n    const interval = useRef<NodeJS.Timeout | null>(null);\n    const [dotCount, setDotCount] = useState(0);\n    const [result, setResult] = useState<TResult | null | false>(null);\n    const [failedReason, setfailedReason] = useState<string | null>(null);\n    const [isSkipped, setIsSkipped] = useState(false);\n\n    // Determine if the task should be skipped\n    const shouldSkip = typeof skip === 'function' ? skip() : skip === true;\n\n    const hasResult = !failedReason && result !== null;\n    const isRunning =\n        !failedReason && !hasResult && start && ready !== false && !shouldSkip;\n    const isWaiting = !failedReason && !hasResult && (!start || !ready);\n    const couldStartButNotReady =\n        !failedReason && !hasResult && start && ready === false;\n\n    useEffect(() => {\n        if (failedReason && quitOnError) {\n            process.exit();\n        }\n    }, [failedReason, quitOnError]);\n\n    useEffect(() => {\n        if (couldStartButNotReady) {\n            interval.current = setInterval(() => {\n                setDotCount(count => (count + 1) % 4);\n            }, 250);\n        } else {\n            if (interval.current) {\n                clearInterval(interval.current);\n            }\n        }\n\n        return () => {\n            if (interval.current) {\n                clearInterval(interval.current);\n            }\n        };\n    }, [couldStartButNotReady]);\n\n    useEffect(() => {\n        if (!start || executed.current || ready === false) {\n            return;\n        }\n\n        // If the task should be skipped, mark it as executed with a success result\n        if (shouldSkip) {\n            executed.current = true;\n            setIsSkipped(true);\n            setResult(true as TResult);\n            onFinish?.(true as TResult);\n            return;\n        }\n\n        runner()\n            .then(result => {\n                executed.current = true;\n\n                if (result === false) {\n                    setfailedReason(errorDescription);\n\n                    return;\n                }\n\n                setResult(result);\n                onFinish?.(result);\n            })\n            .catch(reason => {\n                setfailedReason(reason.message);\n                setResult(false);\n                onFinish?.(false);\n            });\n    }, [errorDescription, onFinish, runner, start, shouldSkip]);\n\n    let message = waitingDescription;\n    let variant: StatusMessageProps['variant'] = 'info';\n\n    if (failedReason) {\n        message = ` ${failedReason}`;\n        variant = 'error';\n    } else if (isSkipped) {\n        message = skipDescription || 'Task skipped';\n        variant = 'info';\n    } else if (isRunning) {\n        message = runningDescription;\n        variant = 'warning';\n    } else if (hasResult) {\n        message = finishedDescription(result);\n        variant = 'success';\n    }\n\n    if (isRunning) {\n        return <Spinner label={message} />;\n    }\n\n    return (\n        <StatusMessage variant={variant}>\n            <Text\n                bold={!isWaiting}\n                color={\n                    isRunning\n                        ? 'yellow'\n                        : isWaiting\n                        ? 'gray'\n                        : failedReason\n                        ? 'red'\n                        : isSkipped\n                        ? 'gray'\n                        : 'green'\n                }\n            >\n                {message}{' '}\n                {couldStartButNotReady &&\n                    `— not ready yet${'.'.repeat(dotCount)}`}\n            </Text>\n        </StatusMessage>\n    );\n};\n"],"names":["StatusMessage","Text","React","useEffect","useRef","useState","Spinner","Item","item","runningDescription","waitingDescription","errorDescription","finishedDescription","skipDescription","runner","onFinish","ready","quitOnError","skip","start","executed","interval","dotCount","setDotCount","result","setResult","failedReason","setfailedReason","isSkipped","setIsSkipped","shouldSkip","hasResult","isRunning","isWaiting","couldStartButNotReady","process","exit","current","setInterval","count","clearInterval","then","catch","reason","message","variant","label","bold","color","repeat"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,aAAa,QAA4B,YAAY;AAC9D,SAASC,IAAI,QAAQ,MAAM;AAC3B,OAAOC,SAASC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAC3D,SAASC,OAAO,QAAQ,8BAA8B;AAQtD,OAAO,MAAMC,OAAO,CAAW,EAC3BC,MAAM,EACFC,kBAAkB,EAClBC,kBAAkB,EAClBC,gBAAgB,EAChBC,mBAAmB,EACnBC,eAAe,EACfC,MAAM,EACNC,QAAQ,EACRC,KAAK,EACLC,cAAc,IAAI,EAClBC,IAAI,EACP,EACDC,KAAK,EACY;IACjB,MAAMC,WAAWhB,OAAO;IACxB,MAAMiB,WAAWjB,OAA8B;IAC/C,MAAM,CAACkB,UAAUC,YAAY,GAAGlB,SAAS;IACzC,MAAM,CAACmB,QAAQC,UAAU,GAAGpB,SAAiC;IAC7D,MAAM,CAACqB,cAAcC,gBAAgB,GAAGtB,SAAwB;IAChE,MAAM,CAACuB,WAAWC,aAAa,GAAGxB,SAAS;IAE3C,0CAA0C;IAC1C,MAAMyB,aAAa,OAAOZ,SAAS,aAAaA,SAASA,SAAS;IAElE,MAAMa,YAAY,CAACL,gBAAgBF,WAAW;IAC9C,MAAMQ,YACF,CAACN,gBAAgB,CAACK,aAAaZ,SAASH,UAAU,SAAS,CAACc;IAChE,MAAMG,YAAY,CAACP,gBAAgB,CAACK,aAAc,CAAA,CAACZ,SAAS,CAACH,KAAI;IACjE,MAAMkB,wBACF,CAACR,gBAAgB,CAACK,aAAaZ,SAASH,UAAU;IAEtDb,UAAU;QACN,IAAIuB,gBAAgBT,aAAa;YAC7BkB,QAAQC,IAAI;QAChB;IACJ,GAAG;QAACV;QAAcT;KAAY;IAE9Bd,UAAU;QACN,IAAI+B,uBAAuB;YACvBb,SAASgB,OAAO,GAAGC,YAAY;gBAC3Bf,YAAYgB,CAAAA,QAAS,AAACA,CAAAA,QAAQ,CAAA,IAAK;YACvC,GAAG;QACP,OAAO;YACH,IAAIlB,SAASgB,OAAO,EAAE;gBAClBG,cAAcnB,SAASgB,OAAO;YAClC;QACJ;QAEA,OAAO;YACH,IAAIhB,SAASgB,OAAO,EAAE;gBAClBG,cAAcnB,SAASgB,OAAO;YAClC;QACJ;IACJ,GAAG;QAACH;KAAsB;IAE1B/B,UAAU;QACN,IAAI,CAACgB,SAASC,SAASiB,OAAO,IAAIrB,UAAU,OAAO;YAC/C;QACJ;QAEA,2EAA2E;QAC3E,IAAIc,YAAY;YACZV,SAASiB,OAAO,GAAG;YACnBR,aAAa;YACbJ,UAAU;YACVV,4BAAAA,SAAW;YACX;QACJ;QAEAD,SACK2B,IAAI,CAACjB,CAAAA;YACFJ,SAASiB,OAAO,GAAG;YAEnB,IAAIb,WAAW,OAAO;gBAClBG,gBAAgBhB;gBAEhB;YACJ;YAEAc,UAAUD;YACVT,4BAAAA,SAAWS;QACf,GACCkB,KAAK,CAACC,CAAAA;YACHhB,gBAAgBgB,OAAOC,OAAO;YAC9BnB,UAAU;YACVV,4BAAAA,SAAW;QACf;IACR,GAAG;QAACJ;QAAkBI;QAAUD;QAAQK;QAAOW;KAAW;IAE1D,IAAIc,UAAUlC;IACd,IAAImC,UAAyC;IAE7C,IAAInB,cAAc;QACdkB,UAAU,CAAC,CAAC,EAAElB,aAAa,CAAC;QAC5BmB,UAAU;IACd,OAAO,IAAIjB,WAAW;QAClBgB,UAAU/B,mBAAmB;QAC7BgC,UAAU;IACd,OAAO,IAAIb,WAAW;QAClBY,UAAUnC;QACVoC,UAAU;IACd,OAAO,IAAId,WAAW;QAClBa,UAAUhC,oBAAoBY;QAC9BqB,UAAU;IACd;IAEA,IAAIb,WAAW;QACX,qBAAO,oBAAC1B;YAAQwC,OAAOF;;IAC3B;IAEA,qBACI,oBAAC5C;QAAc6C,SAASA;qBACpB,oBAAC5C;QACG8C,MAAM,CAACd;QACPe,OACIhB,YACM,WACAC,YACA,SACAP,eACA,QACAE,YACA,SACA;OAGTgB,SAAS,KACTV,yBACG,CAAC,eAAe,EAAE,IAAIe,MAAM,CAAC3B,UAAU,CAAC;AAI5D,EAAE"}

package/src/types.d.ts

@@ -1,4 +1,4 @@
-import { ClassDeclarationStructure, FunctionDeclarationStructure, MethodDeclarationStructure, ParameterDeclarationStructure } from 'ts-morph';
+import { ClassDeclarationStructure, FunctionDeclarationStructure, MethodDeclarationStructure, ParameterDeclarationStructure, PropertyDeclarationStructure, VariableDeclarationStructure } from 'ts-morph';
 import { Environment } from './environment/dto/Environment.js';
 import { PlaydateSdkPath } from './environment/path/dto/PlaydateSdkPath.js';
 export declare enum PlaydateSdkVersionIdentifier {
@@ -31,10 +31,13 @@ export type CheckListItem<TResult> = {
     runningDescription: string;
     waitingDescription: string;
     errorDescription: string;
-    finishedDescription: (result: TResult) => string;
+    finishedDescription: (result: TResult | false) => string;
+    skipDescription?: string;
     runner: () => Promise<TResult> | Promise<false>;
-    onFinish?: (result: TResult) => void;
+    onFinish?: (result: TResult | false) => void;
     ready?: boolean;
+    quitOnError?: boolean;
+    skip?: boolean | (() => boolean);
 };
 export interface ParameterDescription {
     name: string;
@@ -63,27 +66,17 @@ export interface ApiObject {
 export interface ApiDefinitions {
     global: ApiObject;
 }
-export interface ParameterDetails {
-    name: string;
-    type: string;
-    overrideOptions?: Partial<Omit<ParameterDeclarationStructure, 'kind' | 'name' | 'type'>>;
-}
-export interface PropertyDetails {
+export interface PropertyDetails extends Partial<PropertyDeclarationStructure> {
     signature: string;
-    type: string;
-    isStatic?: boolean;
-    isReadOnly?: boolean;
 }
-export interface FunctionDetails {
+export type FunctionDetails = {
     signature: string;
     parameters: ParameterDetails[];
-    returnType: string;
     overrideParameters?: boolean;
-    overrideOptions?: Partial<FunctionDeclarationStructure | MethodDeclarationStructure>;
-}
-export interface ConstantDefinition {
+} & (Partial<FunctionDeclarationStructure> | Partial<MethodDeclarationStructure>);
+export type ParameterDetails = ParameterDeclarationStructure;
+export interface ConstantDefinition extends Partial<VariableDeclarationStructure> {
     name: string;
-    type: string;
 }
 export type TypeProviderData = {
     globalStatements: string[];
@@ -91,6 +84,15 @@ export type TypeProviderData = {
     constants: Record<string, (ConstantDefinition | string)[]>;
     classes: Record<string, Partial<ClassDeclarationStructure>>;
     properties: Record<string, PropertyDetails>;
+    /**
+     * Properties that are described in prose rather than in formal API documentation.
+     * While 'properties' contains actual property definitions with their full path as the key,
+     * 'dynamicProperties' contains additional properties that belong to a parent namespace.
+     *
+     * For example, if the docs mention "You can access rect.x, rect.y" in prose,
+     * the key would be "playdate.geometry.rect" and the value would be the properties
+     * that should be added to that namespace.
+     */
     dynamicProperties: Record<string, Pick<PropertyDescription, 'name' | 'docs'>[]>;
     functions: Record<string, FunctionDetails>;
 };

package/src/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../libs/cli/src/types.ts"],"sourcesContent":["import {\n    ClassDeclarationStructure,\n    FunctionDeclarationStructure,\n    MethodDeclarationStructure,\n    ParameterDeclarationStructure,\n} from 'ts-morph';\nimport { Environment } from '@/cli/environment/dto/Environment.js';\nimport { PlaydateSdkPath } from '@/cli/environment/path/dto/PlaydateSdkPath.js';\n\nexport enum PlaydateSdkVersionIdentifier {\n    Latest = 'latest',\n}\n\nexport type PlaydateSdkVersion = PlaydateSdkVersionIdentifier.Latest | string;\n\nexport type EnvironmentHealthResult =\n    | {\n          isHealthy: true;\n          environment: Environment;\n          health: EnvironmentHealth;\n      }\n    | {\n          isHealthy: false;\n          health: EnvironmentHealth;\n      };\n\nexport enum HealthCheckStatusType {\n    Healthy = 'Healthy',\n    Unhealthy = 'Unhealthy',\n    Unknown = 'Unknown',\n}\n\nexport type HealthCheckStatus<TArgument> =\n    | {\n          healthStatus:\n              | HealthCheckStatusType.Unknown\n              | HealthCheckStatusType.Unhealthy;\n      }\n    | {\n          healthStatus: HealthCheckStatusType.Healthy;\n          argument: TArgument;\n      };\n\nexport interface EnvironmentHealth {\n    sdkPathKnown: HealthCheckStatus<PlaydateSdkPath>;\n}\n\nexport type CheckListItem<TResult> = {\n    runningDescription: string;\n    waitingDescription: string;\n    errorDescription: string;\n    finishedDescription: (result: TResult) => string;\n    runner: () => Promise<TResult> | Promise<false>;\n    onFinish?: (result: TResult) => void;\n    ready?: boolean;\n};\n\nexport interface ParameterDescription {\n    name: string;\n    required: boolean;\n}\n\nexport interface PropertyDescription {\n    signature: string;\n    name: string;\n    namespaces: string[];\n    docs: string;\n}\n\nexport interface FunctionDescription {\n    signature: string;\n    name: string;\n    namespaces: string[];\n    parameters: ParameterDescription[];\n    hasSelf: boolean;\n    docs: string;\n}\n\nexport interface ApiObject {\n    functions: FunctionDescription[];\n    methods: FunctionDescription[];\n    properties: PropertyDescription[];\n    namespaces: Record<string, ApiObject>;\n}\n\nexport interface ApiDefinitions {\n    global: ApiObject;\n}\n\nexport interface ParameterDetails {\n    name: string;\n    type: string;\n    overrideOptions?: Partial<\n        Omit<ParameterDeclarationStructure, 'kind' | 'name' | 'type'>\n    >;\n}\n\nexport interface PropertyDetails {\n    signature: string;\n    type: string;\n    isStatic?: boolean;\n    isReadOnly?: boolean;\n}\n\nexport interface FunctionDetails {\n    signature: string;\n    parameters: ParameterDetails[];\n    returnType: string;\n    overrideParameters?: boolean;\n    overrideOptions?: Partial<\n        FunctionDeclarationStructure | MethodDeclarationStructure\n    >;\n}\n\nexport interface ConstantDefinition {\n    name: string;\n    type: string;\n}\n\nexport type TypeProviderData = {\n    globalStatements: string[];\n    statements: string[];\n    constants: Record<string, (ConstantDefinition | string)[]>;\n    classes: Record<string, Partial<ClassDeclarationStructure>>;\n    properties: Record<string, PropertyDetails>;\n    dynamicProperties: Record<\n        string,\n        Pick<PropertyDescription, 'name' | 'docs'>[]\n    >;\n    functions: Record<string, FunctionDetails>;\n};\n\nexport type FunctionTypeOverrideMap = Record<string, { isMethod: boolean }>;\n\nexport enum TemplateName {\n    Blank = 'blank',\n}\n"],"names":["PlaydateSdkVersionIdentifier","HealthCheckStatusType","TemplateName"],"rangeMappings":";;;;;;;;;;;;;","mappings":";UASYA;;GAAAA,iCAAAA;;UAiBAC;;;;GAAAA,0BAAAA;;UA4GAC;;GAAAA,iBAAAA"}
+{"version":3,"sources":["../../../../libs/cli/src/types.ts"],"sourcesContent":["import {\n    ClassDeclarationStructure,\n    FunctionDeclarationStructure,\n    MethodDeclarationStructure,\n    ParameterDeclarationStructure,\n    PropertyDeclarationStructure,\n    VariableDeclarationStructure,\n} from 'ts-morph';\nimport { Environment } from '@/cli/environment/dto/Environment.js';\nimport { PlaydateSdkPath } from '@/cli/environment/path/dto/PlaydateSdkPath.js';\n\nexport enum PlaydateSdkVersionIdentifier {\n    Latest = 'latest',\n}\n\nexport type PlaydateSdkVersion = PlaydateSdkVersionIdentifier.Latest | string;\n\nexport type EnvironmentHealthResult =\n    | {\n          isHealthy: true;\n          environment: Environment;\n          health: EnvironmentHealth;\n      }\n    | {\n          isHealthy: false;\n          health: EnvironmentHealth;\n      };\n\nexport enum HealthCheckStatusType {\n    Healthy = 'Healthy',\n    Unhealthy = 'Unhealthy',\n    Unknown = 'Unknown',\n}\n\nexport type HealthCheckStatus<TArgument> =\n    | {\n          healthStatus:\n              | HealthCheckStatusType.Unknown\n              | HealthCheckStatusType.Unhealthy;\n      }\n    | {\n          healthStatus: HealthCheckStatusType.Healthy;\n          argument: TArgument;\n      };\n\nexport interface EnvironmentHealth {\n    sdkPathKnown: HealthCheckStatus<PlaydateSdkPath>;\n}\n\nexport type CheckListItem<TResult> = {\n    runningDescription: string;\n    waitingDescription: string;\n    errorDescription: string;\n    finishedDescription: (result: TResult | false) => string;\n    skipDescription?: string;\n    runner: () => Promise<TResult> | Promise<false>;\n    onFinish?: (result: TResult | false) => void;\n    ready?: boolean;\n    quitOnError?: boolean;\n    skip?: boolean | (() => boolean);\n};\n\nexport interface ParameterDescription {\n    name: string;\n    required: boolean;\n}\n\nexport interface PropertyDescription {\n    signature: string;\n    name: string;\n    namespaces: string[];\n    docs: string;\n}\n\nexport interface FunctionDescription {\n    signature: string;\n    name: string;\n    namespaces: string[];\n    parameters: ParameterDescription[];\n    hasSelf: boolean;\n    docs: string;\n}\n\nexport interface ApiObject {\n    functions: FunctionDescription[];\n    methods: FunctionDescription[];\n    properties: PropertyDescription[];\n    namespaces: Record<string, ApiObject>;\n}\n\nexport interface ApiDefinitions {\n    global: ApiObject;\n}\n\nexport interface PropertyDetails extends Partial<PropertyDeclarationStructure> {\n    signature: string;\n}\n\nexport type FunctionDetails = {\n    signature: string;\n    parameters: ParameterDetails[];\n    overrideParameters?: boolean;\n} & (\n    | Partial<FunctionDeclarationStructure>\n    | Partial<MethodDeclarationStructure>\n);\n\nexport type ParameterDetails = ParameterDeclarationStructure;\n\nexport interface ConstantDefinition\n    extends Partial<VariableDeclarationStructure> {\n    name: string;\n}\n\nexport type TypeProviderData = {\n    globalStatements: string[];\n    statements: string[];\n    constants: Record<string, (ConstantDefinition | string)[]>;\n    classes: Record<string, Partial<ClassDeclarationStructure>>;\n    properties: Record<string, PropertyDetails>;\n    /**\n     * Properties that are described in prose rather than in formal API documentation.\n     * While 'properties' contains actual property definitions with their full path as the key,\n     * 'dynamicProperties' contains additional properties that belong to a parent namespace.\n     *\n     * For example, if the docs mention \"You can access rect.x, rect.y\" in prose,\n     * the key would be \"playdate.geometry.rect\" and the value would be the properties\n     * that should be added to that namespace.\n     */\n    dynamicProperties: Record<\n        string,\n        Pick<PropertyDescription, 'name' | 'docs'>[]\n    >;\n    functions: Record<string, FunctionDetails>;\n};\n\nexport type FunctionTypeOverrideMap = Record<string, { isMethod: boolean }>;\n\nexport enum TemplateName {\n    Blank = 'blank',\n}\n"],"names":["PlaydateSdkVersionIdentifier","HealthCheckStatusType","TemplateName"],"rangeMappings":";;;;;;;;;;;;;","mappings":";UAWYA;;GAAAA,iCAAAA;;UAiBAC;;;;GAAAA,0BAAAA;;UA8GAC;;GAAAA,iBAAAA"}