webpack improvements, refs Mermade#122

pupadhyaya14 · Jan 10, 2019 · 5011576 · 5011576
1 parent 06b20a6
commit 5011576
Show file tree

Hide file tree

Showing 15 changed files with 125 additions and 30 deletions.
diff --git a/docs/browser.md b/docs/browser.md
@@ -4,22 +4,36 @@
 
 Many thanks to @RomanGotsiy for getting these sizes down somewhat.
 Further size reductions were made by replacing `js-yaml` with `yaml` and
-forcing `webpack` to deduplicate across packages.
+forcing `webpack` to deduplicate across packages, inspired by @mrin9.
 
 ```shell
 $ npm run webpack
 $ ls -lh dist
-total 568K
--rw-r--r-- 1 mike mike  42K Jan  6 21:21 converter.min.js
--rw-r--r-- 1 mike mike 5.0K Jan  6 21:21 linter.min.js
--rw-r--r-- 1 mike mike  13K Jan  6 21:21 resolver.min.js
--rw-r--r-- 1 mike mike  82K Jan  6 21:21 validator.min.js
--rw-r--r-- 1 mike mike 412K Jan  6 21:21 vendor.min.js
--rw-r--r-- 1 mike mike 2.5K Jan  6 21:21 walker.min.js
+total 564K
+-rw-r--r-- 1 mike mike  42K Jan  7 10:09 converter.min.js
+-rw-r--r-- 1 mike mike 5.0K Jan  7 10:09 linter.min.js
+-rw-r--r-- 1 mike mike 406K Jan  7 10:09 oas-lib.min.js
+-rw-r--r-- 1 mike mike  13K Jan  7 10:09 resolver.min.js
+-rw-r--r-- 1 mike mike  82K Jan  7 10:09 validator.min.js
+-rw-r--r-- 1 mike mike 2.5K Jan  7 10:09 walker.min.js
 ```
 
 The whole suite is therefore around 149K gzipped.
 
+The converter only is:
+
+```shell
+-rw-r--r-- 1 mike mike 172K Jan  7 09:41 dist/converter-lib.min.js
+-rw-r--r-- 1 mike mike  42K Jan  7 09:41 dist/converterOnly.min.js
+```
+
+And the validator only is:
+
+```shell
+-rw-r--r-- 1 mike mike 359K Jan  7 09:40 dist/validator-lib.min.js
+-rw-r--r-- 1 mike mike  82K Jan  7 09:40 dist/validatorOnly.min.js
+```
+
 ## Browserify
 
 Please see [api-spec-converter](https://github.com/LucyBot-Inc/api-spec-converter/) for setup or to use this [bundle](https://github.com/LucyBot-Inc/api-spec-converter/blob/master/dist/api-spec-converter.js).

diff --git a/package.json b/package.json
@@ -25,6 +25,8 @@
   "scripts": {
     "test": "npx mocha",
     "webpack": "npx webpack -p",
+    "webpack-converter": "npx webpack -p --config webpack.converter.js",
+    "webpack-validator": "npx webpack -p --config webpack.validator.js",
     "changelog": "npx conventional-changelog -p angular -i CHANGELOG.md -s",
     "audits": "npx lerna exec npm audit",
     "postinstall": "echo If you need Linode hosting, the oas-kit referral code: \"https://www.linode.com/?r=5734be467cc501b23267cf66d451bc339042ddfa\""

diff --git a/packages/oas-linter/index.js b/packages/oas-linter/index.js
@@ -238,12 +238,11 @@ function lint(objectName,object,key,options) {
     options.warnings = options.warnings.concat(results);
 }
 
-loadRules(path.join(__dirname,'rules.yaml'));
-
 module.exports = {
     lint : lint,
     loadRules : loadRules,
     applyRules : applyRules,
-    getRules : function() { return { rules: rules }; }
+    loadDefaultRules : function() { return loadRules(path.join(__dirname,'rules.yaml')) },
+    getRules : function() { return { rules }; }
 };
 
diff --git a/packages/oas-resolver/index.js b/packages/oas-resolver/index.js
@@ -3,7 +3,6 @@
 const fs = require('fs');
 const path = require('path');
 const url = require('url');
-const util = require('util');
 
 const fetch = require('node-fetch-h2');
 const yaml = require('yaml');

diff --git a/packages/oas-validator/index.js b/packages/oas-validator/index.js
@@ -4,7 +4,6 @@
 const fs = require('fs');
 const url = require('url');
 const URL = url.URL;
-const util = require('util');
 
 const yaml = require('yaml');
 const should = require('should/as-function');
@@ -101,7 +100,7 @@ function validateSchema(schema, openapi, options) {
             const errorStr = bae(schema, openapi, errors);
             throw (new CLIError(errorStr));
         }
-        throw (new JSONSchemaError('Schema invalid: ' + util.inspect(errors)));
+        throw (new JSONSchemaError('Schema invalid:\n'+ yaml.stringfy(errors)));
     }
     options.schema = schema;
     return !(errors && errors.length);
@@ -1372,7 +1371,10 @@ function setupOptions(options,openapi) {
     options.operationIds = [];
     options.allScopes = {};
     options.openapi = openapi;
-    if (options.lint && !options.linter) options.linter = linter.lint;
+    if (options.lint && !options.linter) {
+        options.linter = linter.lint;
+        linter.loadDefaultRules();
+    }
     if (!options.cache) options.cache = {};
     options.schema = openapi3Schema;
 }

diff --git a/packages/reftools/api/testapi.js b/packages/reftools/api/testapi.js
@@ -1,4 +1,3 @@
-const util = require('util');
 const fs = require('fs');
 const yaml = require('yaml');
 

diff --git a/packages/reftools/lib/dereference.js b/packages/reftools/lib/dereference.js
@@ -1,7 +1,5 @@
 'use strict';
 
-const util = require('util');
-
 const recurse = require('./recurse.js').recurse;
 const clone = require('./clone.js').shallowClone;
 const jptr = require('./jptr.js').jptr;
@@ -68,7 +66,6 @@ function dereference(o,definitions,options) {
                 options.cache[$ref] = entry;
                 entry.data = state.parent[state.pkey] = dereference(jptr(entry.source,entry.key),entry.source,options);
                 if ((options.$ref) && (typeof state.parent[state.pkey] === 'object')) state.parent[state.pkey][options.$ref] = $ref;
-                logger.warn(util.inspect(state.parent[state.pkey]));
                 entry.resolved = true;
             }
             else {
@@ -86,7 +83,6 @@ function dereference(o,definitions,options) {
                 else {
                     // we're dealing with a circular reference here
                     logger.warn('Unresolved ref');
-                    logger.warn(util.inspect(entry));
                     state.parent[state.pkey] = jptr(entry.source,entry.path);
                     if (state.parent[state.pkey] === false) {
                         state.parent[state.pkey] = jptr(entry.source,entry.key);

diff --git a/packages/reftools/lib/toposort.js b/packages/reftools/lib/toposort.js
@@ -8,7 +8,6 @@
 * removed dependency on underscore, MER
 */
 
-const util = require('util');
 const recurse = require('./recurse.js').recurse;
 const isRef = require('./isref.js').isRef;
 

diff --git a/packages/swagger2openapi/index.js b/packages/swagger2openapi/index.js
@@ -4,7 +4,6 @@
 const fs = require('fs');
 const url = require('url');
 const pathlib = require('path');
-const util = require('util');
 
 const maybe = require('call-me-maybe');
 const fetch = require('node-fetch-h2');
@@ -749,7 +748,6 @@ function processParameter(param, op, path, index, openapi, options) {
                 param.required = true;
             }
             else {
-                console.warn(util.inspect(param));
                 throwError('(Patchable) path parameters must be required:true ['+param.name+' in '+index+']', options);
             }
         }

diff --git a/packages/swagger2openapi/oas-resolve.js b/packages/swagger2openapi/oas-resolve.js
@@ -3,7 +3,6 @@
 'use strict';
 
 const fs = require('fs');
-const util = require('util');
 
 const yaml = require('yaml');
 const fetch = require('node-fetch-h2');

diff --git a/packages/swagger2openapi/oas-validate.js b/packages/swagger2openapi/oas-validate.js
@@ -5,7 +5,6 @@
 
 const fs = require('fs');
 const path = require('path');
-const util = require('util');
 const readfiles = require('node-readfiles');
 const should = require('should/as-function');
 const yaml = require('yaml');
@@ -325,7 +324,7 @@ function processPathSpec(pathspec, expectFailure) {
     }
     else {
         readfiles(pathspec, { readContents: false, filenameFormat: readfiles.FULL_PATH }, function (err) {
-            if (err) console.log(util.inspect(err));
+            if (err) console.log(yaml.stringify(err));
         })
         .then(files => {
             files = files.sort();
@@ -335,7 +334,6 @@ function processPathSpec(pathspec, expectFailure) {
             genStackNext();
         })
         .catch(err => {
-            //console.log(util.inspect(err));
             handleResult(err,options);
         });
     }

diff --git a/packages/swagger2openapi/swagger2openapi.js b/packages/swagger2openapi/swagger2openapi.js
@@ -5,7 +5,6 @@
 
 const fs = require('fs');
 const url = require('url');
-const util = require('util');
 
 const yaml = require('yaml');
 const converter = require('./index.js');
@@ -69,7 +68,7 @@ let argv = require('yargs')
 function processResult(err, options) {
     if (err) {
         delete err.options;
-        console.warn(util.inspect(err));
+        console.warn(yaml.stringify(err));
         return process.exitCode = 1;
     }
     if (options.yaml && options.outfile && options.outfile.indexOf('.json') > 0) {

diff --git a/webpack.config.js b/webpack.config.js
@@ -32,7 +32,7 @@ module.exports = {
             cacheGroups: {
                 commons: {
                     test: /[\\/]node_modules[\\/]/,
-                    name: 'vendor',
+                    name: 'oas-lib',
                     chunks: 'all'
                 }
             }

diff --git a/webpack.converter.js b/webpack.converter.js
@@ -0,0 +1,41 @@
+'use strict';
+
+const webpack = require('webpack');
+const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
+
+module.exports = {
+    mode: 'production',
+    performance: { hints: false },
+    plugins: [
+      new BundleAnalyzerPlugin(),
+      new webpack.NormalModuleReplacementPlugin(/node_modules.yaml/, resource => {
+        const components = resource.request.split('/');
+        for (let i=0;i<components.length;i++) {
+            if (components[i].startsWith('oas-')) {
+                components[i] = 'swagger2openapi';
+            }
+        }
+		resource.request = components.join('/');
+      })
+    ],
+    optimization: {
+        splitChunks: {
+            cacheGroups: {
+                commons: {
+                    test: /[\\/]node_modules[\\/]/,
+                    name: 'converter-lib',
+                    chunks: 'all'
+                }
+            }
+        }
+    },
+    node: {
+        fs: 'empty'
+    },
+    entry: {
+        converterOnly: './packages/swagger2openapi/index.js'
+    },
+    output: {
+        filename: '[name].min.js'
+    }
+};
diff --git a/webpack.validator.js b/webpack.validator.js
@@ -0,0 +1,50 @@
+'use strict';
+
+const webpack = require('webpack');
+const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
+
+module.exports = {
+    mode: 'production',
+    performance: { hints: false },
+    plugins: [
+      new BundleAnalyzerPlugin(),
+      new webpack.NormalModuleReplacementPlugin(/node_modules.should/, resource => {
+        const components = resource.request.split('/');
+        for (let i=0;i<components.length;i++) {
+            if (components[i].match(/^oas-[rl]/)) {
+                components[i] = 'oas-validator';
+            }
+        }
+		resource.request = components.join('/');
+      }),
+      new webpack.NormalModuleReplacementPlugin(/node_modules.yaml/, resource => {
+        const components = resource.request.split('/');
+        for (let i=0;i<components.length;i++) {
+            if (components[i].match(/^oas-[rl]/)) {
+                components[i] = 'oas-validator';
+            }
+        }
+		resource.request = components.join('/');
+      })
+    ],
+    optimization: {
+        splitChunks: {
+            cacheGroups: {
+                commons: {
+                    test: /[\\/]node_modules[\\/]/,
+                    name: 'validator-lib',
+                    chunks: 'all'
+                }
+            }
+        }
+    },
+    node: {
+        fs: 'empty'
+    },
+    entry: {
+        validatorOnly: './packages/oas-validator/index.js'
+    },
+    output: {
+        filename: '[name].min.js'
+    }
+};