Skip to content
This repository was archived by the owner on Sep 14, 2022. It is now read-only.

update all skeletons to latest versions and fix async test race-condition #489

Merged
merged 5 commits into from
Apr 25, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# IDE files
.idea
.vscode

# Logs
logs
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
language: node_js
node_js:
- "stable"
- "0.12"
- "4"
sudo: false
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Configuration

** NOTE: The following applies to swagger-node apps replying on swagger-node-runner 0.5.x and better. (ie. Any app using swagger-connect 0.1.0, swagger-express-wm 0.1.0, swagger-hapi 0.1.0, swagger-restify 0.1.0, or swagger-sails 0.1.0 - or higher versions of the same.) **
** NOTE: The following applies to swagger-node apps replying on swagger-node-runner 0.5.x and better. (ie. Any app using swagger-connect 0.1.0, swagger-express-mw 0.1.0, swagger-hapi 0.1.0, swagger-restify 0.1.0, or swagger-sails 0.1.0 - or higher versions of the same.) **

Swagger-Node application configuration is driven by the file `default.yaml` (by default) in the application's config directory. Configuration is driven by the [config](https://github.com/lorenwest/node-config/wiki/Configuration-Files) module, so reference its documentation to understand how you may set up configuration per environment and perform configuration overrides. By default, the configuration file looks something like this:

Expand Down
32 changes: 17 additions & 15 deletions project-skeletons/connect/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,24 @@

var SwaggerConnect = require('swagger-connect');
var app = require('connect')();
module.exports = app; // for testing
// export setup Promis for testing
module.exports = new Promise(function (resolve, reject) {
var config = {
appRoot: __dirname // required config
};

var config = {
appRoot: __dirname // required config
};
SwaggerConnect.create(config, function (err, swaggerConnect) {
if (err) { throw err; }

SwaggerConnect.create(config, function(err, swaggerConnect) {
if (err) { throw err; }
// install middleware
swaggerConnect.register(app);

// install middleware
swaggerConnect.register(app);
var port = process.env.PORT || 10010;
app.listen(port);

var port = process.env.PORT || 10010;
app.listen(port);

if (swaggerConnect.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
});
if (swaggerConnect.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
resolve(app);
});
});
1 change: 1 addition & 0 deletions project-skeletons/connect/config/default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ swagger:
swagger_controllers:
- onError: json_error_handler
- cors
- swagger_params_parser
- swagger_security
- _swagger_validate
- express_compatibility
Expand Down
8 changes: 4 additions & 4 deletions project-skeletons/connect/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"license": "",
"main": "app.js",
"dependencies": {
"connect": "^3.3.5",
"swagger-connect": "^0.1.0"
"connect": "^3.6.0",
"swagger-connect": "^0.7.0"
},
"devDependencies": {
"should": "^7.1.0",
"supertest": "^1.0.0"
"should": "^11.2.1",
"supertest": "^3.0.0"
},
"scripts": {
"start": "node app.js",
Expand Down
33 changes: 18 additions & 15 deletions project-skeletons/express/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@

var SwaggerExpress = require('swagger-express-mw');
var app = require('express')();
module.exports = app; // for testing
// export setup Promis for testing
module.exports = new Promise(function (resolve, reject) {

var config = {
appRoot: __dirname // required config
};
var config = {
appRoot: __dirname // required config
};

SwaggerExpress.create(config, function(err, swaggerExpress) {
if (err) { throw err; }
SwaggerExpress.create(config, function (err, swaggerExpress) {
if (err) { throw err; }

// install middleware
swaggerExpress.register(app);
// install middleware
swaggerExpress.register(app);

var port = process.env.PORT || 10010;
app.listen(port);

if (swaggerExpress.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
});
var port = process.env.PORT || 10010;
app.listen(port, function() {
if (swaggerExpress.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
resolve(app);
});
});
});
8 changes: 4 additions & 4 deletions project-skeletons/express/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"license": "",
"main": "app.js",
"dependencies": {
"express": "^4.12.3",
"swagger-express-mw": "^0.1.0"
"express": "^4.15.2",
"swagger-express-mw": "^0.7.0"
},
"devDependencies": {
"should": "^7.1.0",
"supertest": "^1.0.0"
"should": "^11.2.1",
"supertest": "^3.0.0"
},
"scripts": {
"start": "node app.js",
Expand Down
38 changes: 22 additions & 16 deletions project-skeletons/hapi/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@ var SwaggerHapi = require('swagger-hapi');
var Hapi = require('hapi');
var app = new Hapi.Server();

module.exports = app; // for testing
// export setup Promis for testing
module.exports = new Promise(function (resolve, reject) {

var config = {
appRoot: __dirname // required config
};
var config = {
appRoot: __dirname // required config
};

SwaggerHapi.create(config, function(err, swaggerHapi) {
if (err) { throw err; }
SwaggerHapi.create(config, function (err, swaggerHapi) {
if (err) { throw err; }

var port = process.env.PORT || 10010;
app.connection({ port: port });
app.address = function() {
return { port: port };
};
var port = process.env.PORT || 10010;
app.connection({ port: port });
app.address = function () {
return { port: port };
};

app.register(swaggerHapi.plugin, function(err) {
if (err) { return console.error('Failed to load plugin:', err); }
app.start(function() {
if (swaggerHapi.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
app.register(swaggerHapi.plugin, function (err) {
if (err) {
console.error('Failed to load plugin:', err);
reject(err);
}
app.start(function () {
if (swaggerHapi.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
resolve(app);
});
});
});
});
8 changes: 4 additions & 4 deletions project-skeletons/hapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"license": "",
"main": "app.js",
"dependencies": {
"hapi": "^10.0.0",
"swagger-hapi": "^0.1.0"
"hapi": "^16.1.1",
"swagger-hapi": "^0.7.0"
},
"devDependencies": {
"should": "^7.1.0",
"supertest": "^1.0.0"
"should": "^11.2.1",
"supertest": "^3.0.0"
},
"scripts": {
"start": "node app.js",
Expand Down
31 changes: 17 additions & 14 deletions project-skeletons/restify/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,24 @@ var SwaggerRestify = require('swagger-restify-mw');
var restify = require('restify');
var app = restify.createServer();

module.exports = app; // for testing
// export setup Promis for testing
module.exports = new Promise(function (resolve, reject) {

var config = {
appRoot: __dirname // required config
};
var config = {
appRoot: __dirname // required config
};

SwaggerRestify.create(config, function(err, swaggerRestify) {
if (err) { throw err; }
SwaggerRestify.create(config, function (err, swaggerRestify) {
if (err) { throw err; }

swaggerRestify.register(app);
swaggerRestify.register(app);

var port = process.env.PORT || 10010;
app.listen(port);

if (swaggerRestify.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
});
var port = process.env.PORT || 10010;
app.listen(port, function () {
if (swaggerRestify.runner.swagger.paths['/hello']) {
console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott');
}
resolve(app);
});
});
});
8 changes: 4 additions & 4 deletions project-skeletons/restify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"license": "",
"main": "app.js",
"dependencies": {
"restify": "^4.0.2",
"swagger-restify-mw": "^0.1.0"
"restify": "^4.3.0",
"swagger-restify-mw": "^0.7.0"
},
"devDependencies": {
"should": "^7.1.0",
"supertest": "^1.0.0"
"should": "^11.2.1",
"supertest": "^3.0.0"
},
"scripts": {
"start": "node app.js",
Expand Down
10 changes: 10 additions & 0 deletions project-skeletons/sails/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
Loading