added some examples

.gitignore

@@ -1,4 +1,3 @@
 .nyc_output/
 node_modules/
-yarn.lock
-package-lock.json
+example/results

.prettierrc

@@ -2,5 +2,5 @@
     "tabWidth": 4,
     "useTabs": false,
     "arrowParens": "avoid",
-    "printWidth": 128
+    "printWidth": 100
 }

example/basicUsage.gulpfile.js

@@ -0,0 +1,10 @@
+const gulp = require("gulp");
+const series = gulp.series;
+
+const mammoth = require("../src/index");
+
+function basicUsage() {
+    return gulp.src("./data/nonEmpty.docx").pipe(mammoth("html")).pipe(gulp.dest("./results"));
+}
+
+module.exports.default = series(basicUsage);

example/withGulpIf.gulpfile.js

@@ -0,0 +1,16 @@
+const gulp = require("gulp");
+const gulpIf = require("gulp-if");
+const series = gulp.series;
+
+const mammoth = require("../src/index");
+
+function withGulpIf() {
+    return gulp
+        .src("./data/*")
+        .pipe(gulpIf(file => file.basename.toLowerCase().includes("html"), mammoth("html")))
+        .pipe(gulpIf(file => file.basename.toLowerCase().includes("markdown"), mammoth("md")))
+        .pipe(gulpIf(file => file.basename.toLowerCase().includes("text"), mammoth("txt")))
+        .pipe(gulp.dest("./results"));
+}
+
+module.exports.default = series(withGulpIf);

package.json

@@ -30,6 +30,7 @@
     "devDependencies": {
         "coveralls": "^3.1.0",
         "gulp": "^4.0.2",
+        "gulp-if": "^3.0.0",
         "gulp-spawn-mocha-nyc": "^1.0.0",
         "mocha": "^8.2.0",
         "nyc": "^15.1.0",

src/index.js

@@ -19,7 +19,10 @@ const convertLiterals = {
         return through.obj(async (file, encoding, callback) => {
             if (file.contents === null) callback(null, file);
             else {
-                let { value, messages } = await mammoth.convertToMarkdown({ path: file.path }, options);
+                let { value, messages } = await mammoth.convertToMarkdown(
+                    { path: file.path },
+                    options
+                );
                 file = handleFileContents(file, ".md", value, messages);
                 callback(null, file);
             }
@@ -57,6 +60,7 @@ function handleFileContents(file, ext, value, messages) {
 }
 
 module.exports = function (convertTo, options) {
-    if (!convertLiterals[convertTo.toLowerCase()]) throw new PluginError(PLUGIN_NAME, "Invalid convertion format.");
+    if (!convertLiterals[convertTo.toLowerCase()])
+        throw new PluginError(PLUGIN_NAME, "Invalid convertion format.");
     else return convertLiterals[convertTo.toLowerCase()](options);
 };