particle-cli/src/cli/library.js

Simple Node commandline application for working with your Particle devices and using the Particle Cloud

'use strict';
function api() {
	const ParticleApi = require('../cmd/api');
	const settings = require('../../settings');

	if (!api._instance) {
		api._instance = new ParticleApi(settings.apiUrl, {
			accessToken: settings.access_token
		}).api;
	}
	return api._instance;
}

module.exports = ({ commandProcessor, root }) => {
	const lib = commandProcessor.createCategory(root, 'library', 'Manage firmware libraries', { alias: 'libraries' });

	commandProcessor.createCommand(lib, 'add', 'Add a library to the current project.', {
		params: '<name>',
		handler: (...args) => require('./library_add').command(api(), ...args),
		examples: {
			'$0 $command InternetButton': 'Add the InternetButton library to your project. Create a project with the project init command'
		}
	});

	commandProcessor.createCommand(lib, 'create', 'Create a new library in the specified or current directory', {
		options: {
			'name': {
				description: 'The name of the library to create.'
			},
			'version': {
				description: 'The initial version of the library to create.'
			},
			'author': {
				description: 'The author of the library.'
			},
			'dir': {
				description: 'The directory to create the library in.'
			}
		},
		handler: (...args) => require('./library_init').command(...args)
	});

	commandProcessor.createCommand(lib, 'install', false, {
		options: {
			'copy': {
				boolean: true,
				alias: 'vendored',
				description: 'install the library by copying the library sources into the project\'s lib directory'
			},
			'adapter': { // hidden
				boolean: true,
				alias: 'a'
			},
			'confirm': {
				boolean: true,
				alias: 'y'
			},
			'dest': {
				description: 'the directory to install to'
			}
		},
		params: '[name]',
		handler: (...args) => require('./library_install').command('install', api(), ...args),
	});

	commandProcessor.createCommand(lib, 'copy', 'Copy a library to the current project', {
		params: '[name]',
		handler: (...args) => require('./library_install').command('copy', api(), ...args)
	});

	commandProcessor.createCommand(lib, 'list', 'List libraries available', {
		options: {
			'filter': {
				description: 'filters libraries not matching the text'
			},
			'non-interactive': {
				boolean: true,
				description: 'Prints a single page of libraries without prompting'
			},
			'page': {
				number: true,
				description: 'Start the listing at the given page number'
			},
			'limit': {
				number: true,
				description: 'The number of items to show per page'
			},
			// TODO (mirande): should be a global flag supported by all commands
			'json': {
				boolean: true,
				description: 'output JSON formatted data [experimental]'
			}
		},
		params: '[sections...]',
		handler: (...args) => require('./library_list').command(api(), ...args)
	});

	commandProcessor.createCommand(lib, 'migrate', 'Migrate a local library from v1 to v2 format', {
		options: {
			test: {
				alias: 'dryrun',
				boolean: true,
				description: 'test if the library can be migrated'
			},
			'adapter': {
				boolean: true,
				default: true,
				description: 'add include file adapters to support v1-style includes "library/library.h"'
			},
		},
		params: '[library...]',

		handler: (...args) => require('./library_migrate').command(...args)
	});

	commandProcessor.createCommand(lib, 'search', 'Search available libraries', {
		params: '<name>',
		options: {
			// TODO (mirande): should be a global flag supported by all commands
			'json': {
				boolean: true,
				description: 'output JSON formatted data [experimental]'
			}
		},
		handler: (...args) => require('./library_search').command(api(), ...args)
	});

	commandProcessor.createCommand(lib, 'upload', 'Uploads a private version of a library.', {
		options: {
			'dryRun': {
				boolean: true,
				description: 'perform validation steps but don\'t actually upload the library.'
			}
		},
		handler: (...args) => require('./library_upload').command(api(), ...args)
	});

	commandProcessor.createCommand(lib, 'publish', 'Publish a private library, making it public', {
		params: '[name]',
		handler: (...args) => require('./library_publish').command(api(), ...args)
	});

	commandProcessor.createCommand(lib, 'view', 'View details about a library', {
		options: {
			'readme': {
				boolean: true,
				description: 'display the readme for the library'
			},
			'source': {
				boolean: true,
				description: 'display the main source file for the library'
			},
			'header': {
				boolean: true,
				description: 'display the main header file for the library'
			},
			// TODO (mirande): should be a global flag supported by all commands
			'json': {
				boolean: true,
				description: 'output JSON formatted data [experimental]'
			}
		},
		params: '<name>',
		handler: (...args) => require('./library_view').command(api(), ...args)
	});

	commandProcessor.createCommand(lib, 'delete', false, {
		params: '<name>',
		handler: (...args) => require('./library_delete').command(api(), ...args)
	});

	return lib;
};