cli.ts

#!/usr/bin/env node
import open from 'open';
import updateNotifier from 'update-notifier';
import queryString from 'query-string';
import { Listr } from 'listr2';
import { clipboard } from 'clipboard-sys';

import PromptModule from './src/modules/prompt.module.js';
import PresetHandlerModule from './src/modules/preset-handler.module.js';
import FileHandlerModule from './src/modules/file-handler.module.js';
import DownloadModule from './src/modules/download.module.js';
import RendererModule from './src/modules/renderer.module.js';
import readFileAsync from './src/utils/read-file-async.util.js';
import transformToQueryParams from './src/utils/transform-to-query-params.util.js';
import defaultErrorView from './src/views/default-error.view.js';
import defaultSuccessView from './src/views/default-success.view.js';
import packageJson from './package.json' with { type: 'json' };
import {
  CARBON_URL,
  CARBON_CUSTOM_THEME,
} from './src/helpers/carbon/constants.helper.js';

const Prompt = await PromptModule.create();
const file = Prompt.getFile;
const flags = Prompt.getFlags;
const input = Prompt.getInput;
const answers = Prompt.getAnswers;
const FileHandler = new FileHandlerModule(file);
const PresetHandler = new PresetHandlerModule(flags.config);
PresetHandler.mergeSettings({
  language: FileHandler.getMimeType,
  titleBar: FileHandler.getFileName,
});
const Download = new DownloadModule(file);
const TaskList = new Listr([]);

// --preset has a higher priority than default settings
if (flags.preset) {
  PresetHandler.mergeSettings(await PresetHandler.getPreset(flags.preset));
}

// Anonymous tasks that have to be caught for better UX
TaskList.add([
  {
    task: async () => {
      // --interactive has an even higher priority than --preset
      if (flags.interactive) {
        PresetHandler.mergeSettings(
          answers as CarbonCLIPresetAndAnswersIntersectionType,
        );
      }
      // If --start isn’t default (1), use the original line number as the first line number
      if (flags.start > 1) {
        PresetHandler.mergeSettings({
          firstLineNumber: flags.start,
        });
      }
      // --settings has last-write priority
      if (flags.settings) {
        PresetHandler.mergeSettings(JSON.parse(flags.settings));
      }
      // As long as it’s not a local --config, persist the latest run
      if (!flags.config) {
        await PresetHandler.savePreset(
          PresetHandler.getSettings.presetName,
          PresetHandler.getSettings,
        );
      }
    },
  },
]);

// Task 1: Process and encode input
TaskList.add([
  {
    title: `Processing ${file || `input from ${flags.fromClipboard ? 'clipboard' : 'stdin'}`
      }`,
    task: async (ctx) => {
      ctx.encodedContent = encodeURIComponent(
        await FileHandler.process(input, flags.start, flags.end),
      );
      Download.setFlags = flags;
      Download.setImgType = PresetHandler.getSettings.type;
    },
  },
]);

// Task 2: Prepare things
TaskList.add([
  {
    title: 'Preparing connection',
    task: (ctx) => {
      ctx.preparedURL = `${CARBON_URL}?${queryString.stringify(
        transformToQueryParams({
          ...PresetHandler.getSettings,
          code: ctx.encodedContent,
          // If settings have a `custom` key, add the `t` query param to signal Carbon a custom theme
          // I find this ↓ more readable than `t: settings.custom && CARBON_CUSTOM_THEME || undefined,`
          ...(PresetHandler.getSettings.custom && { t: CARBON_CUSTOM_THEME }),
        }),
      )}`;
    },
  },
]);

// Task 3: Open image in browser [skippable]
TaskList.add([
  {
    title: 'Opening in browser',
    skip: !flags.openInBrowser,
    task: ({ preparedURL }) => {
      open(preparedURL);
    },
  },
]);

// Task 4: Fetch image and rename it, if necessary [skippable]
TaskList.add([
  {
    title: 'Fetching beautiful image',
    skip: flags.openInBrowser,
    task: async ({ preparedURL }) => {
      const Renderer = await RendererModule.create(
        flags.engine,
        flags.disableHeadless,
        PresetHandler.getSettings.type,
      );
      if (PresetHandler.getSettings.custom) {
        await Renderer.setCustomTheme(
          PresetHandler.getSettings.custom,
          CARBON_CUSTOM_THEME,
        );
      }
      await Renderer.download(
        preparedURL,
        Download.getSaveDirectory,
        Download.getDownloadedAsFileName,
      );
      if (!flags.toClipboard) {
        await FileHandler.rename(
          Download.getDownloadedAsPath,
          Download.getSavedAsPath,
        );
      }
    },
  },
]);

// Task 5: Copy image to clipboard [skippable]
TaskList.add([
  {
    title: 'Copying image to clipboard',
    skip: !flags.toClipboard || flags.openInBrowser,
    task: async ({ preparedURL }) => {
      await clipboard.writeImage(
        await readFileAsync(Download.getDownloadedAsPath, false),
      );
    },
  },
]);

try {
  await TaskList.run();
  console.log(
    await defaultSuccessView(
      flags,
      Download.getPath,
      PresetHandler.getSettings.type,
    ),
  );
  updateNotifier({ pkg: packageJson }).notify();
  process.exit();
} catch (e) {
  console.error(defaultErrorView((e as Error).message));
  process.exit(1);
}