Add debugging (#68)

* Updating dependencies and adding debug * Minifying code * Updating example * Cleaning up spelling * Minfying and adding documentation * fixing export.default bug Co-authored-by: Sean Thomas Burke <[email protected]>
seantomburke · Nov 25, 2020 · 33ba57d · 33ba57d
1 parent 3b3d480
commit 33ba57d
Show file tree

Hide file tree

Showing 16 changed files with 3,235 additions and 1,707 deletions.
diff --git a/babel.config.js b/babel.config.js
@@ -1,11 +1,27 @@
 module.exports = (api) => {
   api.cache(true);
 
-  const presets = ['@babel/preset-env'];
-  const plugins = [[ 'add-module-exports', { 'addDefaultProperty': true }]];
+  const presets = [
+    [
+      '@babel/preset-env',
+      {
+        "targets": {
+          "esmodules": true
+        }
+      }
+    ],
+    'minify', // minify the Babel code
+  ];
+  const plugins = [
+    [
+      'add-module-exports',
+      { 'addDefaultProperty': true },
+    ]
+  ];
 
   return {
     presets,
     plugins,
+    comments: false, // Remove comments during minification
   };
 };
diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,25 @@
+{
+    "version": "0.1",
+    "language": "en",
+    "dictionaries": [
+        "bash",
+        "entities",
+        "filetypes",
+        "fullstack",
+        "html",
+        "html-symbol-entities",
+        "misc",
+        "node",
+        "softwareTerms"
+    ],
+    "words": [
+        "sitemapper",
+        "esmodules"
+    ],
+    "allowCompoundWords": true,
+    "flagWords": [],
+    "ignoreWords": [],
+    "ignorePaths": [
+      "node_modules/"
+    ]
+}
diff --git a/docs.md b/docs.md
@@ -53,7 +53,7 @@ Type: [Array][29]&lt;[String][30]>
 ```javascript
 [
   'www.google.com',
-  'www.linkedin.com'
+  'https://www.linkedin.com'
 ]
 ```
 
@@ -72,10 +72,10 @@ Type: [Object][31]
 
 ```javascript
 {
-  url: 'linkedin.com/sitemap.xml',
+  url: 'https://linkedin.com/sitemap.xml',
   sites: [
-    'linkedin.com/project1',
-    'linkedin.com/project2'
+    'https://linkedin.com/project1',
+    'https://linkedin.com/project2'
   ]
 }
 ```
@@ -102,11 +102,11 @@ Type: [Object][31]
 {
   error: "There was an error!"
   data: {
-    url: 'linkedin.com',
+    url: 'https://linkedin.com',
     urlset: [{
-      url: 'www.linkedin.com/project1'
+      url: 'https://www.linkedin.com/project1'
     },[{
-      url: 'www.linkedin.com/project2'
+      url: 'https://www.linkedin.com/project2'
     }]
   }
 }

diff --git a/example.es6.js b/example.es6.js
@@ -4,6 +4,7 @@ const sitemapper = new Sitemapper();
 
 const Google = new Sitemapper({
   url: 'https://www.google.com/work/sitemap.xml',
+  debug: false,
   timeout: 15000, // 15 seconds
 });
 

diff --git a/example.js b/example.js
@@ -3,6 +3,7 @@ var Sitemapper = require('sitemapper');
 // Instantiate an instance with options
 var Google = new Sitemapper({
   url: 'https://www.google.com/work/sitemap.xml',
+  debug: false,
   timeout: 15000 //15 seconds
 });