publish.js

/**
 * This script is used to publish this package on the npm registry.
 *
 * A custom script is used to only distribute source, README and
 * license files, while maintaining the desired import paths.
 *
 * This is not possible otherwise.
 */

const IS_WINDOWS = process.platform === "win32";

const fs = require("fs-extra");
const path = require("path");
const spawnAsync = require("@expo/spawn-async");
const prompt = require("prompt-sync")();

async function divider(text) {
  const chalk = (await import("chalk")).default;
  console.log(
    chalk.gray(`----`),
    chalk.blue.bold(text.toUpperCase()),
    chalk.gray(`----`),
  );
}

function getLocalPath(pathFromRoot) {
  return path.join(__dirname, pathFromRoot);
}

const tempFolder = getLocalPath("publish-tmp");
const buildFolder = getLocalPath("lib");

async function cleanUp() {
  const ora = (await import("ora")).oraPromise;

  if (fs.existsSync(tempFolder)) {
    const rm = fs.rm(tempFolder, { recursive: true, force: true });
    ora(rm, "Removing temp directory");
    await rm;
  }

  if (fs.existsSync(buildFolder)) {
    const rm = fs.rm(buildFolder, { recursive: true, force: true });
    ora(rm, "Removing build directory");
    await rm;
  }
}

async function main() {
  const ora = (await import("ora")).oraPromise;
  const oraNorm = (await import("ora")).default;

  const spinner = oraNorm("Initialising").start();

  spinner.succeed();

  await divider("Clean up previous");
  await cleanUp();

  await divider("Preparation");

  const mkTempDir = fs.mkdir(tempFolder);
  ora(mkTempDir, "Creating temporary directory");
  await mkTempDir;

  await divider("Build");

  const build = spawnAsync(IS_WINDOWS ? "yarn.cmd" : "yarn", ["build"]);
  ora(build, "Transpiling Typescript");
  await build;

  const copyBuild = fs.copy(buildFolder, tempFolder, {
    recursive: true,
    overwrite: true,
  });
  ora(copyBuild, "Copying transpiled code to temp folder");
  await copyBuild;

  await divider("Meta tasks");

  const copyReadme = fs.copyFile(
    getLocalPath("README.md"),
    path.join(tempFolder, "README.md"),
  );
  const copyLicense = fs.copyFile(
    getLocalPath("LICENSE"),
    path.join(tempFolder, "LICENSE"),
  );
  const copyPackageJson = fs.copyFile(
    getLocalPath("package.json"),
    path.join(tempFolder, "package.json"),
  );
  const copyAll = Promise.all([copyReadme, copyLicense, copyPackageJson]);
  ora(copyAll, "Copying README, LICENSE and package.json");
  await copyAll;

  const copyTypesDir = fs.copy(
    getLocalPath("src/@types"),
    path.join(tempFolder, "@types"),
    {
      recursive: true,
      overwrite: true,
    },
  );
  ora(copyTypesDir, "Copying @types folder");
  await copyTypesDir;

  let newVer = null;

  async function modPackageJson() {
    const packageJson = await fs.readJSON(
      path.join(tempFolder, "package.json"),
    );

    if (!process.env.NPM_TOKEN) {
      const currentVer = packageJson.version;
      console.log(`\nCurrent version: ${currentVer}`);
      newVer = prompt(`New version: `, currentVer);

      if (newVer === null) {
        throw "Invalid version";
      }

      packageJson.version = newVer;

      // Write back new version name
      await fs.writeJSON(getLocalPath("package.json"), packageJson, {
        spaces: 2,
      });
    }

    // Remove unneeded sections
    delete packageJson.private;
    delete packageJson.scripts;

    // Overwrite module info
    packageJson.types = "./index.d.ts";
    packageJson.main = "./index.js";

    // Write final modified JSON to temp folder
    await fs.writeJSON(path.join(tempFolder, "package.json"), packageJson, {
      spaces: 2,
    });
  }

  try {
    const mod = modPackageJson();
    ora(mod, "Modifying package.json");
    await mod;
  } catch {
    process.exit(-1);
  }

  await divider("Publish package");

  process.chdir(tempFolder);

  if (!process.env.NPM_TOKEN) {
    const OTP = prompt("Enter OTP (leave blank if none): ");

    const publish = spawnAsync(IS_WINDOWS ? "npm.cmd" : "npm", [
      "publish",
      OTP ? `--otp` : "",
      OTP ? OTP : "",
    ]);
    ora(publish, "Publishing package");
    await publish;
  } else {
    const npmPublish = require("@jsdevtools/npm-publish");

    // Run npm-publish with all defaults
    await npmPublish({
      token: process.env.NPM_TOKEN,
    });
  }

  await divider("Clean up");
  await cleanUp();
}

main();