Merge pull request #5 from littletof/feat/theme

feat: Export types, add verbose option, change default theme colors

Author: littletof

mod.ts

@@ -1,3 +1,4 @@
 export { snap } from "./snapper.ts";
+export type { SnapParams, SnapOptions, ThemeColors} from "./snapper.ts";
 
 export {buildServer as buildSnapperServer, startServer as startSnapperServer} from "./server.ts";

server.ts

@@ -1,6 +1,7 @@
 import { Application, Router, send } from "https://deno.land/x/oak@v9.0.1/mod.ts";
 import {template} from './template.ts';
 import {xterm} from './static/xterm/packed.ts';
+import { ThemeColors } from "./snapper.ts";
 
 export function buildServer(): Application {
     const router = new Router();
@@ -42,24 +43,23 @@ export function startServer(opts?: {port?: number}) {
     };
 }
 
-export const defaultTheme = {
-    "foreground": "#cccccc",
-    "background": "#1e1e1e",
-    "cursorColor": "#cccccc",
-    "black": "#000000",
-    "red": "#c62f37",
-    "green": "#37be78",
-    "yellow": "#e2e822",
-    "blue": "#396ec7",
-    "purple": "#b835bc",
-    "cyan": "#3ba7cc",
-    "white": "#e5e5e5",
-    "brightBlack": "#666666",
-    "brightRed": "#e94a51",
-    "brightGreen": "#45d38a",
-    "brightYellow": "#f2f84a",
-    "brightBlue": "#4e8ae9",
-    "brightPurple": "#d26ad6",
-    "brightCyan": "#49b7da",
-    "brightWhite": "#e5e5e5"
+export const defaultTheme: ThemeColors = {
+    foreground: "#cccccc",
+    background: "#1e1e1e",
+    black: "#000000",
+    brightBlack: "#666666",
+    red: "#CD3131",
+    brightRed: "#F14C4C",
+    green: "#0DBC79",
+    brightGreen: "#23D18B",
+    yellow: "#E5E510",
+    brightYellow: "#F5F543",
+    blue: "#2472C8",
+    brightBlue: "#3B8EEA",
+    magenta: "#BC3FBC",
+    brightMagenta: "#D670D6",
+    cyan: "#11A8CD",
+    brightCyan: "#29B8DB",
+    white: "#E5E5E5",
+    brightWhite: "#E5E5E5"
 };

snapper.ts

@@ -4,15 +4,47 @@ import { startServer } from "./server.ts";
 export interface SnapParams {
     imageSavePath: string;
     content: string;
-    viewport?: {width: number, height: number, deviceScaleFactor?: number},
+    viewport?: {width: number, height: number, deviceScaleFactor?: number}, // TODO get scaleFactor out, make w/h optional
+}
+
+export interface SnapOptions {
+    snapServerUrl?: string;
+    theme?: ThemeColors;
+    puppeteerLaunchOptions?: PuppeteerLaunchOptions;
+    verbose?: boolean;
+}
+
+export interface ThemeColors {
+    foreground?: string;
+    background?: string;
+    black?: string;
+    brightBlack?: string;
+    red?: string;
+    brightRed?: string;
+    green?: string;
+    brightGreen?: string;
+    yellow?: string;
+    brightYellow?: string;
+    blue?: string;
+    brightBlue?: string;
+    magenta?: string;
+    brightMagenta?: string;
+    cyan?: string;
+    brightCyan?: string;
+    white?: string;
+    brightWhite?: string;
 }
 
 // TODO Deno puppeteer types
 export type PuppeteerLaunchOptions = any;
 
-export async function snap(snaps: SnapParams[], options?: {snapServerUrl?: string, theme?: any, puppeteerLaunchOptions?: PuppeteerLaunchOptions}) {
+export async function snap(snaps: SnapParams[], options?: SnapOptions) {
+    const log = createLog(options);
+    log('\x1b[42m \x1b[1m\x1b[37mSnapper\x1b[39m\x1b[22m 📷  \x1b[49m');
+    log('\nStarting server...');
     const {listen, abort} = startServer();
 
+    log('Launching puppeteer...');
     const browser = await puppeteer.launch(options?.puppeteerLaunchOptions || {
         env: { PUPPETEER_PRODUCT: 'chrome' },
         defaultViewport: {width: 1080, height: 30},
@@ -21,7 +53,7 @@ export async function snap(snaps: SnapParams[], options?: {snapServerUrl?: strin
     });
 
     const page = await browser.newPage();
-    
+    log('\nSnapping pictures: ');
     for(let textCase of snaps) {
         const viewPort = {deviceScaleFactor: 3, width: 1080, height: 30, ...textCase.viewport};
         // TODO handle headless looking different
@@ -55,12 +87,21 @@ export async function snap(snaps: SnapParams[], options?: {snapServerUrl?: strin
         await page.goto(options?.snapServerUrl || `http://localhost:7777`);
         await page.waitForSelector('#done');
         // TODO checkexists imageSavePath
+        log(`\t- ${textCase.imageSavePath}`);
         await page.screenshot({ path: textCase.imageSavePath, fullPage: !textCase.viewport });
     }
 
     await browser.close();
 
     abort();
     await listen;
+    log('\nPuppeteer, server closed.\n\x1b[42m \x1b[1m\x1b[37mSnapping done \x1b[39m\x1b[22m\x1b[49m');
+}
+
+export function createLog(options?: SnapOptions) {
+    if(options?.verbose) {
+        return (...text: any[]) => console.log(...text);
+    }
+    return (...text: any[]) => {}
 }