Weight help items

Author: gkoberger

lib/endpoint.js

@@ -0,0 +1,32 @@
+var colors = require('colors');
+var utils = require('../utils');
+
+exports.swagger = false;
+exports.login = false;
+exports.category = "basic";
+exports.desc = "Learn how to document an endpoint";
+exports.weight = 3;
+
+exports.run = function(config, info) {
+  console.log("You can document each endpoint right above the code. Just use the");
+  console.log("following syntax in a comment above the code:");
+  console.log("");
+
+  console.log(utils.swaggerInlineExample(utils.guessLanguage()));
+
+  console.log('');
+  console.log('Param shorthand: '.blue + 'Since params are very verbose, we have a shorthand');
+  console.log('for describing them.');
+
+  console.log('');
+  console.log('  - (in) name=default* {type:format} description'.grey);
+  console.log('');
+
+  console.log("This will be expanded when the Swagger file is compiled.");
+
+  console.log('');
+  console.log('For more information on this syntax, see https://github.com/readmeio/swagger-inline');
+
+  process.exit();
+};
+

lib/help.js

@@ -6,6 +6,7 @@ exports.swagger = false;
 exports.login = false;
 exports.category = "basic";
 exports.desc = "Learn what you can do with oai";
+exports.weight = 2;
 
 exports.run = function(config, info) {
   console.log("");
@@ -33,15 +34,18 @@ exports.run = function(config, info) {
     var info = f.desc || "";
 
     if(f.category) {
-     categories[f.category].commands.push("  $".grey + pad(" oai " + action) + " " + info.grey);
+      categories[f.category].commands.push({
+        text: "  $".grey + pad(" oai " + action) + " " + info.grey,
+        weight: f.weight,
+      });
     }
   });
 
   _.each(categories, function(category) {
     console.log("");
     console.log(category.desc);
-    _.each(category.commands, function(command) {
-      console.log(command);
+    _.each(_.sortBy(category.commands, 'weight'), function(command) {
+      console.log(command.text);
     });
   });
 

lib/init.js

@@ -10,6 +10,7 @@ exports.swagger = false;
 exports.login = false;
 exports.category = "basic";
 exports.desc = "Create a new API specification";
+exports.weight = 0;
 
 var types = [
   { "name": "application/json", "checked": true },