Move topics subcommand to repos

To align with how the GitHub API is organised

Author: taktran

src/commands/topics.js src/commands/repos.js

@@ -2,9 +2,9 @@
  * This project follows the example provided in the Yargs documentation for command hierarchy and directory structure.
  * @see: https://github.com/yargs/yargs/blob/master/docs/advanced.md#commanddirdirectory-opts
  */
-exports.command = 'topics <subcommand> [...options]'
-exports.desc = 'Manage GitHub topics'
+exports.command = 'repos <subcommand> [...options]'
+exports.desc = 'Manage GitHub repositories'
 exports.builder = function(yargs) {
-	return yargs.commandDir('topics')
+	return yargs.commandDir('repos')
 }
 exports.handler = function() {}

src/commands/topics/add.js src/commands/repos/add-topics.js

@@ -4,7 +4,7 @@
  * const result = await octokit.repos.replaceTopics()
  */
 const flow = require('lodash.flow')
-const { withGitHubUrl, withTopic } = require('../../lib/common-yargs')
+const { withGitHubUrl, withTopics } = require('../../lib/common-yargs')
 const printOutput = require('../../lib/print-output')
 const { addTopics } = require('../../lib/topics')
 
@@ -18,7 +18,7 @@ const builder = yargs => {
 		withGitHubUrl({
 			describe: 'The URL of the GitHub repository to list the topics of.',
 		}),
-		withTopic({
+		withTopics({
 			required: true,
 		}),
 	])
@@ -32,9 +32,9 @@ const builder = yargs => {
  * @param {string} argv.token
  * @param {string} argv.json
  * @param {object} argv.githubUrl - The GitHub url parsed in the withGitHubUrl() yarg option into appropriate properties, such as `owner` and `repo`.
- * @param {string|array} argv.topic - The topic/s to add
+ * @param {array} argv.topics - The topics to add
  */
-const handler = async ({ token, json, githubUrl, topic: topicsToAdd }) => {
+const handler = async ({ token, json, githubUrl, topics: topicsToAdd }) => {
 	try {
 		const topics = await addTopics({ githubUrl, token, topics: topicsToAdd })
 		if (json) {
@@ -49,7 +49,7 @@ const handler = async ({ token, json, githubUrl, topic: topicsToAdd }) => {
 }
 
 module.exports = {
-	command: 'add <github-url>',
+	command: 'add-topics <github-url>',
 	desc: 'Add topics to a repository.',
 	builder,
 	handler,

src/commands/topics/list.js src/commands/repos/list-topics.js

@@ -46,7 +46,7 @@ const handler = async args => {
 }
 
 module.exports = {
-	command: 'list <github-url>',
+	command: 'list-topics <github-url>',
 	desc: 'List all topics of a repository.',
 	builder,
 	handler,

src/commands/topics/remove.js src/commands/repos/remove-topics.js

@@ -1,10 +1,10 @@
 /**
  * @see: https://octokit.github.io/rest.js/#octokit-routes-repos-replace-topics
- * Add topics to a repository.
+ * Remove topics from a repository.
  * const result = await octokit.repos.replaceTopics()
  */
 const flow = require('lodash.flow')
-const { withGitHubUrl, withTopic } = require('../../lib/common-yargs')
+const { withGitHubUrl, withTopics } = require('../../lib/common-yargs')
 const printOutput = require('../../lib/print-output')
 const { removeTopics } = require('../../lib/topics')
 
@@ -18,25 +18,25 @@ const builder = yargs => {
 		withGitHubUrl({
 			describe: 'The URL of the GitHub repository to list the topics of.',
 		}),
-		withTopic({
+		withTopics({
 			required: true,
 		}),
 	])
 	return baseOptions(yargs).example('github-url', 'Pattern: https://github.com/[owner]/[repository]')
 }
 
 /**
- * Add topics to a repository.
+ * Remove topics from a repository.
  *
  * @param {object} argv - argv parsed and filtered by yargs
  * @param {string} argv.token
  * @param {string} argv.json
  * @param {object} argv.githubUrl - The GitHub url parsed in the withGitHubUrl() yarg option into appropriate properties, such as `owner` and `repo`.
- * @param {string|array} argv.topic - The topic/s to remove
+ * @param {array} argv.topics - The topics to remove
  */
-const handler = async ({ token, json, githubUrl, topic: topicsToAdd }) => {
+const handler = async ({ token, json, githubUrl, topics: topicsToRemove }) => {
 	try {
-		const topics = await removeTopics({ githubUrl, token, topics: topicsToAdd })
+		const topics = await removeTopics({ githubUrl, token, topics: topicsToRemove })
 		if (json) {
 			printOutput({ json, resource: topics })
 		} else {
@@ -49,7 +49,7 @@ const handler = async ({ token, json, githubUrl, topic: topicsToAdd }) => {
 }
 
 module.exports = {
-	command: 'remove <github-url>',
+	command: 'remove-topics <github-url>',
 	desc: 'Remove topics from a repository.',
 	builder,
 	handler,

src/lib/common-yargs.js

@@ -180,15 +180,15 @@ const withGitHubUrl = options => yargs => {
 	)
 }
 
-const withTopic = options => yargs => {
+const withTopics = options => yargs => {
 	return yargs
 		.option(
-			'topic',
+			'topics',
 			Object.assign(
 				{
-					alias: ['topics'],
+					alias: ['topic'],
 					type: 'string',
-					describe: 'GitHub topic to add. To add more than one, add multiple option and values or a comma separated list',
+					describe: 'GitHub topics to add. To add more than one, add multiple options or a comma separated list',
 				},
 				options
 			)
@@ -205,5 +205,5 @@ module.exports = {
 	withReviewers,
 	withTeamReviewers,
 	withGitHubUrl,
-	withTopic,
+	withTopics,
 }

test/commands/topics/add.test.js test/commands/repos/add-topics.test.js

@@ -1,6 +1,6 @@
 const nock = require('nock')
 const commonTests = require('../../common-tests')
-const yargsModule = require('../../../src/commands/topics/add')
+const yargsModule = require('../../../src/commands/repos/add-topics')
 
 beforeEach(() => {
 	jest
@@ -20,11 +20,11 @@ afterEach(() => {
 /**
  * Common Yargs tests
  */
-const command = 'topics add'
+const command = 'repos add-topics'
 const requiredArguments = {
 	options: {
 		token: 'Test-Token',
-		topic: 'hello',
+		topics: ['hello'],
 	},
 	positionals: {
 		'github-url': 'https://github.com/Test-Owner/Test-Repo',
@@ -33,7 +33,7 @@ const requiredArguments = {
 commonTests.describeYargs(yargsModule, command, requiredArguments)
 
 describe('Add topic', () => {
-	test('triggers a network requests on the GitHub API', async () => {
+	test('triggers network requests on the GitHub API', async () => {
 		nock('https://api.github.com')
 			.get('/repos/Test-Owner/Test-Repo/topics')
 			.reply(200, {
@@ -50,7 +50,7 @@ describe('Add topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 
 		await yargsModule.handler(args)
@@ -72,7 +72,7 @@ describe('Add topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'hello',
+			topics: ['hello'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith('hello')
@@ -93,7 +93,7 @@ describe('Add topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith('customer-products\napp')
@@ -117,7 +117,7 @@ describe('Error output', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 		await yargsModule.handler(args)
 		expect(errorResponse.isDone()).toBe(true)
@@ -137,7 +137,7 @@ describe('Error output', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith(expect.stringMatching(/Not found/i))

test/commands/topics/list.test.js test/commands/repos/list-topics.test.js

@@ -1,6 +1,6 @@
 const nock = require('nock')
 const commonTests = require('../../common-tests')
-const yargsModule = require('../../../src/commands/topics/list')
+const yargsModule = require('../../../src/commands/repos/list-topics')
 
 beforeEach(() => {
 	jest
@@ -20,7 +20,7 @@ afterEach(() => {
 /**
  * Common Yargs tests
  */
-const command = 'topics list'
+const command = 'repos list-topics'
 const requiredArguments = {
 	options: {
 		token: 'Test-Token',

test/commands/topics/remove.test.js test/commands/repos/remove-topics.test.js

@@ -1,6 +1,6 @@
 const nock = require('nock')
 const commonTests = require('../../common-tests')
-const yargsModule = require('../../../src/commands/topics/remove')
+const yargsModule = require('../../../src/commands/repos/remove-topics')
 
 beforeEach(() => {
 	jest
@@ -20,11 +20,11 @@ afterEach(() => {
 /**
  * Common Yargs tests
  */
-const command = 'topics remove'
+const command = 'repos remove-topics'
 const requiredArguments = {
 	options: {
 		token: 'Test-Token',
-		topic: 'hello',
+		topics: ['hello'],
 	},
 	positionals: {
 		'github-url': 'https://github.com/Test-Owner/Test-Repo',
@@ -33,7 +33,7 @@ const requiredArguments = {
 commonTests.describeYargs(yargsModule, command, requiredArguments)
 
 describe('Remove topic', () => {
-	test('triggers a network requests on the GitHub API', async () => {
+	test('triggers network requests on the GitHub API', async () => {
 		nock('https://api.github.com')
 			.get('/repos/Test-Owner/Test-Repo/topics')
 			.reply(200, {
@@ -50,7 +50,7 @@ describe('Remove topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 
 		await yargsModule.handler(args)
@@ -72,7 +72,7 @@ describe('Remove topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'hello',
+			topics: ['hello'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith('')
@@ -93,7 +93,7 @@ describe('Remove topic', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'app',
+			topics: ['app'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith('customer-products\nnew')
@@ -117,7 +117,7 @@ describe('Error output', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'customer-products',
+			topics: ['customer-products'],
 		}
 		await yargsModule.handler(args)
 		expect(errorResponse.isDone()).toBe(true)
@@ -137,7 +137,7 @@ describe('Error output', () => {
 		const args = {
 			token: 'Test-Token',
 			githubUrl: { owner: 'Test-Owner', repo: 'Test-Repo' },
-			topic: 'customer-products',
+			topics: ['customer-products'],
 		}
 		await yargsModule.handler(args)
 		expect(console.log).toBeCalledWith(expect.stringMatching(/Not found/i))