Add option for customizing fontawesome package location

README.md

@@ -36,6 +36,7 @@ fontawesomeSubset(["check", "square", "caret-up"], "sass/webfonts");
 -   `output_dir` - Directory that you want the webfonts to be generated in. Relative to current NPM process. Ex: `sass/webfonts`
 -   `options` - Object of options to further customize the tool.
     -   `package` - `free` or `pro` . Defaults to `free` version. See [below](#using-with-fontawesome-pro) for Pro instructions.
+    -   `packagePath` - `string` . Defaults to the default package names from the fontawesome registry. Can be used with an NPM alias to customize the path of the FontAwesome package to use. Ex: `fa-pro-6` combined with `npm install fa-pro-6@npm:@fortawesome/fontawesome-pro@^6.0.0`
     -   `targetFormats` - A string array of one or more formats to export. Available options: `woff` `woff2` `sfnt` (`ttf`). Defaults to `woff2` & `sfnt`.
 
 ### Using with FontAwesome Pro

src/index.ts

@@ -32,17 +32,23 @@ function fontawesomeSubset(
     outputDir: string,
     options: FontAwesomeOptions = {}
 ) {
-    const { package: packageType = "free", targetFormats = ["woff2", "sfnt"] } = options;
+    const {
+        package: packageType = "free",
+        targetFormats = ["woff2", "sfnt"],
+        packagePath,
+    } = options;
     // Maps style to actual font name / file name.
     const fontTypes = Object.keys(STYLE_FONT_MAP);
     let packageLocation: string;
 
     // Check to see if the user has either free, or pro installed.
     try {
-        packageLocation = require.resolve(`@fortawesome/fontawesome-${packageType}`);
+        packageLocation = require.resolve(packagePath ?? `@fortawesome/fontawesome-${packageType}`);
     } catch (e) {
         console.error(
-            `Unable to resolve the module '@fortawesome/fontawesome-${packageType}'. Double-check that you have your preferred fontawesome package installed as a dependency and the package type passed into the options if using Pro features.\n\n\`fontawesomeSubset(..., ..., { package: 'pro' })\``
+            `Unable to resolve the module '${
+                packagePath ?? `@fortawesome/fontawesome-${packageType}`
+            }'. Double-check that you have your preferred fontawesome package installed as a dependency and the package type passed into the options if using Pro features.\n\n\`fontawesomeSubset(..., ..., { package: 'pro' })\``
         );
         return Promise.resolve(false);
     }

src/types.ts

@@ -3,6 +3,10 @@ export interface FontAwesomeOptions {
      * The FontAwesome package type we should use. Defaults to 'free'.
      */
     package?: PackageType;
+    /**
+     * Override the path we use to search for a valid FontAwesome package. Useful for npm aliases.
+     */
+    packagePath?: string;
     /**
      * Requested font output targets.
      */

tests/index.test.ts

@@ -20,6 +20,10 @@ describe("fontawesomeSubset", () => {
         subsetMock.mockImplementation(jest.fn(() => Promise.resolve(Buffer.from(""))));
     });
 
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
     const testShouldAllAllRequiredGlyphs = async (
         subsets: SubsetOption,
         expected: { family: string; icon: string; duotone?: boolean }[]
@@ -226,8 +230,6 @@ describe("fontawesomeSubset", () => {
         expect(response).toBeFalsy();
         expect(warnSpy).toBeCalledTimes(2);
         expect(tableSpy).toBeCalledTimes(1);
-
-        jest.resetAllMocks();
     });
 
     it("should warn when a font file is not found for a requested subset", async () => {
@@ -248,4 +250,26 @@ describe("fontawesomeSubset", () => {
         expect(errorSpy).toBeCalledWith("One or more target formats are required. Exiting.");
         expect(response).toBeFalsy();
     });
+
+    it("should allow customizing the package resolve path with options.packagePath", async () => {
+        const errorSpy = jest.spyOn(console, "error").mockImplementationOnce(() => false);
+        const response = await fontawesomeSubset(["arrow-left"], "", {
+            packagePath: `@fortawesome/fontawesome-${PACKAGE}`,
+        });
+
+        expect(errorSpy).not.toBeCalled();
+        expect(response).toBeTruthy();
+    });
+
+    it("should error when an invalid packagePath is provided", async () => {
+        const errorSpy = jest.spyOn(console, "error").mockImplementationOnce(() => false);
+        const response = await fontawesomeSubset(["arrow-left"], "", {
+            packagePath: "some-other-name",
+        });
+
+        expect(errorSpy).toBeCalledWith(
+            expect.stringContaining("Unable to resolve the module 'some-other-name'.")
+        );
+        expect(response).toBeFalsy();
+    });
 });