Clarifying some of the help internals with better property names.

erunion · erunion · commit 842f5213d5f7 · 2019-08-02T22:47:52.000-07:00
diff --git a/cmds/docs/edit.js b/cmds/docs/edit.js
@@ -12,7 +12,7 @@ exports.command = 'docs:edit';
 exports.usage = 'docs:edit <slug> [options]';
 exports.description = 'Edit a single file from your ReadMe project without saving locally.';
 exports.category = 'docs';
-exports.weight = 4;
+exports.position = 2;
 
 exports.hiddenArgs = ['slug'];
 exports.args = [
diff --git a/cmds/docs/index.js b/cmds/docs/index.js
@@ -12,7 +12,7 @@ exports.command = 'docs';
 exports.usage = 'docs <folder> [options]';
 exports.description = 'Sync a folder of markdown files to your ReadMe project.';
 exports.category = 'docs';
-exports.weight = 3;
+exports.position = 1;
 
 exports.hiddenArgs = ['folder'];
 exports.args = [
diff --git a/cmds/login.js b/cmds/login.js
@@ -11,7 +11,7 @@ exports.command = 'login';
 exports.usage = 'login [options]';
 exports.description = 'Login to a ReadMe project.';
 exports.category = 'admin';
-exports.weight = 1;
+exports.position = 1;
 
 exports.args = [
   {
diff --git a/cmds/logout.js b/cmds/logout.js
@@ -6,7 +6,7 @@ exports.command = 'logout';
 exports.usage = 'logout';
 exports.description = 'Logs the currently authenticated user out of ReadMe.';
 exports.category = 'admin';
-exports.weight = 2;
+exports.position = 2;
 
 exports.args = [];
 
diff --git a/cmds/oas.js b/cmds/oas.js
@@ -8,7 +8,7 @@ exports.command = 'oas';
 exports.usage = 'oas';
 exports.description = 'OAS related tasks. See https://npm.im/oas for more information.';
 exports.category = 'utilities';
-exports.weight = 4;
+exports.position = 1;
 
 exports.args = [];
 
diff --git a/cmds/open.js b/cmds/open.js
@@ -7,7 +7,7 @@ exports.command = 'open';
 exports.usage = 'open';
 exports.description = 'Open your current ReadMe project in the browser.';
 exports.category = 'utilities';
-exports.weight = 1;
+exports.position = 2;
 
 exports.args = [];
 
diff --git a/cmds/swagger.js b/cmds/swagger.js
@@ -9,7 +9,7 @@ exports.command = 'swagger';
 exports.usage = 'swagger [file] [options]';
 exports.description = 'Upload, or sync, your Swagger/OpenAPI file to ReadMe.';
 exports.category = 'apis';
-exports.weight = 2;
+exports.position = 1;
 
 exports.hiddenArgs = ['token', 'spec'];
 exports.args = [
diff --git a/cmds/versions/create.js b/cmds/versions/create.js
@@ -7,7 +7,7 @@ exports.command = 'versions:create';
 exports.usage = 'versions:create <version> [options]';
 exports.description = 'Create a new version for your project.';
 exports.category = 'versions';
-exports.weight = 4;
+exports.position = 2;
 
 exports.hiddenArgs = ['version'];
 exports.args = [
diff --git a/cmds/versions/delete.js b/cmds/versions/delete.js
@@ -5,7 +5,7 @@ exports.command = 'versions:delete';
 exports.usage = 'versions:delete <version> [options]';
 exports.description = 'Delete a version associated with your ReadMe project.';
 exports.category = 'versions';
-exports.weight = 4;
+exports.position = 4;
 
 exports.hiddenArgs = ['version'];
 exports.args = [
diff --git a/cmds/versions/index.js b/cmds/versions/index.js
@@ -8,7 +8,7 @@ exports.usage = 'versions [options]';
 exports.description =
   'List versions available in your project or get a version by SemVer (https://semver.org/).';
 exports.category = 'versions';
-exports.weight = 3;
+exports.position = 1;
 
 exports.args = [
   {
diff --git a/cmds/versions/update.js b/cmds/versions/update.js
@@ -7,7 +7,7 @@ exports.command = 'versions:update';
 exports.usage = 'versions:update <version> [options]';
 exports.description = 'Update an existing version for your project.';
 exports.category = 'versions';
-exports.weight = 4;
+exports.position = 3;
 
 exports.args = [
   {
diff --git a/cmds/whoami.js b/cmds/whoami.js
@@ -6,7 +6,7 @@ exports.command = 'whoami';
 exports.usage = 'whoami';
 exports.description = 'Displays the current user and project authenticated with ReadMe.';
 exports.category = 'admin';
-exports.weight = 3;
+exports.position = 3;
 
 exports.args = [];
 
diff --git a/lib/commands.js b/lib/commands.js
@@ -24,7 +24,7 @@ exports.listByCategory = () => {
     categories[c.command.category].commands.push({
       name: c.command.command,
       description: c.command.description,
-      weight: c.command.weight,
+      position: c.command.position,
     });
   });
 
diff --git a/lib/help.js b/lib/help.js
@@ -103,7 +103,7 @@ exports.globalUsage = async args => {
     };
 
     category.commands
-      .sort((a, b) => a.weight > b.weight)
+      .sort((a, b) => a.position > b.position)
       .forEach(command => {
         commandCategory.content.push({
           command: styleCommand(command),
diff --git a/test/lib/commands.test.js b/test/lib/commands.test.js
@@ -35,8 +35,8 @@ describe('utils', () => {
           );
 
           assert.ok(
-            typeof cmd.weight === 'number' && cmd.usage.weight !== 0,
-            `${file} does not have a weight`,
+            typeof cmd.position === 'number' && cmd.usage.position !== 0,
+            `${file} does not have a position`,
           );
 
           assert.ok(Array.isArray(cmd.args), `${file} does not have an args array defined`);

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ exports.command = 'login';`
`11`	`11`	`exports.usage = 'login [options]';`
`12`	`12`	`exports.description = 'Login to a ReadMe project.';`
`13`	`13`	`exports.category = 'admin';`
`14`		`-exports.weight = 1;`
	`14`	`+exports.position = 1;`
`15`	`15`
`16`	`16`	`exports.args = [`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ exports.usage = 'versions [options]';`
`8`	`8`	`exports.description =`
`9`	`9`	`'List versions available in your project or get a version by SemVer (https://semver.org/).';`
`10`	`10`	`exports.category = 'versions';`
`11`		`-exports.weight = 3;`
	`11`	`+exports.position = 1;`
`12`	`12`
`13`	`13`	`exports.args = [`
`14`	`14`	`{`