WIP: More plugins

.gitignore

@@ -14,6 +14,7 @@ pids
 *.pid
 *.seed
 *.pid.lock
+*.sw[op]
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov

README.md

@@ -5,6 +5,9 @@ A multi-package repository of useful Swagger UI plugins maintained by [@shockey]
 ## 👉 Available Plugins
 
 - [`disable-try-it-out-without-servers`](https://github.com/shockey/swagger-ui-plugins/tree/master/packages/disable-try-it-out-without-servers): enter documentation-only mode when OAS 3.0 `servers` is empty or missing
+- [`hide-empty-tags`](https://github.com/shockey/swagger-ui-plugins/tree/master/packages/hide-empty-tags): hide empty tags
+- [`url-mutator`](https://github.com/shockey/swagger-ui-plugins/tree/master/packages/url-mutator): mechanism to override path, basePath and scheme for OpenAPI 2.x definitions
+- [`disable-oas-spec-link`](https://github.com/shockey/swagger-ui-plugins/tree/master/packages/disable-oas-spec-link): prevent the display of the OpenAPI specification URL link
 
 ## Contributing
 
@@ -14,6 +17,10 @@ I will make releases of each plugin when/if your PR is accepted.
 
 Please add yourself to the Contributors list below if you add a new plugin!
 
+You can use the `npm run new-plugin` command to easily generate a new plugin skeleton from boilerplate. This should give you at least a reasonable head start on your plugin in a way that is generally compatible with the conventions in this library.
+
+**One easy way to contribute is to copy over plugins found at https://github.com/swagger-api/swagger-ui/issues/5027#issuecomment-438745785.**
+
 ## Versioning
 
 Each plugin uses [SemVer](http://semver.org/) for versioning. 
@@ -23,6 +30,7 @@ A plugin's version is unrelated to its Swagger UI compatibility: compatible vers
 ## Contributors
 
 * **Kyle Shockey**: *Initial work; plugin maintenance*
+* **Kael Shipman**: *Plugin boilerplate and script; limited ports of other people's plugins from around the web.*
 
 ## Built With
 

package.json

@@ -8,5 +8,8 @@
     "@babel/preset-env": "^7.1.0",
     "babel-plugin-add-module-exports": "^1.0.0",
     "lerna": "^3.4.3"
+  },
+  "scripts": {
+    "new-plugin": "./scripts/new-plugin.sh"
   }
 }

packages/.boilerplate/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "ie": "11"
+        }
+      }
+    ]
+  ]
+}

packages/.boilerplate/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+build
+*.sw[op]

packages/.boilerplate/README.md

@@ -0,0 +1,47 @@
+Swagger UI '{proper-name}' Plugin
+==================================================================
+
+{long-desc}
+
+## Usage
+
+### Require
+
+First, install the module with npm:
+```
+$ npm install --save swagger-ui-plugin-{name-kebab-case}
+```
+
+Next, require it in your client-side application:
+
+```js
+const {name-pascal-case}Plugin = require('swagger-ui-plugin-{name-kebab-case}');
+
+SwaggerUI({
+  // your options here...
+  plugins: [
+    {name-pascal-case}Plugin
+  ]
+})
+```
+
+### `<script>`
+
+```html
+<!-- Load Swagger UI -->
+<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"> </script> 
+<!-- Load the {name-pascal-case} Plugin -->
+<script src="https://unpkg.com/swagger-ui-plugin-{name-kebab-case}"> </script>
+
+<script>
+window.onload = function() {
+  SwaggerUI({
+  // your options here...
+  plugins: [
+    {name-pascal-case}Plugin
+  ]
+})
+}
+</script>
+```
+

packages/.boilerplate/__tests__/swagger-ui-plugin-{name-kebab-case}.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const swaggerUiPlugin{name-pascal-case} = require('..');
+
+describe('swagger-ui-plugin-{name-kebab-case}', () => {
+    it('needs tests');
+});

packages/.boilerplate/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "swagger-ui-plugin-{name-kebab-case}",
+  "version": "1.0.0",
+  "description": "{short-desc}",
+  "author": "{author}",
+  "homepage": "https://github.com/shockey/swagger-ui-plugins#readme",
+  "license": "MIT",
+  "main": "build/index.js",
+  "directories": {
+    "build": "build",
+    "test": "__tests__"
+  },
+  "files": [
+    "build"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shockey/swagger-ui-plugins.git"
+  },
+  "scripts": {
+    "build": "npx babel src -d build",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "bugs": {
+    "url": "https://github.com/shockey/swagger-ui-plugins/issues"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.12.10",
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11"
+  }
+}

packages/.boilerplate/src/index.js

@@ -0,0 +1,56 @@
+// From: https://raw.githubusercontent.com/chilts/umd-template/master/template.js
+; ((f) => {
+  // module name and requires
+  var name = '{name-pascal-case}Plugin';
+  var requires = [];
+
+  // CommonJS
+  if (typeof exports === "object" && typeof module !== "undefined") {
+    module.exports = f.apply(null, requires.map(function (r) { return require(r); }));
+
+    // RequireJS
+  } else if (typeof define === "function" && define.amd) {
+    define(requires, f);
+
+    // <script>
+  } else {
+    var g;
+    if (typeof window !== "undefined") {
+      g = window;
+    } else if (typeof global !== "undefined") {
+      g = global;
+    } else if (typeof self !== "undefined") {
+      g = self;
+    } else {
+      // works providing we're not in "use strict";
+      // needed for Java 8 Nashorn
+      // see https://github.com/facebook/react/issues/3037
+      g = this;
+    }
+    g[name] = f.apply(null, requires.map(function (r) { return g[r]; }));
+  }
+
+})(() => {
+  // Module source
+  return (system) => {
+    return {
+
+
+
+      /**
+       *
+       *
+       *
+       *
+       * Your plugin here
+       *
+       *
+       *
+       *
+       */
+
+
+
+    }
+  };
+});

packages/disable-oas-spec-link/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "ie": "11"
+        }
+      }
+    ]
+  ]
+}

packages/disable-oas-spec-link/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+build
+*.sw[op]

packages/disable-oas-spec-link/README.md

@@ -0,0 +1,48 @@
+Swagger UI 'Disable Oas Spec Link' Plugin
+==================================================================
+
+Prevent the display of the OpenAPI specification URL link.
+
+Original post: https://github.com/swagger-api/swagger-ui/issues/4171
+
+## Usage
+
+### Require
+
+First, install the module with npm:
+```
+$ npm install --save swagger-ui-plugin-disable-oas-spec-link
+```
+
+Next, require it in your client-side application:
+
+```js
+const DisableOasSpecLinkPlugin = require('swagger-ui-plugin-disable-oas-spec-link');
+
+SwaggerUI({
+  // your options here...
+  plugins: [
+    DisableOasSpecLinkPlugin
+  ]
+})
+```
+
+### `<script>`
+
+```html
+<!-- Load Swagger UI -->
+<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"> </script> 
+<!-- Load the DisableOasSpecLink Plugin -->
+<script src="https://unpkg.com/swagger-ui-plugin-disable-oas-spec-link"> </script>
+
+<script>
+window.onload = function() {
+  SwaggerUI({
+    // your options here...
+    plugins: [
+      DisableOasSpecLinkPlugin
+    ]
+  })
+}
+</script>
+```

packages/disable-oas-spec-link/__tests__/swagger-ui-plugin-disable-oas-spec-link.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const swaggerUiPluginDisableOasSpecLink = require('..');
+
+describe('swagger-ui-plugin-disable-oas-spec-link', () => {
+    it('needs tests');
+});

packages/disable-oas-spec-link/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "swagger-ui-plugin-disable-oas-spec-link",
+  "version": "1.0.0",
+  "description": "prevent the display of the OpenAPI specification URL link",
+  "author": "Mike Fidel @mikefidel",
+  "homepage": "https://github.com/shockey/swagger-ui-plugins#readme",
+  "license": "MIT",
+  "main": "build/index.js",
+  "directories": {
+    "build": "build",
+    "test": "__tests__"
+  },
+  "files": [
+    "build"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shockey/swagger-ui-plugins.git"
+  },
+  "scripts": {
+    "build": "npx babel src -d build",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "bugs": {
+    "url": "https://github.com/shockey/swagger-ui-plugins/issues"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.12.10",
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11"
+  }
+}

packages/disable-oas-spec-link/src/index.js

@@ -0,0 +1,43 @@
+// From: https://raw.githubusercontent.com/chilts/umd-template/master/template.js
+; ((f) => {
+  // module name and requires
+  var name = 'DisableOasSpecLinkPlugin';
+  var requires = [];
+
+  // CommonJS
+  if (typeof exports === "object" && typeof module !== "undefined") {
+    module.exports = f.apply(null, requires.map(function (r) { return require(r); }));
+
+    // RequireJS
+  } else if (typeof define === "function" && define.amd) {
+    define(requires, f);
+
+    // <script>
+  } else {
+    var g;
+    if (typeof window !== "undefined") {
+      g = window;
+    } else if (typeof global !== "undefined") {
+      g = global;
+    } else if (typeof self !== "undefined") {
+      g = self;
+    } else {
+      // works providing we're not in "use strict";
+      // needed for Java 8 Nashorn
+      // see https://github.com/facebook/react/issues/3037
+      g = this;
+    }
+    g[name] = f.apply(null, requires.map(function (r) { return g[r]; }));
+  }
+
+})(() => {
+  // Module source
+  return (system) => {
+    return {
+			wrapComponents: {
+				InfoUrl: () => () => null,
+				InfoBasePath: () => () => null, // this hides the `Base Url` part too, if you want that
+			}
+    }
+  };
+});

packages/hide-empty-tags/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "ie": "11"
+        }
+      }
+    ]
+  ]
+}

packages/hide-empty-tags/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+build
+*.sw[op]