tumblr-toolkit/lib/cli.js

Tumblr API-based toolkit for batch posts processing.

const options = {

	c: {
		alias: 'credentials',
		describe: 'Tumblr credentilas JSON-file path',
		demandOption: true,
		coerce: path => 
			require(
				require('path').resolve(path)
			)
		,
	},

	b: {
		alias: 'blog',
		demandOption: true,
		type: 'string',
		describe: 'Blog name'
	},

	l: {
		alias: 'limit',
		default: 1000,
		describe: 'Limit queried posts count',
		type: 'number'
	},

	s: {
		alias: 'source',
		describe: 'Source to process (use blog posts if not present)',
		default: 'blog',
		choices: ['blog', 'queue']
	},

	postTag: {
		describe: 'Filter posts by tag',
		type: 'string'
	},

	postId: {
		describe: 'Get post with ID',
		type: 'string'
	},

	postTypes: {
		describe: 'Filter by post type',
		choices: ['text', 'quote', 'link', 'answer', 'video', 'audio', 'photo', 'chat'],
	},

	cleanCode: {
		default: 403,
		describe: 'HTTP response code to clean',
		type: 'number'
	},

	cleanInvert: {
		default: false,
		describe: 'Invert clean logic - keep only with code',
		type: 'boolean'
	},

	removeDryRun: {
		default: true,
		describe: 'Dry-run: only print, don\'t remove',
		type: 'boolean'
	},

	tagTypeGif: {
		describe: 'How to treat GIFs',
		default: 'same',
		choices: ['same', 'add', 'replace']
	},

	processCode: {
		describe: 'Processor function code, receives post and return codes as an argument, should return one of return codes for further post process.'
			+ ' May return promise resolving to return code as well.'
			+ " Example source code:\n return post.type === 'link' ? code.REMOVE_POST : code.DO_NOTHING;"
			+ '\nWould remove all link posts and keep other.'
			+ '\nCodes are: DO_NOTHING, UPDATE_POST, REMOVE_POST'
		,
		demandOption: true
	}
};

module.exports = {

	cli: require('yargs')

		.command('blogInfo', 'Get blog info', require('../cli/blogInfo'))
		.command('post', 'Create blog post', require('../cli/post'))
		.command('postInfo', 'Get post info', require('../cli/postInfo'))
		.command('blogPosts', 'Get blog posts', require('../cli/blogPosts'))
		.command('blogQueue', 'Get blog queued posts', require('../cli/blogQueue'))
		.command('blogDrafts', 'Get blog draft posts', require('../cli/blogDrafts'))

		.command('clean', 'Clean unavailable videos', yargs => {
			yargs
				.describe('b', 'Blog name to clean-up')

				.group(['clean-code', 'clean-invert'], 'Cleanup options:')
				.option('clean-code', options.cleanCode)
				.option('clean-invert', options.cleanInvert)

				.group(['post-tag', 'post-id'], 'Filter options:')
				.option('post-tag', options.postTag)
				.option('post-id', options.postId)

				.usage('Usage: $0 clean -c [file] -b [blog] [options]');
		})

		.command('remove', 'Remove found videos (be careful!)', yargs => {
			yargs
				.describe('b', 'Blog name to remove through')

				.group(['s', 'remove-dry-run'], 'Remove options:')
				.option('s', options.s)
				.option('remove-dry-run', options.removeDryRun)

				.group(
					['post-type', 'post-tag', 'post-id'],
					'Filter options (unavailable for queue source):'
				)
				.option('post-type', options.postTypes)
				.option('post-tag', options.postTag)
				.option('post-id', options.postId)

				.usage('Usage: $0 remove [-s [blog|queue]] -c [file] -b [blog] [options]');
		})

		.command('tag-type', 'Set tag based on post type', yargs => {
			yargs
				.describe('b', 'Blog name to tag posts by type')

				.group(['s', 'tag-type-gif'], 'Tag-type options:')
				.option('s', options.s)
				.option('tag-type-gif', options.tagTypeGif)

				.group(
					['post-type', 'post-tag', 'post-id'],
					'Filter options (unavailable for queue source):'
				)
				.option('post-type', options.postTypes)
				.option('post-tag', options.postTag)
				.option('post-id', options.postId)

				.usage('Usage: $0 tag-type [-s [blog|queue]] -c [file] -b [blog] [options]');
		})

		.command('process', 'Process posts with given function code', yargs => {
			yargs
				.group(['s', 'process-code'], 'Process options:')
				.option('s', options.s)
				.option('process-code', options.processCode)

				.group(
					['post-type', 'post-tag', 'post-id'],
					'Filter options (unavailable for queue source):'
				)
				.option('post-type', options.postTypes)
				.option('post-tag', options.postTag)
				.option('post-id', options.postId)

				.usage('Usage: $0 process [-s [blog|queue]] -c [file] -b [blog] [options]');
		})

		.strict(true)
		.demandCommand()

		.option('c', options.c)
		.option('b', options.b)
		.option('l', options.l)

		.version(() => {
			return require('../package.json').version
		})
		.alias('v', 'version')
		.wrap(99)

		.usage('Usage: $0 <command> -c [file] -b [blog] [options]'),
}