feat: Add typechecks

Author: jantimon

index.js

@@ -2,7 +2,19 @@
 'use strict';
 const assert = require('assert');
 
-module.exports = function IconfontWebpackPlugin (userOptions) {
+/**
+ * The main plugin
+ *
+ * Options:
+ * @param {{
+
+   fontNamePrefix?: string,
+   enforcedSvgHeight?: number,
+   resolve?: any
+
+  }} [userOptions]
+ */
+function IconfontWebpackPlugin (userOptions) {
   // Default options
   const options = Object.assign({
 
@@ -35,4 +47,6 @@ module.exports = function IconfontWebpackPlugin (userOptions) {
 
   // Call postcss plugin
   return require('./lib/postcss-plugin')(options);
-};
+}
+
+module.exports = IconfontWebpackPlugin;

lib/icons-to-woff.js

@@ -22,7 +22,7 @@ module.exports = function createIconFont (fs, icons, options) {
       normalize: true,
       fontHeight: options.enforcedSvgHeight ? options.enforcedSvgHeight : undefined,
       log: function () {},
-      error: function (err) {
+      error: /** @param {any} err */function (err) {
         reject(err);
       }
     });

lib/postcss-plugin.js

@@ -43,7 +43,7 @@ function parseFontIconValue (value) {
  * Returns a promise with the result of all `icon-font:url(...)` svg paths of the given file
  *
  * @param postCssRoot {postcss.Root} The name of the font (font-family)
- * @param webpackResolve {function} The webpack resolve helper
+ * @param webpackResolve {(context: string, path: string, callback: (err: any, result: string) => void) => void} The webpack resolve helper
  * @param context {string} The css loader path context to resolve relative urls
  *
  * @returns {Promise<{resolved: string[], unresolved: string[], relative: string[]}>}
@@ -85,7 +85,7 @@ function getSvgPaths (postCssRoot, webpackResolve, context) {
 
 /**
  * @param fontName {string} The name of the font (font-family)
- * @param postCssRoot {object} The postCss root object
+ * @param postCssRoot {postcss.Root} The postCss root object
  * @param svgPaths {object} The svg path information
  */
 function replaceIconFontDeclarations (fontName, postCssRoot, svgPaths) {
@@ -170,10 +170,14 @@ function addFontDeclaration (fontName, postCssRoot, enforcedSvgHeight, svgPaths)
  * PostCSS Plugin factory
  */
 module.exports = postcss.plugin('iconfont-webpack', config => function (root, result) {
+  /* istanbul ignore if: Skip processing empty results */
+  if (!result || !result.opts || !result.opts.from) {
+    return;
+  }
   const cssFilename = result.opts.from;
   const context = path.dirname(cssFilename);
   return getSvgPaths(root, config.resolve, context)
-    .then(function (svgPaths) {
+    .then(/** @returns {any} */function (svgPaths) {
       // Stop if the css file contains no `font-icon:url('..');` declarations
       if (svgPaths.resolved.length === 0) {
         return;

package.json

@@ -19,6 +19,7 @@
     "test": "ava -v",
     "posttest": "npm-run-all posttest:*",
     "posttest:semistandard": "semistandard",
+    "posttest:typecheck": "tsc",
     "posttest:coverage": "nyc ava",
     "posttest:coverage-report": "nyc report --reporter=html",
     "posttest:coverage-check": "nyc check-coverage --lines 100 --functions 100 --branches 100"
@@ -40,6 +41,7 @@
   },
   "homepage": "https://github.com/jantimon/iconfont-webpack-plugin",
   "devDependencies": {
+    "@types/node": "12.0.12",
     "ava": "0.25.0",
     "commitizen": "3.1.1",
     "conventional-changelog-cli": "2.0.21",
@@ -52,6 +54,7 @@
     "semistandard": "13.0.1",
     "standard-version": "6.0.1",
     "style-loader": "0.23.1",
+    "typescript": "3.5.2",
     "webpack": "4.33.0",
     "webpack-cli": "3.3.3"
   },

tsconfig.json

@@ -0,0 +1,23 @@
+{
+	"compilerOptions": {
+		"allowJs": true,
+		"noEmit": true,
+		"target": "es6",
+		"lib": ["es6"],
+		"rootDir": "src",
+		"module": "commonjs",
+		"moduleResolution": "node",
+		"strict": true,
+		"declaration": true,
+		"sourceMap": true,
+		"inlineSources": true,
+		"types": ["node"],
+		"maxNodeModuleJsDepth": 2,
+		"skipLibCheck": true
+	},
+	"lib": ["es6", "es7"],
+	"exclude": [
+		"**/node_modules/**/*",
+		"**/test/**/*",
+	]
+}