receiptio/bin/cli.js

Node.js printing application for receipt printers, simple and easy with receipt markdown, printer status support.

#!/usr/bin/env node
/*
Copyright 2021 Open Foodservice System Consortium

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

const fs = require('fs');
const stream = require('stream/promises');
const receiptio = require('receiptio');

(async argv => {

    // error code
    const code = {
        'success': 0,
        'online': 100,
        'coveropen': 101,
        'paperempty': 102,
        'error': 103,
        'offline': 104,
        'disconnect': 105,
        'timeout': 106,
        'drawerclosed': 200,
        'draweropen': 201
    };
    // print result
    let result = '';
    // result receiver
    const receiver = async readable => {
        readable.setEncoding('utf8');
        for await (const chunk of readable) {
            result += chunk;
        }
    };
    // source
    let source = '';
    // parameters
    const params = {
        h: false, // show help
        d: '', // ip address or serial/usb port of target printer
        o: '', // file to output (if -d option is not present)
        q: '' // inquire status (printer/drawer/drawer2)
    };
    // parse arguments
    for (let i = 0; i < argv.length; i++) {
        const key = argv[i];
        if (/^-[huvsni]$/.test(key)) {
            // option without value
            params[key[1]] = true;
        }
        else if (/^-[dopqcrmbgtl]$/.test(key)) {
            // option with value
            if (i < argv.length - 1) {
                const value = argv[i + 1];
                if (/^[^-]/.test(value)) {
                    params[key[1]] = value;
                    i++;
                }
            }
            // default value of status inquiry
            if (key[1] === 'q') {
                let q = params.q.toLowerCase();
                params.q = /^drawer2?$/.test(q) ? q : 'printer';
            }
        }
        else if (/^[^-]/.test(key)) {
            // source
            source = key;
        }
        else {
            // other
        }
    }
    if (params.h) {
        // show help
        console.error(`
usage: receiptio [options] [source]
source:
  receipt markdown text file
  https://receiptline.github.io/designer/
  if source is not present, standard input
options:
  -h                show help
  -d <destination>  ip address or serial/usb port of target printer
  -o <outfile>      file to output (if -d option is not present)
                    if -d and -o are not present, standard output
  -q [<device>]     inquire status (printer/drawer/drawer2) (default: printer)
  -c <chars>        characters per line (24-96) (default: 48)
  -u                upside down
  -v                landscape orientation (for escpos/epson/sii/citizen/star)
  -r <dpi>          print resolution for -v (180/203) (default: 203)
  -s                paper saving (reduce line spacing)
  -n                no paper cut
  -m [<l>][,<r>]    print margin (left: 0-24, right: 0-24) (default: 0,0)
  -i                print as image (requires puppeteer or sharp)
  -b <threshold>    image thresholding (0-255)
  -g <gamma>        image gamma correction (0.1-10.0) (default: 1.0)
  -t <timeout>      print timeout (0-3600 sec) (default: 300)
  -l <language>     language of source file (default: system locale)
                    (en/fr/de/es/po/it/ru/ja/ko/zh-hans/zh-hant/th/...)
  -p <printer>      printer control language (default: auto detection)
                    (escpos/epson/sii/citizen/fit/impact/impactb/generic/
                     star/starline/emustarline/stargraphic/
                     starimpact/starimpact2/starimpact3/svg/png/txt/text)
                    (png requires puppeteer or sharp)
print results:
  success(0), online(100), coveropen(101), paperempty(102),
  error(103), offline(104), disconnect(105), timeout(106),
  drawerclosed(200), draweropen(201)
examples:
  receiptio -d com9 -q
  receiptio -d COM1 example.receipt
  receiptio -d /dev/usb/lp0 example.receipt
  receiptio -d /dev/ttyS0 -u -b 160 example.receipt
  receiptio -d 192.168.192.168 -c 42 example.receipt
  receiptio example.receipt -o receipt.png
  receiptio example.receipt -o receipt.txt
  receiptio example.receipt -p escpos -i -b 128 -g 1.8 -o receipt.prn
  receiptio < example.receipt > receipt.svg
  echo {c:1234567890} | receiptio | more`);
        process.exitCode = 1;
    }
    else {
        // options
        const options = argv.join(' ');
        // source
        const input = params.q ? '' : source ? fs.createReadStream(source) : process.stdin;
        // destination
        const output = params.d ? receiver : params.o ? fs.createWriteStream(params.o) : process.stdout;
        // print or transform
        await stream.pipeline(input, receiptio.createPrint(options), output).then(() => {
            // result
            if (result) {
                console.error(result);
                process.exitCode = code[result];
            }
        }).catch(e => {
            // error
            console.error(e.message);
            process.exitCode = 1;
        });
    }

})(process.argv.slice(2));