feat: adding config option to prevent ligature unicode generation

fixes itgalaxy#457

.eslintrc.js

@@ -30,7 +30,7 @@ module.exports = {
       rules: {
         "max-lines": ["error", 510],
         "max-lines-per-function": ["error", 495],
-        "max-statements": ["error", 27],
+        "max-statements": ["error", 28],
       },
     },
     {

README.md

@@ -160,6 +160,12 @@ webfont({
 - Default: Gets is from `fontName` if not set, but you can specify any value.
 - Description: Template font family name you want.
 
+#### `ligatures`
+
+- Type: `boolean`
+- Default: `true`
+- Description: Turn on/off adding ligature unicode
+
 #### `glyphTransformFn`
 
 - Type: `function`

src/cli/index.ts

@@ -172,6 +172,12 @@ if (cli.flags.sort === false) {
 
 }
 
+if (cli.flags.ligatures === false) {
+
+  optionsBase.ligatures = cli.flags.ligatures;
+
+}
+
 if (cli.flags.addHashInFontUrl) {
 
   optionsBase.addHashInFontUrl = cli.flags.addHashInFontUrl;

src/cli/meow/__mocks__/index.ts

@@ -88,6 +88,10 @@ meowMock.showHelp = () => `
 
           Keeps the files in the same order of entry
 
+      --no-ligatures
+
+          Prevents adding ligature unicode
+
       --verbose
 
           Tell me everything!.

src/cli/meow/index.ts

@@ -76,6 +76,10 @@ const meowCLI = meow(`
 
             Keeps the files in the same order of entry
 
+        --no-ligatures
+
+            Prevents adding ligature unicode
+
         --verbose
 
             Tell me everything!.
@@ -193,6 +197,10 @@ const meowCLI = meow(`
       alias: "h",
       type: "boolean",
     },
+    ligatures: {
+      default: true,
+      type: "boolean",
+    },
     normalize: {
       type: "boolean",
     },

src/standalone/glyphsData.ts

@@ -57,13 +57,18 @@ export const getGlyphsData : GlyphsDataGetter = (files, options) => {
       sortedGlyphsData = glyphsData.sort(sortCallback);
     }
 
+    const { ligatures } = options;
+
     return Promise.all(sortedGlyphsData.map((glyphData: GlyphData) => new Promise((resolve, reject) => {
       metadataProvider(glyphData.srcPath, (error, metadata) => {
         if (error) {
           return reject(error);
         }
 
-        metadata.unicode.push(metadata.name.replace(/-/gu, "_"));
+        if (ligatures) {
+          metadata.unicode.push(metadata.name.replace(/-/gu, "_"));
+        }
+
         glyphData.metadata = metadata;
 
         return resolve(glyphData);

src/standalone/index.test.ts

@@ -432,6 +432,21 @@ describe("standalone", () => {
     expect(result.glyphsData.length > 0).toBe(true);
   });
 
+  it("should remove ligature unicode when `ligatures` set to `false`", async () => {
+    const result = await standalone({
+      files: `${fixturesGlob}/svg-icons/**/*`,
+      ligatures: false,
+      template: "css",
+    });
+
+    expect(Array.isArray(result.glyphsData)).toBe(true);
+    expect(result.glyphsData.length > 0).toBe(true);
+
+    result.glyphsData.forEach((glyph) => {
+      expect(glyph.metadata?.unicode).toHaveLength(1);
+    });
+  });
+
   it("should export `hash` in `result`", () => {
     expect.assertions(1);
 

src/standalone/options.ts

@@ -27,6 +27,7 @@ export const getOptions: OptionsGetter = (initialOptions) => {
       },
     },
     glyphTransformFn: null,
+    ligatures: true,
 
     /*
      * Maybe allow setup from CLI

src/types/OptionsBase.ts

@@ -27,5 +27,6 @@ export type OptionsBase = {
   prependUnicode?: boolean | unknown;
   metadata?: unknown;
   sort?: boolean;
+  ligatures?: boolean;
   addHashInFontUrl?: boolean | unknown;
 };