build.js

import esMain from 'es-main';
import child_process from 'node:child_process';
import fs from 'node:fs';
import path from 'node:path';
import zipLib from 'zip-lib';

const textFileExtensions = ['.js', '.json', '.html'];
const binaryFileExtensions = ['.png'];

/**
 * Package the sources into a user script and a Google Chrome extension.
 */
async function main() {
  fs.rmSync('dist', { recursive: true, force: true });

  const distFileName = `javadoc_search_frame_${version().replaceAll('.', '_')}`;

  // Userscript
  copyFile(
    'src/userscript/javadoc_search_frame.js',
    `dist/userscript/${distFileName}.user.js`,
    {
      append: [
        `var messages = ${readFile('src/common/_locales/en/messages.json')}`,
        readFile('src/userscript/lib/Messages.js'),
        readFile('src/userscript/lib/Storage.js'),
        readFile('src/common/lib/Option.js'),
        readFile('src/common/lib/Frames.js'),
        readFile('src/userscript/lib/OptionsPage.js'),
        readFile('src/common/lib/HttpRequest.js'),
        readFile('src/common/lib/OptionsPageGenerator.js'),
        readFile('src/common/lib/common.js'),
      ],
    }
  );
  console.log(`Built dist/userscript/${distFileName}.user.js`);

  // Google Chrome extension
  copyDir('src/googlechrome', 'dist/googlechrome');
  copyFile(
    'src/googlechrome/event-page.js',
    'dist/googlechrome/event-page.js',
    {
      append: [readFile('src/common/lib/Frames.js')],
    }
  );
  copyDir('src/common', 'dist/googlechrome');
  zipLib.archiveFolder(
    'dist/googlechrome',
    `dist/googlechrome/${distFileName}.zip`
  );
  console.log(`Built dist/googlechrome/${distFileName}.zip`);
}

/**
 * Get the version from Git.
 */
const version = (() => {
  let cachedValue;
  return () =>
    (cachedValue =
      cachedValue ||
      child_process
        .execFileSync('git', ['describe', '--dirty'], {
          encoding: 'utf-8',
        })
        .trim());
})();

/**
 * Read a file to a string.
 *
 * @param {string} filePath
 */
function readFile(filePath) {
  return fs.readFileSync(filePath, { encoding: 'utf-8' });
}

/**
 * Copy a single file, replacing #VERSION# placeholders in text files and
 * optionally appending other files to the copy.
 *
 * @param {string} from
 * @param {string} to
 * @param {{ append?: string[] }} [options]
 */
function copyFile(from, to, options) {
  fs.mkdirSync(path.dirname(to), { recursive: true });
  const extension = path.extname(from);

  if (binaryFileExtensions.includes(extension)) {
    if (options?.append?.length) {
      throw new Error('Cannot append to binary file: ' + from);
    }
    fs.copyFileSync(from, to);
    return;
  }

  if (textFileExtensions.includes(extension)) {
    let fileContents = readFile(from);

    // Append to the end of the file.
    if (options?.append?.length) {
      fileContents += '\n' + options.append.join('\n');
    }

    // Replace #VERSION# placeholders.
    fileContents = fileContents.replaceAll('#VERSION#', version());

    fs.writeFileSync(to, fileContents);
    return;
  }

  throw new Error(`Unrecognized file extension: ${from}`);
}

/**
 * Copy a directory, replacing #VERSION# placeholders in text files.
 *
 * @param {string} from
 * @param {string} to
 */
function copyDir(from, to) {
  if (!fs.existsSync(to)) {
    fs.mkdirSync(to);
  }
  const dirEntries = fs.readdirSync(from).map((entry) => ({
    from: path.join(from, entry),
    to: path.join(to, entry),
  }));
  for (const entry of dirEntries) {
    if (fs.lstatSync(entry.from).isFile()) {
      copyFile(entry.from, entry.to);
    } else {
      copyDir(entry.from, entry.to);
    }
  }
}

// @ts-ignore
if (esMain(import.meta)) {
  main().catch((e) => {
    console.error(e);
    process.exitCode = 1;
  });
}