@uss-stargazer/job-queue 0.0.2 → 0.0.4

package/README.md

@@ -22,7 +22,32 @@ job-queue --help
 jobq --help
 ```
 
-## Syncing with gists
+## Usage
+
+***TLDR***: The CLI tries to be user friendly, so just use it...
+
+It's just based on a few files: config.json, jobqueue.json, and projectpool.json. Strives to be
+a bit like Git in the sense that it opens data structures in the user's editor for updating data.
+
+### JSON schemas
+
+It's recommended that you use an editor or editor plugin with some sort of intellisense for JSON 
+schemas, as it makes it much easier to work with.
+
+If this isn't available, the expected structures can be found in the Zod schemas in
+`src/data/$TARGET.ts` (at the top of each).
+
+### Config options
+
+- `editor`: string to edit file when filepath is appended. If not specified, is infered from 
+environment vars or from your Git configuration, if you have that installed.
+- `confirmGistUpdates`: whether it should check before pushing or pulling gists from GitHub, if you
+have any set up (see [here](#syncing-with-gists)).
+- `confirmOffline`: whether to check before going into offline mode when there are gists configured
+and `github.com` cannot be resolved.
+- `showBanner`: whether to show ASCII art banner on start
+
+### Syncing with gists
 
 `job-queue` allows you to sync data files with a gist/gists on your GitHub account. This provides 
 cloud storage and makes the program more portable.
@@ -48,6 +73,7 @@ To link to a gist, provide the gist ID and a GitHub access token in config.json,
 
 Your gist ID can be copied easily from the URL; usually something like `https://gist.github.com/USERNAME/GIST_ID`.
 
+
 ## Sample Workflow
 
 - _\[Daemon\]_ Spontaneous, not fleshed out ideas get immediately added to the project pool as "inactive".

package/dist/data/config.js

@@ -34,8 +34,9 @@ export const ConfigSchema = z.object({
     ]),
     schemas: NonemptyString.meta({ title: "Schemas directory", description: `Path to directory containing: ${jsonSchemaNames.map(base => `${base}.schema.json`).join(", ")}.` }).transform((schemasDir) => Object.fromEntries(jsonSchemaNames.map((base) => [base, pathToFileURL(path.resolve(schemasDir, `${base}.schema.json`)).href]))),
     editor: NonemptyString.optional().meta({ title: "Editor command", description: "Command to run editor. Will be run like `<editor> /some/data.json` so make sure it waits." }),
-    confirmGistUpdates: z.boolean().optional().meta({ description: "Whether to prompt before pushing or pulling a gist from GitHub." }),
-    confirmOffline: z.boolean().optional().meta({ description: "Whether to confirm before using offline (if there are gists in config)." })
+    confirmGistUpdates: z.boolean().optional().describe("Whether to prompt before pushing or pulling a gist from GitHub."),
+    confirmOffline: z.boolean().optional().describe("Whether to confirm before using offline (if there are gists in config)."),
+    showBanner: z.boolean().optional().describe("Show ASCII art banner on start.")
 });
 export const toInputConfig = (outputData) => {
     const schemaDir = Object.values(outputData.schemas).reduce((schemaDir, schemaPath) => {

package/dist/data/projectpool.js

@@ -65,5 +65,14 @@ export const updateProject = async (project, projectPool, jobQueue, config) => {
             await jobQueue.sync();
         }
     }
+    if (userDeletedProject && jobsReferencingProject.length > 0) {
+        const deleteJobReferences = await confirm({
+            message: `You are deleting this project. Would you like to delete all referencing jobs, too?`,
+        });
+        if (deleteJobReferences) {
+            jobQueue.data.queue = jobQueue.data.queue.filter((job) => job.project !== project.name);
+            await jobQueue.sync();
+        }
+    }
     return userDeletedProject ? 'deleted' : updatedProject;
 };

package/dist/index.js

@@ -1,16 +1,17 @@
 import chalk from 'chalk';
 import clear from 'clear';
 import figlet from 'figlet';
-import { select } from '@inquirer/prompts';
+import { search } from '@inquirer/prompts';
 import { ExitPromptError, Separator } from '@inquirer/core';
 import actions, { actionNames, actionsDependentOnJobs, actionsDependentOnProjects, } from './actions.js';
 import { getConfig, getDataPathFromConfig } from './data/config.js';
 import { getJobQueue } from './data/jobqueue.js';
 import { getProjectPool } from './data/projectpool.js';
-import { editData } from './data/index.js';
+import { dataNames, editData } from './data/index.js';
 import { simpleDeepCompare } from './utils/index.js';
 import dns from 'dns/promises';
 import { inquirerConfirm } from './utils/promptUser.js';
+import { isGistData } from './utils/gistData.js';
 async function loadData(overrideConfigDir, overrideConfig, previousData) {
     const { config, path: configPath, hadToCreate: autoCreateOtherFiles, } = await getConfig(overrideConfigDir, overrideConfig);
     const data = {
@@ -44,7 +45,7 @@ async function loadData(overrideConfigDir, overrideConfig, previousData) {
                 });
                 if (!config.data.confirmGistUpdates ||
                     (await inquirerConfirm(`Pull gist for ${key}?`))) {
-                    console.log(chalk.blue('[i]'), 'initial pull of gist for', key);
+                    console.log(chalk.blue('[i]'), 'pulling', key);
                     await data[key].pull();
                 }
             }
@@ -60,60 +61,73 @@ async function loadData(overrideConfigDir, overrideConfig, previousData) {
     return data;
 }
 async function syncData(data) {
-    for (const key of ['jobqueue', 'projectpool']) {
+    for (const key of dataNames) {
         await data[key].sync();
-        if (data[key].isLinked &&
+        if (isGistData(data[key]) &&
+            data[key].isLinked &&
             (!data.config.data.confirmGistUpdates ||
                 (await inquirerConfirm(`Push gist for ${key}?`)))) {
-            console.log(chalk.blue('[i]'), 'sync push of gist for', key);
+            console.log(chalk.blue('[i]'), 'pushing', key);
             await data[key].push();
         }
     }
 }
 export default async function main(overrideConfigDir, overrideConfig) {
-    clear();
-    console.log(chalk.yellow(figlet.textSync('JobQueue', { horizontalLayout: 'full' })));
     let data = await loadData(overrideConfigDir, overrideConfig);
-    console.log();
+    if (data.config.data.showBanner ?? true) {
+        if (data.config.data.showBanner === undefined) {
+            clear();
+            data.config.data.showBanner = false;
+        }
+        console.log(chalk.yellow(figlet.textSync('JobQueue', { horizontalLayout: 'full' })));
+    }
     try {
         while (true) {
-            const action = await select({
+            console.log();
+            const actionChoices = actionNames.map((action) => {
+                if (actionsDependentOnJobs.includes(action) &&
+                    data.jobqueue.data.queue.length === 0)
+                    return {
+                        name: action,
+                        value: action,
+                        disabled: '(Empty job queue)',
+                    };
+                else if (actionsDependentOnProjects.includes(action) &&
+                    data.projectpool.data.pool.length === 0)
+                    return {
+                        name: action,
+                        value: action,
+                        disabled: '(Empty project pool)',
+                    };
+                else
+                    return { name: action, value: action };
+            });
+            const action = await search({
                 message: 'Select action',
-                choices: [
-                    ...actionNames.map((action) => {
-                        if (actionsDependentOnJobs.includes(action) &&
-                            data.jobqueue.data.queue.length === 0)
-                            return {
-                                name: action,
-                                value: action,
-                                disabled: '(Empty job queue)',
-                            };
-                        else if (actionsDependentOnProjects.includes(action) &&
-                            data.projectpool.data.pool.length === 0)
-                            return {
-                                name: action,
-                                value: action,
-                                disabled: '(Empty project pool)',
-                            };
-                        else
-                            return { name: action, value: action };
-                    }),
-                    new Separator(),
-                    { name: 'editData', value: 'editData' },
-                    { name: 'sync', value: 'sync' },
-                ],
+                source: (partialAction) => {
+                    const partialSet = new Set([...(partialAction?.toLowerCase() ?? [])]);
+                    const filteredActions = partialSet.size === 0
+                        ? actionChoices
+                        : actionChoices.filter((action) => partialSet.isSubsetOf(new Set([...action.name.toLowerCase()])));
+                    const otherActions = [
+                        { name: 'editData', value: 'editData' },
+                        { name: 'syncData', value: 'syncData' },
+                    ];
+                    return filteredActions.length > 0
+                        ? [...filteredActions, new Separator(), ...otherActions]
+                        : otherActions.filter((action) => partialSet.isSubsetOf(new Set([...action.name.toLowerCase()])));
+                },
                 pageSize: actionNames.length + 3,
             });
             if (action === 'editData') {
                 await editData(data, data.configPath);
                 data = await loadData(overrideConfigDir, overrideConfig, data);
             }
-            else if (action === 'sync') {
+            else if (action === 'syncData') {
                 await syncData(data);
             }
             else
                 await actions[action](data);
-            console.log();
         }
     }
     catch (error) {

package/dist/utils/promptUser.js

@@ -18,28 +18,7 @@ export const haveUserUpdateContents = async (contents, options, check) => {
         });
     const originalContents = await fs.readFile(file.path, { encoding: 'utf8' });
     while (true) {
-        const controller = new AbortController();
-        const signal = controller.signal;
-        const editorPromise = editInteractively(file.path, contents, options?.editor, options?.tooltips);
-        await new Promise((resolve) => setTimeout(resolve, 1000));
-        const abortPromise = confirm({ message: 'Type `y` to abort...' }, { signal })
-            .finally(() => clearNLines(1))
-            .then(async (shouldAbort) => {
-            if (shouldAbort) {
-                if (file.cleanup)
-                    await file.cleanup();
-                else
-                    await fs.writeFile(file.path, originalContents, {
-                        encoding: 'utf8',
-                    });
-                throw new AbortError('User aborted action');
-            }
-            return undefined;
-        });
-        contents = await Promise.race([editorPromise, abortPromise]);
-        controller.abort();
-        if (typeof contents !== 'string')
-            return undefined;
+        contents = await editInteractively(file.path, contents, options?.editor, options?.tooltips);
         if (check) {
             const error = check(contents);
             if (error === 'pass') {
@@ -47,7 +26,15 @@ export const haveUserUpdateContents = async (contents, options, check) => {
             }
             else if (typeof error === 'object') {
                 console.log(chalk.red(`${options?.errorHead}:`), error.errMessage);
-                continue;
+                if (!(await inquirerConfirm('Try again?'))) {
+                    if (file.cleanup)
+                        await file.cleanup();
+                    else
+                        await fs.writeFile(file.path, originalContents, {
+                            encoding: 'utf8',
+                        });
+                    throw new AbortError('User aborted action');
+                }
             }
         }
     }

package/index.js

@@ -1,17 +1,17 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import { Command } from 'commander';
 import chalk from 'chalk';
+
+import pkg from './package.json' with { type: 'json' };
 import main from './dist/index.js';
 
 const program = new Command();
 
 program
   .name('job-queue')
-  .description(
-    'A CLI app to keep track of jobs/tasks built around a couple of JSON files.',
-  )
-  .version('0.0.0')
+  .description(pkg.description)
+  .version(pkg.version)
   .option(
     '-c, --config <path>',
     'path to directory containing config.json (uses new system app dir by default)',
@@ -36,6 +36,7 @@ program
     });
 
     await main(configDir, { ...options })
+      .finally(() => console.log()) // Seperation line
       .then(() => {
         console.log(chalk.cyanBright('🖖 Live long and prosper...'));
         process.exit();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uss-stargazer/job-queue",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A CLI app to keep track of jobs/tasks built around a couple of JSON files.",
   "author": "uss-stargazer",
   "license": "Apache-2.0",