Merge pull request #299 from dzhuang/warn_underscore

Warn user when using "_" instead of "-" in iconNames
closes #298

src/providers/base.ts

@@ -179,10 +179,20 @@ export abstract class ProviderConstructor implements ProviderInterface {
   }
 
   private validateIconMeta(iconName: SubsetItem): MetaData {
-    if (typeof this.allMetaData[iconName] === 'undefined')
+    if (typeof this.allMetaData[iconName] === 'undefined') {
+      if (iconName.includes('_')) {
+        const alterIconName = iconName.replace(/_/g, '-');
+        if ('undefined' !== typeof this.allMetaData[alterIconName]) {
+          throw new WarningError(
+            `"${iconName}" does not exists in metadata available, ` +
+            `do you mean "${alterIconName}" instead?`
+          );
+        }
+      }
       throw new WarningError(
         `"${iconName}" does not exists in metadata available.`
       );
+    }
 
     const metaData: MetaData = this.normalizeIconMeta(iconName);
 

tests/combine.mocha.ts

@@ -158,6 +158,31 @@ describe('General tests', () => {
     );
   });
 
+  it('should not work for iconName with "_" instead of "-" as separator', (done) => {
+    // The first will log: do you mean "arrow-left" instead?
+    // the second will log: "icon_does_not_exists" does not exists in metadata available
+    const mdi = new MdiProvider(['arrow_left', 'icon_does_not_exists']);
+
+    generateCombinedSubsetFont(
+      {
+        subset: [mdi],
+      },
+      done,
+
+      // this should generate nothing, we simply check if the css is generated.
+      {
+        cssFileNames: [
+          {
+            names: {
+              nonExist: [COMBINED_CSS_NAME, DEFAULT_COMBINE_FILE_NAME],
+            },
+            extensions: { exist: [] },
+          },
+        ],
+      }
+    );
+  });
+
   it('should not work for mdi when icons not exist were input multiple times', (done) => {
     const mdi = new MdiProvider([
       'icon-does-not-exists',