feat(ligatures): adds a proposal to add ligatures

src/constants.ts

@@ -26,7 +26,8 @@ export const DEFAULT_OPTIONS: Omit<RunnerOptions, 'inputDir' | 'outputDir'> = {
   tag: 'i',
   prefix: 'icon',
   fontsUrl: undefined,
-  getIconId: getIconId
+  getIconId: getIconId,
+  addLigatures: false
 };
 
 export const DEFAULT_START_CODEPOINT = 0xf101;

src/core/__tests__/config-parser.ts

@@ -34,7 +34,8 @@ const mockConfig = {
     scss: 'scss',
     html: 'html'
   },
-  getIconId: DEFAULT_OPTIONS.getIconId
+  getIconId: DEFAULT_OPTIONS.getIconId,
+  addLigatures: false
 };
 
 const testError = async (options: object, key: string, message: string) =>

src/core/config-parser.ts

@@ -32,7 +32,8 @@ const CONFIG_VALIDATORS: {
   tag: [parseString],
   prefix: [parseString],
   fontsUrl: [optional(parseString)],
-  getIconId: [optional(parseFunction)]
+  getIconId: [optional(parseFunction)],
+  addLigatures: [optional(parseBoolean)]
 };
 
 export const parseConfig = async (input: object = {}) => {

src/generators/asset-types/__tests__/__snapshots__/svg.ts.snap

@@ -2,4 +2,8 @@
 
 exports[`\`SVG\` font generator passes correctly format options to \`SVGIcons2SVGFontStream\` 1`] = `"processed->content->/root/foo.svg|{\\"name\\":\\"foo\\",\\"unicode\\":[\\"\\\\u0001\\"]}$processed->content->/root/bar.svg|{\\"name\\":\\"bar\\",\\"unicode\\":[\\"\\\\u0001\\"]}$"`;
 
+exports[`\`SVG\` font generator passes correctly format options to \`SVGIcons2SVGFontStream\` with ligatures 1`] = `"processed->content->/root/foo.svg|{\\"name\\":\\"foo\\",\\"unicode\\":[\\"\\\\u0001\\",\\"foo\\"]}$processed->content->/root/bar.svg|{\\"name\\":\\"bar\\",\\"unicode\\":[\\"\\\\u0001\\",\\"bar\\"]}$"`;
+
 exports[`\`SVG\` font generator resolves with the result of the completed \`SVGIcons2SVGFontStream\` 1`] = `"processed->content->/root/foo.svg|{\\"name\\":\\"foo\\",\\"unicode\\":[\\"\\\\u0001\\"]}$processed->content->/root/bar.svg|{\\"name\\":\\"bar\\",\\"unicode\\":[\\"\\\\u0001\\"]}$"`;
+
+exports[`\`SVG\` font generator resolves with the result of the completed \`SVGIcons2SVGFontStream\` with ligatures 1`] = `"processed->content->/root/foo.svg|{\\"name\\":\\"foo\\",\\"unicode\\":[\\"\\\\u0001\\",\\"foo\\"]}$processed->content->/root/bar.svg|{\\"name\\":\\"bar\\",\\"unicode\\":[\\"\\\\u0001\\",\\"bar\\"]}$"`;

src/generators/asset-types/__tests__/svg.ts

@@ -58,6 +58,23 @@ const mockOptions = (svgOptions = { __mock: 'options__' } as any) =>
     }
   } as unknown as FontGeneratorOptions);
 
+const mockOptionsWithLigatures = (
+  svgOptions = { __mock: 'options__' } as any
+) =>
+  ({
+    name: 'foo',
+    fontHeight: 1,
+    descent: 2,
+    normalize: false,
+    formatOptions: { [FontAssetType.SVG]: svgOptions },
+    codepoints: { foo: 1, bar: 1 },
+    assets: {
+      foo: { id: 'foo', absolutePath: '/root/foo.svg' },
+      bar: { id: 'bar', absolutePath: '/root/bar.svg' }
+    },
+    addLigatures: true
+  } as unknown as FontGeneratorOptions);
+
 describe('`SVG` font generator', () => {
   beforeEach(() => {
     SVGIcons2SVGFontStream.mockClear();
@@ -95,4 +112,40 @@ describe('`SVG` font generator', () => {
       normalize: false
     });
   });
+
+  test('resolves with the result of the completed `SVGIcons2SVGFontStream` with ligatures', async () => {
+    const result = await svgGen.generate(mockOptionsWithLigatures(), null);
+
+    expect(SVGIcons2SVGFontStream).toHaveBeenCalledTimes(1);
+    expect(SVGIcons2SVGFontStream).toHaveBeenCalledWith({
+      descent: 2,
+      fontHeight: 1,
+      fontName: 'foo',
+      log: expect.any(Function),
+      normalize: false,
+      __mock: 'options__'
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  test('passes correctly format options to `SVGIcons2SVGFontStream` with ligatures', async () => {
+    const log = () => null;
+    const formatOptions = { descent: 5, fontHeight: 6, log };
+    const result = await svgGen.generate(
+      mockOptionsWithLigatures(formatOptions),
+      null
+    );
+
+    expect(result).toMatchSnapshot();
+
+    expect(SVGIcons2SVGFontStream).toHaveBeenCalledTimes(1);
+    expect(SVGIcons2SVGFontStream).toHaveBeenCalledWith({
+      descent: 5,
+      fontHeight: 6,
+      fontName: 'foo',
+      log,
+      normalize: false
+    });
+  });
 });

src/generators/asset-types/svg.ts

@@ -12,7 +12,8 @@ const generator: FontGenerator<void> = {
     normalize,
     assets,
     codepoints,
-    formatOptions: { svg } = {}
+    formatOptions: { svg } = {},
+    addLigatures
   }) =>
     new Promise(resolve => {
       let font = Buffer.alloc(0);
@@ -31,8 +32,15 @@ const generator: FontGenerator<void> = {
       for (const { id, absolutePath } of Object.values(assets)) {
         const glyph: GglyphStream = createReadStream(absolutePath);
         const unicode = String.fromCharCode(codepoints[id]);
-
-        glyph.metadata = { name: id, unicode: [unicode] };
+        if (addLigatures) {
+          let ligature = '';
+          for (var i = 0; i < id.length; i++) {
+            ligature += String.fromCharCode(id.charCodeAt(i));
+          }
+          glyph.metadata = { name: id, unicode: [unicode, ligature] };
+        } else {
+          glyph.metadata = { name: id, unicode: [unicode] };
+        }
 
         fontStream.write(glyph);
       }

src/types/runner.ts

@@ -24,6 +24,7 @@ export type RunnerOptionalOptions = {
   prefix: string;
   fontsUrl: string;
   getIconId: GetIconIdFn;
+  addLigatures: boolean;
 };
 
 export type RunnerOptionsInput = RunnerMandatoryOptions &