diff --git a/.eslintrc b/.eslintrc index 4ed9690..a5503ea 100644 --- a/.eslintrc +++ b/.eslintrc @@ -1,7 +1,7 @@ { "extends": "loopback", "rules": { - "max-len": ["error", 80, 4, { + "max-len": ["error", 90, 4, { "ignoreComments": true, "ignoreUrls": true, "ignorePattern": "^\\s*var\\s.+=\\s*(require\\s*\\()|(/)" diff --git a/index.js b/index.js index c85c5cd..0b65b91 100644 --- a/index.js +++ b/index.js @@ -33,14 +33,14 @@ loopback.version.split('.')[0] || 1; if (loopbackMajor < 2) { - throw new Error('loopback-component-explorer requires loopback 2.0 or newer'); - } + throw new Error('loopback-component-explorer requires loopback 2.0 or newer'); + } options = _defaults({}, options, { - resourcePath: 'swagger.json', - apiInfo: loopbackApplication.get('apiInfo') || {}, - swaggerUI: true, - }); + resourcePath: 'swagger.json', + apiInfo: loopbackApplication.get('apiInfo') || {}, + swaggerUI: true, + }); var router = new loopback.Router(); @@ -51,37 +51,37 @@ router.get('/config.json', function(req, res) { // Get the path we're mounted at. It's best to get this from the referer // in case we're proxied at a deep path. - var source = url.parse(req.headers.referer || '').pathname; + var source = url.parse(req.headers.referer || '').pathname; // If no referer is available, use the incoming url. - if (!source) { - source = req.originalUrl.replace(/\/config.json(\?.*)?$/, ''); - } - res.send({ - url: urlJoin(source, '/' + options.resourcePath), + if (!source) { + source = req.originalUrl.replace(/\/config.json(\?.*)?$/, ''); + } + res.send({ + url: urlJoin(source, '/' + options.resourcePath), + }); }); - }); if (options.swaggerUI) { // Allow specifying a static file roots for swagger files. Any files in // these folders will override those in the swagger-ui distribution. // In this way one could e.g. make changes to index.html without having // to worry about constantly pulling in JS updates. - if (options.uiDirs) { - if (typeof options.uiDirs === 'string') { - router.use(loopback.static(options.uiDirs)); - } else if (Array.isArray(options.uiDirs)) { - options.uiDirs.forEach(function(dir) { - router.use(loopback.static(dir)); - }); + if (options.uiDirs) { + if (typeof options.uiDirs === 'string') { + router.use(loopback.static(options.uiDirs)); + } else if (Array.isArray(options.uiDirs)) { + options.uiDirs.forEach(function(dir) { + router.use(loopback.static(dir)); + }); + } } - } // File in node_modules are overridden by a few customizations - router.use(loopback.static(STATIC_ROOT)); + router.use(loopback.static(STATIC_ROOT)); // Swagger UI distribution - router.use(loopback.static(SWAGGER_UI_ROOT)); - } + router.use(loopback.static(SWAGGER_UI_ROOT)); + } return router; } @@ -101,8 +101,8 @@ // listening to modelRemoted event for updating the swaggerObject // with the newly created model to appear in the Swagger UI. loopbackApplication.on('modelRemoted', function() { - swaggerObject = createSwaggerObject(loopbackApplication, opts); - }); + swaggerObject = createSwaggerObject(loopbackApplication, opts); + }); var resourcePath = opts && opts.resourcePath || 'swagger.json'; if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath; @@ -111,8 +111,8 @@ setupCors(swaggerApp, remotes); swaggerApp.get(resourcePath, function sendSwaggerObject(req, res) { - res.status(200).send(swaggerObject); - }); + res.status(200).send(swaggerObject); + }); } function setupCors(swaggerApp, remotes) { diff --git a/package.json b/package.json index 1cfdd22..60342a1 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,9 @@ "description": "Browse and test your LoopBack app's APIs", "main": "index.js", "scripts": { - "test": "mocha" + "lint": "eslint .", + "test": "mocha", + "posttest": "npm run lint" }, "repository": { "type": "git", diff --git a/public/lib/loadSwaggerUI.js b/public/lib/loadSwaggerUI.js index b1e34b1..aaee90b 100644 --- a/public/lib/loadSwaggerUI.js +++ b/public/lib/loadSwaggerUI.js @@ -17,6 +17,7 @@ $(function() { var accessToken; function loadSwaggerUi(config) { var methodOrder = ['get', 'head', 'options', 'put', 'post', 'delete']; + /* eslint-disable camelcase */ window.swaggerUi = new SwaggerUi({ validatorUrl: null, url: config.url || '/swagger/resources', @@ -58,6 +59,7 @@ $(function() { methodOrder.indexOf(a.method) - methodOrder.indexOf(b.method); }, }); + /* eslint-disable camelcase */ $('#explore').click(setAccessToken); $('#api_selector').submit(setAccessToken); @@ -73,7 +75,8 @@ $(function() { log('key: ' + key); if (key && key.trim() !== '') { log('added accessToken ' + key); - var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization('access_token', key, 'query'); + var apiKeyAuth = + new SwaggerClient.ApiKeyAuthorization('access_token', key, 'query'); window.swaggerUi.api.clientAuthorizations.add('key', apiKeyAuth); accessToken = key; $('.accessTokenDisplay').text('Token Set.').addClass('set'); @@ -83,10 +86,9 @@ $(function() { if (window.localStorage) { window.localStorage.setItem(lsKey, key); } - } - // If submitted with an empty token, remove the current token. Can be - // useful to intentionally remove authorization. - else { + } else { + // If submitted with an empty token, remove the current token. Can be + // useful to intentionally remove authorization. log('removed accessToken.'); $('.accessTokenDisplay').text('Token Not Set.').removeClass('set'); $('.accessTokenDisplay').removeAttr('data-tooltip'); @@ -116,5 +118,3 @@ $(function() { } } }); - - diff --git a/test/explorer.test.js b/test/explorer.test.js index 55de73f..36261e6 100644 --- a/test/explorer.test.js +++ b/test/explorer.test.js @@ -8,7 +8,6 @@ var urlJoin = require('../lib/url-join'); var os = require('os'); describe('explorer', function() { - describe('with default config', function() { beforeEach(givenLoopBackAppWithExplorer());