crankscript 0.11.14 → 0.13.0

package/src/commands/TranspileCommand/hooks/useTranspileTasks.js

@@ -1,7 +1,7 @@
 import { useMemo } from 'react';
 import { getErrorMessage } from '../../../commands/TranspileCommand/fn/getErrorMessage.js';
 import { transpile } from '../../../commands/TranspileCommand/fn/transpile.js';
-export const useTranspileTasks = (path)=>{
+export const useTranspileTasks = ({ entryPoint, exitPoint })=>{
     return useMemo(()=>[
             {
                 waitingDescription: 'Waiting to transpile code...',
@@ -9,7 +9,10 @@ export const useTranspileTasks = (path)=>{
                 runningDescription: 'Transpiling code...',
                 finishedDescription: ()=>'Code transpiled',
                 runner: async ()=>{
-                    const result = transpile(path);
+                    const result = transpile({
+                        entryPoint,
+                        exitPoint
+                    });
                     if (result.diagnostics.length > 0) {
                         const errors = getErrorMessage(result.diagnostics);
                         throw new Error(`${result.diagnostics.length === 1 ? 'An error' : 'Errors'} occurred while transpiling the code:\n${errors}`);

package/src/commands/TranspileCommand/hooks/useTranspileTasks.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/cli/src/commands/TranspileCommand/hooks/useTranspileTasks.ts"],"sourcesContent":["import { useMemo } from 'react';\nimport { getErrorMessage } from '@/cli/commands/TranspileCommand/fn/getErrorMessage.js';\nimport { transpile } from '@/cli/commands/TranspileCommand/fn/transpile.js';\nimport { CheckListItem } from '@/cli/types.js';\n\nexport const useTranspileTasks = (path: string) => {\n    return useMemo(\n        () => [\n            {\n                waitingDescription: 'Waiting to transpile code...',\n                errorDescription: 'Could not transpile code',\n                runningDescription: 'Transpiling code...',\n                finishedDescription: () => 'Code transpiled',\n                runner: async () => {\n                    const result = transpile(path);\n\n                    if (result.diagnostics.length > 0) {\n                        const errors = getErrorMessage(result.diagnostics);\n\n                        throw new Error(\n                            `${\n                                result.diagnostics.length === 1\n                                    ? 'An error'\n                                    : 'Errors'\n                            } occurred while transpiling the code:\\n${errors}`,\n                        );\n                    }\n                },\n                ready: true,\n                quitOnError: false,\n            },\n        ],\n        [],\n    ) as CheckListItem<unknown>[];\n};\n"],"names":["useMemo","getErrorMessage","transpile","useTranspileTasks","path","waitingDescription","errorDescription","runningDescription","finishedDescription","runner","result","diagnostics","length","errors","Error","ready","quitOnError"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,OAAO,QAAQ,QAAQ;AAChC,SAASC,eAAe,QAAQ,wDAAwD;AACxF,SAASC,SAAS,QAAQ,kDAAkD;AAG5E,OAAO,MAAMC,oBAAoB,CAACC;IAC9B,OAAOJ,QACH,IAAM;YACF;gBACIK,oBAAoB;gBACpBC,kBAAkB;gBAClBC,oBAAoB;gBACpBC,qBAAqB,IAAM;gBAC3BC,QAAQ;oBACJ,MAAMC,SAASR,UAAUE;oBAEzB,IAAIM,OAAOC,WAAW,CAACC,MAAM,GAAG,GAAG;wBAC/B,MAAMC,SAASZ,gBAAgBS,OAAOC,WAAW;wBAEjD,MAAM,IAAIG,MACN,CAAC,EACGJ,OAAOC,WAAW,CAACC,MAAM,KAAK,IACxB,aACA,SACT,uCAAuC,EAAEC,OAAO,CAAC;oBAE1D;gBACJ;gBACAE,OAAO;gBACPC,aAAa;YACjB;SACH,EACD,EAAE;AAEV,EAAE"}
+{"version":3,"sources":["../../../../../../../libs/cli/src/commands/TranspileCommand/hooks/useTranspileTasks.ts"],"sourcesContent":["import { useMemo } from 'react';\nimport { getErrorMessage } from '@/cli/commands/TranspileCommand/fn/getErrorMessage.js';\nimport { transpile } from '@/cli/commands/TranspileCommand/fn/transpile.js';\nimport { ValidatedEntryPoint } from '@/cli/commands/TranspileCommand/model/ValidatedEntryPoint.js';\nimport { ValidatedExitPoint } from '@/cli/commands/TranspileCommand/model/ValidatedExitPoint.js';\nimport { CheckListItem } from '@/cli/types.js';\n\nexport const useTranspileTasks = ({\n    entryPoint,\n    exitPoint,\n}: {\n    entryPoint: ValidatedEntryPoint;\n    exitPoint: ValidatedExitPoint;\n}) => {\n    return useMemo(\n        () => [\n            {\n                waitingDescription: 'Waiting to transpile code...',\n                errorDescription: 'Could not transpile code',\n                runningDescription: 'Transpiling code...',\n                finishedDescription: () => 'Code transpiled',\n                runner: async () => {\n                    const result = transpile({\n                        entryPoint,\n                        exitPoint,\n                    });\n\n                    if (result.diagnostics.length > 0) {\n                        const errors = getErrorMessage(result.diagnostics);\n\n                        throw new Error(\n                            `${\n                                result.diagnostics.length === 1\n                                    ? 'An error'\n                                    : 'Errors'\n                            } occurred while transpiling the code:\\n${errors}`,\n                        );\n                    }\n                },\n                ready: true,\n                quitOnError: false,\n            },\n        ],\n        [],\n    ) as CheckListItem<unknown>[];\n};\n"],"names":["useMemo","getErrorMessage","transpile","useTranspileTasks","entryPoint","exitPoint","waitingDescription","errorDescription","runningDescription","finishedDescription","runner","result","diagnostics","length","errors","Error","ready","quitOnError"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,OAAO,QAAQ,QAAQ;AAChC,SAASC,eAAe,QAAQ,wDAAwD;AACxF,SAASC,SAAS,QAAQ,kDAAkD;AAK5E,OAAO,MAAMC,oBAAoB,CAAC,EAC9BC,UAAU,EACVC,SAAS,EAIZ;IACG,OAAOL,QACH,IAAM;YACF;gBACIM,oBAAoB;gBACpBC,kBAAkB;gBAClBC,oBAAoB;gBACpBC,qBAAqB,IAAM;gBAC3BC,QAAQ;oBACJ,MAAMC,SAAST,UAAU;wBACrBE;wBACAC;oBACJ;oBAEA,IAAIM,OAAOC,WAAW,CAACC,MAAM,GAAG,GAAG;wBAC/B,MAAMC,SAASb,gBAAgBU,OAAOC,WAAW;wBAEjD,MAAM,IAAIG,MACN,CAAC,EACGJ,OAAOC,WAAW,CAACC,MAAM,KAAK,IACxB,aACA,SACT,uCAAuC,EAAEC,OAAO,CAAC;oBAE1D;gBACJ;gBACAE,OAAO;gBACPC,aAAa;YACjB;SACH,EACD,EAAE;AAEV,EAAE"}

package/src/commands/TranspileCommand/model/ValidatedEntryPoint.d.ts

@@ -0,0 +1,11 @@
+export type ValidatedEntryPoint = {
+    __validated: true;
+    /**
+     * The path to a directory containing a tsconfig.json file
+     */
+    projectPath: string;
+    /**
+     * The entry point to transpile. Must be within the path.
+     */
+    entryFile: string;
+};

package/src/commands/TranspileCommand/model/ValidatedEntryPoint.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=ValidatedEntryPoint.js.map

package/src/commands/TranspileCommand/model/ValidatedEntryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/cli/src/commands/TranspileCommand/model/ValidatedEntryPoint.ts"],"sourcesContent":["export type ValidatedEntryPoint = {\n    __validated: true;\n\n    /**\n     * The path to a directory containing a tsconfig.json file\n     */\n    projectPath: string;\n    /**\n     * The entry point to transpile. Must be within the path.\n     */\n    entryFile: string;\n};\n"],"names":[],"rangeMappings":"","mappings":"AAAA,WAWE"}

package/src/commands/TranspileCommand/model/ValidatedExitPoint.d.ts

@@ -0,0 +1,11 @@
+export type ValidatedExitPoint = {
+    __validated: true;
+    /**
+     * The path to a directory containing a tsconfig.json file
+     */
+    projectPath: string;
+    /**
+     * The path to the output directory. Must be within the project path.
+     */
+    exitPath: string;
+};

package/src/commands/TranspileCommand/model/ValidatedExitPoint.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=ValidatedExitPoint.js.map

package/src/commands/TranspileCommand/model/ValidatedExitPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/cli/src/commands/TranspileCommand/model/ValidatedExitPoint.ts"],"sourcesContent":["export type ValidatedExitPoint = {\n    __validated: true;\n\n    /**\n     * The path to a directory containing a tsconfig.json file\n     */\n    projectPath: string;\n    /**\n     * The path to the output directory. Must be within the project path.\n     */\n    exitPath: string;\n};\n"],"names":[],"rangeMappings":"","mappings":"AAAA,WAWE"}

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import { CheckListItem } from '../../types.js';
-export interface CheckListProps {
-    items: CheckListItem<unknown>[];
+export interface CheckListProps<TResult = unknown> {
+    items: CheckListItem<TResult>[];
     onFinish?: (hasFailure: boolean) => void;
 }
-export declare const CheckList: ({ items, onFinish }: CheckListProps) => React.JSX.Element;
+export declare const CheckList: <TResult>({ items, onFinish, }: CheckListProps<TResult>) => React.JSX.Element;

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../libs/cli/src/components/CheckList/CheckList.tsx"],"sourcesContent":["import React, { useEffect, useState } from 'react';\nimport { CheckListItem } from '@/cli/types.js';\nimport { Item } from './Item.js';\n\nexport interface CheckListProps {\n    items: CheckListItem<unknown>[];\n    onFinish?: (hasFailure: boolean) => void;\n}\n\nexport const CheckList = ({ items, onFinish }: CheckListProps) => {\n    const [currentIndex, setCurrentIndex] = useState<number | null>(null);\n    const [hasFailure, setHasFailure] = useState(false);\n\n    useEffect(() => {\n        if (currentIndex === null && items.length > 0) {\n            setCurrentIndex(0);\n        }\n    }, [currentIndex, items]);\n\n    const handleFinish = (index: number) => {\n        if (index + 1 < items.length) {\n            setCurrentIndex(index + 1);\n        } else {\n            onFinish?.(hasFailure);\n            setHasFailure(false);\n        }\n    };\n\n    return (\n        <>\n            {items.map((item, index) => (\n                <Item\n                    key={item.waitingDescription}\n                    item={{\n                        ...item,\n                        onFinish: (result: unknown) => {\n                            if (result === false) {\n                                setHasFailure(true);\n                            }\n\n                            item?.onFinish?.(result);\n                            handleFinish(index);\n                        },\n                    }}\n                    start={index === currentIndex}\n                />\n            ))}\n        </>\n    );\n};\n"],"names":["React","useEffect","useState","Item","CheckList","items","onFinish","currentIndex","setCurrentIndex","hasFailure","setHasFailure","length","handleFinish","index","map","item","key","waitingDescription","result","start"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";AAAA,OAAOA,SAASC,SAAS,EAAEC,QAAQ,QAAQ,QAAQ;AAEnD,SAASC,IAAI,QAAQ,YAAY;AAOjC,OAAO,MAAMC,YAAY,CAAC,EAAEC,KAAK,EAAEC,QAAQ,EAAkB;IACzD,MAAM,CAACC,cAAcC,gBAAgB,GAAGN,SAAwB;IAChE,MAAM,CAACO,YAAYC,cAAc,GAAGR,SAAS;IAE7CD,UAAU;QACN,IAAIM,iBAAiB,QAAQF,MAAMM,MAAM,GAAG,GAAG;YAC3CH,gBAAgB;QACpB;IACJ,GAAG;QAACD;QAAcF;KAAM;IAExB,MAAMO,eAAe,CAACC;QAClB,IAAIA,QAAQ,IAAIR,MAAMM,MAAM,EAAE;YAC1BH,gBAAgBK,QAAQ;QAC5B,OAAO;YACHP,4BAAAA,SAAWG;YACXC,cAAc;QAClB;IACJ;IAEA,qBACI,0CACKL,MAAMS,GAAG,CAAC,CAACC,MAAMF,sBACd,oBAACV;YACGa,KAAKD,KAAKE,kBAAkB;YAC5BF,MAAM,aACCA;gBACHT,UAAU,CAACY;wBAKPH;oBAJA,IAAIG,WAAW,OAAO;wBAClBR,cAAc;oBAClB;oBAEAK,yBAAAA,iBAAAA,KAAMT,QAAQ,qBAAdS,oBAAAA,MAAiBG;oBACjBN,aAAaC;gBACjB;;YAEJM,OAAON,UAAUN;;AAKrC,EAAE"}
+{"version":3,"sources":["../../../../../../libs/cli/src/components/CheckList/CheckList.tsx"],"sourcesContent":["import React, { useEffect, useState } from 'react';\nimport { CheckListItem } from '@/cli/types.js';\nimport { Item } from './Item.js';\n\nexport interface CheckListProps<TResult = unknown> {\n    items: CheckListItem<TResult>[];\n    onFinish?: (hasFailure: boolean) => void;\n}\n\nexport const CheckList = <TResult,>({\n    items,\n    onFinish,\n}: CheckListProps<TResult>) => {\n    const [currentIndex, setCurrentIndex] = useState<number | null>(null);\n    const [hasFailure, setHasFailure] = useState(false);\n\n    useEffect(() => {\n        if (currentIndex === null && items.length > 0) {\n            setCurrentIndex(0);\n        }\n    }, [currentIndex, items]);\n\n    const handleFinish = (index: number) => {\n        if (index + 1 < items.length) {\n            setCurrentIndex(index + 1);\n        } else {\n            onFinish?.(hasFailure);\n            setHasFailure(false);\n        }\n    };\n\n    return (\n        <>\n            {items.map((item, index) => (\n                <Item\n                    key={item.waitingDescription}\n                    item={{\n                        ...item,\n                        onFinish: (result: TResult | false) => {\n                            if (result === false) {\n                                setHasFailure(true);\n                            }\n\n                            item?.onFinish?.(result);\n                            handleFinish(index);\n                        },\n                    }}\n                    start={index === currentIndex}\n                />\n            ))}\n        </>\n    );\n};\n"],"names":["React","useEffect","useState","Item","CheckList","items","onFinish","currentIndex","setCurrentIndex","hasFailure","setHasFailure","length","handleFinish","index","map","item","key","waitingDescription","result","start"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";AAAA,OAAOA,SAASC,SAAS,EAAEC,QAAQ,QAAQ,QAAQ;AAEnD,SAASC,IAAI,QAAQ,YAAY;AAOjC,OAAO,MAAMC,YAAY,CAAW,EAChCC,KAAK,EACLC,QAAQ,EACc;IACtB,MAAM,CAACC,cAAcC,gBAAgB,GAAGN,SAAwB;IAChE,MAAM,CAACO,YAAYC,cAAc,GAAGR,SAAS;IAE7CD,UAAU;QACN,IAAIM,iBAAiB,QAAQF,MAAMM,MAAM,GAAG,GAAG;YAC3CH,gBAAgB;QACpB;IACJ,GAAG;QAACD;QAAcF;KAAM;IAExB,MAAMO,eAAe,CAACC;QAClB,IAAIA,QAAQ,IAAIR,MAAMM,MAAM,EAAE;YAC1BH,gBAAgBK,QAAQ;QAC5B,OAAO;YACHP,4BAAAA,SAAWG;YACXC,cAAc;QAClB;IACJ;IAEA,qBACI,0CACKL,MAAMS,GAAG,CAAC,CAACC,MAAMF,sBACd,oBAACV;YACGa,KAAKD,KAAKE,kBAAkB;YAC5BF,MAAM,aACCA;gBACHT,UAAU,CAACY;wBAKPH;oBAJA,IAAIG,WAAW,OAAO;wBAClBR,cAAc;oBAClB;oBAEAK,yBAAAA,iBAAAA,KAAMT,QAAQ,qBAAdS,oBAAAA,MAAiBG;oBACjBN,aAAaC;gBACjB;;YAEJM,OAAON,UAAUN;;AAKrC,EAAE"}

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, quitOnError, }, 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,19 +2,22 @@ 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, quitOnError = true }, 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 && quitOnError) {
-            process.exit();
+            process.exit(1);
         }
     }, [
         failedReason,
@@ -42,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) {
@@ -59,13 +70,17 @@ export const Item = ({ item: { runningDescription, waitingDescription, errorDesc
         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';
@@ -82,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        quitOnError = true,\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 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 && 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        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]);\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","quitOnError","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,EACLC,cAAc,IAAI,EACrB,EACDC,KAAK,EACY;IACjB,MAAMC,WAAWd,OAAO;IACxB,MAAMe,WAAWf,OAA8B;IAC/C,MAAM,CAACgB,UAAUC,YAAY,GAAGhB,SAAS;IACzC,MAAM,CAACiB,QAAQC,UAAU,GAAGlB,SAAiC;IAC7D,MAAM,CAACmB,cAAcC,gBAAgB,GAAGpB,SAAwB;IAChE,MAAMqB,YAAY,CAACF,gBAAgBF,WAAW;IAC9C,MAAMK,YAAY,CAACH,gBAAgB,CAACE,aAAaT,SAASF,UAAU;IACpE,MAAMa,YAAY,CAACJ,gBAAgB,CAACE,aAAc,CAAA,CAACT,SAAS,CAACF,KAAI;IACjE,MAAMc,wBACF,CAACL,gBAAgB,CAACE,aAAaT,SAASF,UAAU;IAEtDZ,UAAU;QACN,IAAIqB,gBAAgBR,aAAa;YAC7Bc,QAAQC,IAAI;QAChB;IACJ,GAAG;QAACP;QAAcR;KAAY;IAE9Bb,UAAU;QACN,IAAI0B,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;IAE1B1B,UAAU;QACN,IAAI,CAACc,SAASC,SAASc,OAAO,IAAIjB,UAAU,OAAO;YAC/C;QACJ;QAEAF,SACKuB,IAAI,CAACd,CAAAA;YACFJ,SAASc,OAAO,GAAG;YAEnB,IAAIV,WAAW,OAAO;gBAClBG,gBAAgBd;gBAEhB;YACJ;YAEAY,UAAUD;YACVR,4BAAAA,SAAWQ;QACf,GACCe,KAAK,CAACC,CAAAA;YACHb,gBAAgBa,OAAOC,OAAO;YAC9BhB,UAAU;YACVT,4BAAAA,SAAW;QACf;IACR,GAAG;QAACH;QAAkBG;QAAUD;QAAQI;KAAM;IAE9C,IAAIsB,UAAU7B;IACd,IAAI8B,UAAyC;IAE7C,IAAIhB,cAAc;QACde,UAAU,CAAC,CAAC,EAAEf,aAAa,CAAC;QAC5BgB,UAAU;IACd,OAAO,IAAIb,WAAW;QAClBY,UAAU9B;QACV+B,UAAU;IACd,OAAO,IAAId,WAAW;QAClBa,UAAU3B,oBAAoBU;QAC9BkB,UAAU;IACd;IAEA,IAAIb,WAAW;QACX,qBAAO,oBAACrB;YAAQmC,OAAOF;;IAC3B;IAEA,qBACI,oBAACvC;QAAcwC,SAASA;qBACpB,oBAACvC;QACGyC,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(1);\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,CAAC;QACjB;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/index.js

@@ -6,6 +6,7 @@ import { CompileCommand } from './commands/CompileCommand/index.js';
 import { DoctorCommand } from './commands/DoctorCommand.js';
 import { GenerateTypesCommand } from './commands/GenerateTypes/index.js';
 import { NewCommand } from './commands/NewCommand/NewCommand.js';
+import { NewLibCommand } from './commands/NewLibCommand/index.js';
 import { SimulatorCommand } from './commands/SimulatorCommand/index.js';
 import { TranspileCommand } from './commands/TranspileCommand/index.js';
 import { RootFolder } from './constants.js';
@@ -24,6 +25,7 @@ cli.register(Builtins.HelpCommand);
 cli.register(Builtins.VersionCommand);
 cli.register(DoctorCommand);
 cli.register(NewCommand);
+cli.register(NewLibCommand);
 cli.register(TranspileCommand);
 cli.register(CompileCommand);
 cli.register(GenerateTypesCommand);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../libs/cli/src/index.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { readFileSync } from 'fs';\nimport { join } from 'node:path';\nimport { Builtins, Cli } from 'clipanion';\nimport { CompileCommand } from '@/cli/commands/CompileCommand/index.js';\nimport { DoctorCommand } from '@/cli/commands/DoctorCommand.js';\nimport { GenerateTypesCommand } from '@/cli/commands/GenerateTypes/index.js';\nimport { NewCommand } from '@/cli/commands/NewCommand/NewCommand.js';\nimport { SimulatorCommand } from '@/cli/commands/SimulatorCommand/index.js';\nimport { TranspileCommand } from '@/cli/commands/TranspileCommand/index.js';\nimport { RootFolder } from '@/cli/constants.js';\n\nconst packageJsonContents = readFileSync(\n    join(RootFolder, 'package.json'),\n    'utf-8',\n);\nconst packageJson = JSON.parse(packageJsonContents);\n\nconst args = process.argv.slice(2);\n\nconst cli = new Cli({\n    binaryLabel: 'crankscript',\n    binaryName: 'crankscript',\n    binaryVersion: packageJson.version,\n});\n\nprocess.on('SIGINT', function () {\n    process.exit();\n});\n\ncli.register(Builtins.HelpCommand);\ncli.register(Builtins.VersionCommand);\ncli.register(DoctorCommand);\ncli.register(NewCommand);\ncli.register(TranspileCommand);\ncli.register(CompileCommand);\ncli.register(GenerateTypesCommand);\ncli.register(SimulatorCommand);\ncli.runExit(args);\n"],"names":["readFileSync","join","Builtins","Cli","CompileCommand","DoctorCommand","GenerateTypesCommand","NewCommand","SimulatorCommand","TranspileCommand","RootFolder","packageJsonContents","packageJson","JSON","parse","args","process","argv","slice","cli","binaryLabel","binaryName","binaryVersion","version","on","exit","register","HelpCommand","VersionCommand","runExit"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";AAEA,SAASA,YAAY,QAAQ,KAAK;AAClC,SAASC,IAAI,QAAQ,YAAY;AACjC,SAASC,QAAQ,EAAEC,GAAG,QAAQ,YAAY;AAC1C,SAASC,cAAc,QAAQ,yCAAyC;AACxE,SAASC,aAAa,QAAQ,kCAAkC;AAChE,SAASC,oBAAoB,QAAQ,wCAAwC;AAC7E,SAASC,UAAU,QAAQ,0CAA0C;AACrE,SAASC,gBAAgB,QAAQ,2CAA2C;AAC5E,SAASC,gBAAgB,QAAQ,2CAA2C;AAC5E,SAASC,UAAU,QAAQ,qBAAqB;AAEhD,MAAMC,sBAAsBX,aACxBC,KAAKS,YAAY,iBACjB;AAEJ,MAAME,cAAcC,KAAKC,KAAK,CAACH;AAE/B,MAAMI,OAAOC,QAAQC,IAAI,CAACC,KAAK,CAAC;AAEhC,MAAMC,MAAM,IAAIhB,IAAI;IAChBiB,aAAa;IACbC,YAAY;IACZC,eAAeV,YAAYW,OAAO;AACtC;AAEAP,QAAQQ,EAAE,CAAC,UAAU;IACjBR,QAAQS,IAAI;AAChB;AAEAN,IAAIO,QAAQ,CAACxB,SAASyB,WAAW;AACjCR,IAAIO,QAAQ,CAACxB,SAAS0B,cAAc;AACpCT,IAAIO,QAAQ,CAACrB;AACbc,IAAIO,QAAQ,CAACnB;AACbY,IAAIO,QAAQ,CAACjB;AACbU,IAAIO,QAAQ,CAACtB;AACbe,IAAIO,QAAQ,CAACpB;AACba,IAAIO,QAAQ,CAAClB;AACbW,IAAIU,OAAO,CAACd"}
+{"version":3,"sources":["../../../../libs/cli/src/index.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { readFileSync } from 'fs';\nimport { join } from 'node:path';\nimport { Builtins, Cli } from 'clipanion';\nimport { CompileCommand } from '@/cli/commands/CompileCommand/index.js';\nimport { DoctorCommand } from '@/cli/commands/DoctorCommand.js';\nimport { GenerateTypesCommand } from '@/cli/commands/GenerateTypes/index.js';\nimport { NewCommand } from '@/cli/commands/NewCommand/NewCommand.js';\nimport { NewLibCommand } from '@/cli/commands/NewLibCommand/index.js';\nimport { SimulatorCommand } from '@/cli/commands/SimulatorCommand/index.js';\nimport { TranspileCommand } from '@/cli/commands/TranspileCommand/index.js';\nimport { RootFolder } from '@/cli/constants.js';\n\nconst packageJsonContents = readFileSync(\n    join(RootFolder, 'package.json'),\n    'utf-8',\n);\nconst packageJson = JSON.parse(packageJsonContents);\n\nconst args = process.argv.slice(2);\n\nconst cli = new Cli({\n    binaryLabel: 'crankscript',\n    binaryName: 'crankscript',\n    binaryVersion: packageJson.version,\n});\n\nprocess.on('SIGINT', function () {\n    process.exit();\n});\n\ncli.register(Builtins.HelpCommand);\ncli.register(Builtins.VersionCommand);\ncli.register(DoctorCommand);\ncli.register(NewCommand);\ncli.register(NewLibCommand);\ncli.register(TranspileCommand);\ncli.register(CompileCommand);\ncli.register(GenerateTypesCommand);\ncli.register(SimulatorCommand);\ncli.runExit(args);\n"],"names":["readFileSync","join","Builtins","Cli","CompileCommand","DoctorCommand","GenerateTypesCommand","NewCommand","NewLibCommand","SimulatorCommand","TranspileCommand","RootFolder","packageJsonContents","packageJson","JSON","parse","args","process","argv","slice","cli","binaryLabel","binaryName","binaryVersion","version","on","exit","register","HelpCommand","VersionCommand","runExit"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";AAEA,SAASA,YAAY,QAAQ,KAAK;AAClC,SAASC,IAAI,QAAQ,YAAY;AACjC,SAASC,QAAQ,EAAEC,GAAG,QAAQ,YAAY;AAC1C,SAASC,cAAc,QAAQ,yCAAyC;AACxE,SAASC,aAAa,QAAQ,kCAAkC;AAChE,SAASC,oBAAoB,QAAQ,wCAAwC;AAC7E,SAASC,UAAU,QAAQ,0CAA0C;AACrE,SAASC,aAAa,QAAQ,wCAAwC;AACtE,SAASC,gBAAgB,QAAQ,2CAA2C;AAC5E,SAASC,gBAAgB,QAAQ,2CAA2C;AAC5E,SAASC,UAAU,QAAQ,qBAAqB;AAEhD,MAAMC,sBAAsBZ,aACxBC,KAAKU,YAAY,iBACjB;AAEJ,MAAME,cAAcC,KAAKC,KAAK,CAACH;AAE/B,MAAMI,OAAOC,QAAQC,IAAI,CAACC,KAAK,CAAC;AAEhC,MAAMC,MAAM,IAAIjB,IAAI;IAChBkB,aAAa;IACbC,YAAY;IACZC,eAAeV,YAAYW,OAAO;AACtC;AAEAP,QAAQQ,EAAE,CAAC,UAAU;IACjBR,QAAQS,IAAI;AAChB;AAEAN,IAAIO,QAAQ,CAACzB,SAAS0B,WAAW;AACjCR,IAAIO,QAAQ,CAACzB,SAAS2B,cAAc;AACpCT,IAAIO,QAAQ,CAACtB;AACbe,IAAIO,QAAQ,CAACpB;AACba,IAAIO,QAAQ,CAACnB;AACbY,IAAIO,QAAQ,CAACjB;AACbU,IAAIO,QAAQ,CAACvB;AACbgB,IAAIO,QAAQ,CAACrB;AACbc,IAAIO,QAAQ,CAAClB;AACbW,IAAIU,OAAO,CAACd"}

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 {
@@ -32,10 +32,12 @@ export type CheckListItem<TResult> = {
     waitingDescription: string;
     errorDescription: string;
     finishedDescription: (result: TResult | false) => string;
+    skipDescription?: string;
     runner: () => Promise<TResult> | Promise<false>;
     onFinish?: (result: TResult | false) => void;
     ready?: boolean;
     quitOnError?: boolean;
+    skip?: boolean | (() => boolean);
 };
 export interface ParameterDescription {
     name: string;
@@ -64,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[];
@@ -92,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>;
 };
@@ -101,3 +102,6 @@ export type FunctionTypeOverrideMap = Record<string, {
 export declare enum TemplateName {
     Blank = "blank"
 }
+export declare enum LibraryTemplateName {
+    Blank = "blank"
+}

package/src/types.js

@@ -12,5 +12,9 @@ export var TemplateName;
 (function(TemplateName) {
     TemplateName["Blank"] = "blank";
 })(TemplateName || (TemplateName = {}));
+export var LibraryTemplateName;
+(function(LibraryTemplateName) {
+    LibraryTemplateName["Blank"] = "blank";
+})(LibraryTemplateName || (LibraryTemplateName = {}));
 
 //# sourceMappingURL=types.js.map

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 | false) => string;\n    runner: () => Promise<TResult> | Promise<false>;\n    onFinish?: (result: TResult | false) => void;\n    ready?: boolean;\n    quitOnError?: 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;;UA6GAC;;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\nexport enum LibraryTemplateName {\n    Blank = 'blank',\n}\n"],"names":["PlaydateSdkVersionIdentifier","HealthCheckStatusType","TemplateName","LibraryTemplateName"],"rangeMappings":";;;;;;;;;;;;;;;;;","mappings":";UAWYA;;GAAAA,iCAAAA;;UAiBAC;;;;GAAAA,0BAAAA;;UA8GAC;;GAAAA,iBAAAA;;UAIAC;;GAAAA,wBAAAA"}