ipa-jfk/bin/jfk.js

IPA narrow transcription of English words in New York City accent

#!/usr/bin/env node

/* Copyright (C) 2020-2021 b1f6c1c4
 *
 * This file is part of IPA-JFK.
 *
 * IPA-JFK is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3.
 *
 * IPA-JFK is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with IPA-JFK.  If not, see <https://www.gnu.org/licenses/>.
 */

import yargs from 'yargs';
import { hideBin } from 'yargs/helpers';
import * as jfk from '../index.js';

const { argv } = yargs(hideBin(process.argv))
  .scriptName('jfk')
  .usage('$0 [<options>] <word> [<phoneme>...]')
  .help('h')
  .alias('h', 'help')
  .showHelpOnFail(false, 'Hint: You may need this: ipa-jfk --help.')
  .version()
  .option('unicode', {
    describe: 'Output UTF-8 encoded IPA in unicode.',
    type: 'boolean',
  })
  .option('html', {
    describe: 'Output HTML entities of IPA in unicode.',
    type: 'boolean',
  })
  .option('latex', {
    describe: 'Output LaTeX script for the TIPA package.',
    type: 'boolean',
  })
  .option('phonemic', {
    describe: 'Disable narrow transcription, only use broad one.',
    type: 'boolean',
  })
  .check((argv) => {
    const v = +!!argv.unicode + +!!argv.html + +!!argv.latex;
    if (v > 1)
      throw new Error('Error: Only one of --unicode, --html, --latex may be specified.');
    if (v === 0)
      argv.unicode = true;
    return true;
  });

if (!argv._.length) {
  console.error('Error: Missing the <word> you want to translate. See jfk --help for help.');
  process.exit(1);
}

const [word] = argv._.splice(0, 1);
const ref = argv._.join(' ').trim();

const phss = ref ? [ref] : jfk.queryDatabase(word);
const irs = phss.map((phs) => jfk.process(phs, word, argv.phonemic));

let res;
if (argv.unicode) {
  res = irs.map(jfk.unicode);
} else if (argv.html) {
  res = irs.map(jfk.html);
} else { // if (argv.latex) {
  res = irs.map(jfk.latex);
}

res.forEach((r) => { console.log(r); });