Skip to content

refactor(index): rename constructor param to reflect usage #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fdawgs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(index): rename constructor param to reflect usage #549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function parseOptions(acceptedOptions, options, version) {

class UnRTF {
#unrtfBin;
#unrtfPath;
#unrtfDir;
#unrtfVersion;

/** @type {UnRTFAcceptedOptions} */
Expand Down Expand Up @@ -200,51 +200,51 @@ class UnRTF {
});

/**
* @param {string} [binPath] - Path of UnRTF binary.
* @param {string} [binDir] - Directory path of UnRTF binary.
* If not provided, the constructor will attempt to find the binary
* in the PATH environment variable.
*
* For `win32`, a binary is bundled with the package and will be used
* if a local installation is not found.
* @throws {Error} If UnRTF binary cannot be found or version cannot be determined.
*/
constructor(binPath) {
this.#unrtfPath = "";
constructor(binDir) {
this.#unrtfDir = "";

if (binPath) {
if (binDir) {
/** @type {string|undefined} */
this.#unrtfPath = binPath;
this.#unrtfDir = binDir;
} else {
/* istanbul ignore next: requires specific OS */
const which = spawnSync(platform === "win32" ? "where" : "which", [
"unrtf",
]).stdout.toString();
const unrtfPath = UNRTF_PATH_REG.exec(which)?.[1];
const unrtfDir = UNRTF_PATH_REG.exec(which)?.[1];

if (unrtfPath) {
this.#unrtfPath = unrtfPath;
if (unrtfDir) {
this.#unrtfDir = unrtfDir;
}

/* istanbul ignore next: requires specific OS */
if (platform === "win32" && !unrtfPath) {
if (platform === "win32" && !unrtfDir) {
try {
// @ts-ignore: Optional dependency
// eslint-disable-next-line n/global-require -- Conditional require
this.#unrtfPath = require("node-unrtf-win32");
this.#unrtfDir = require("node-unrtf-win32");
} catch {
// Leave #unrtfPath empty; the generic "Unable to find ... binaries" error below will fire
// Leave #unrtfDir empty; the generic "Unable to find ... binaries" error below will fire
}
}
}

if (!this.#unrtfPath) {
if (!this.#unrtfDir) {
throw new Error(
`Unable to find ${platform} UnRTF binaries, please pass the installation directory as a parameter to the UnRTF instance.`
);
}
this.#unrtfPath = normalize(this.#unrtfPath);
this.#unrtfDir = normalize(this.#unrtfDir);

this.#unrtfBin = pathResolve(this.#unrtfPath, "unrtf");
this.#unrtfBin = pathResolve(this.#unrtfDir, "unrtf");

// Version needed for option validation; which is output to stderr
const version = spawnSync(this.#unrtfBin, [
Expand All @@ -258,11 +258,11 @@ class UnRTF {
}

/**
* @description Returns the path of the UnRTF binary.
* @returns {string} Path of UnRTF binary.
* @description Returns the directory path of the UnRTF binary.
* @returns {string} Directory path of UnRTF binary.
*/
get path() {
return this.#unrtfPath;
return this.#unrtfDir;
}

/**
Expand Down