https://scotch.io/tutorials/build-an-interactive-command-line-application-with-nodejs
fairyly yhq147258369
$ mkdir contact-manager # Create project directory
$ cd contact-manager && yarn init # Initialize the directory as a Node.jS application and follow the prompt
$ yarn add mongoose inquirer commander # Add the dependencies we need for the project
- 创建 logic.js
const mongoose = require('mongoose'); // An Object-Document Mapper for Node.js
const assert = require('assert'); // N.B: Assert module comes bundled with Node.js.
mongoose.Promise = global.Promise; // Allows us to use Native promises without throwing error.
// Connect to a single MongoDB instance. The connection string could be that of a remote server
// We assign the connection instance to a constant to be used later in closing the connection
const db = mongoose.connect('mongodb://localhost:27017/contact-manager');
// Converts value to lowercase
function toLower(v) {
return v.toLowerCase();
}
// Define a contact Schema
const contactSchema = mongoose.Schema({
firstname: { type: String, set: toLower },
lastname: { type: String, set: toLower },
phone: { type: String, set: toLower },
email: { type: String, set: toLower }
});
// Define model as an interface with the database
const Contact = mongoose.model('Contact', contactSchema);
/**
* @function [addContact]
* @returns {String} Status
*/
const addContact = (contact) => {
Contact.create(contact, (err) => {
assert.equal(null, err);
console.info('New contact added');
db.disconnect();
});
};
/**
* @function [getContact]
* @returns {Json} contacts
*/
const getContact = (name) => {
// Define search criteria. The search here is case-insensitive and inexact.
const search = new RegExp(name, 'i');
Contact.find({$or: [{firstname: search }, {lastname: search }]})
.exec((err, contact) => {
assert.equal(null, err);
console.info(contact);
console.info(`${contact.length} matches`);
db.disconnect();
});
};
// Export all methods
module.exports = { addContact, getContact };
- 创建 contact.js
const program = require('commander');
// Require logic.js file and extract controller functions using JS destructuring assignment
const { addContact, getContact } = require('./logic');
program
.version('0.0.1')
.description('Contact management system');
program
.command('addContact <firstame> <lastname> <phone> <email>')
.alias('a')
.description('Add a contact')
.action((firstname, lastname, phone, email) => {
addContact({firstname, lastname, phone, email});
});
program
.command('getContact <name>')
.alias('r')
.description('Get contact')
.action(name => getContact(name));
program.parse(process.argv);
- 测试
$ node contact.js --help # Shows you program description, usage, commands, actions, and aliases
$ node contact.js --version # Shows the version number specified
// 添加联系人
$ node contact.js addContact John Doe 013-452-3134 [email protected]
// 使用别名
$ node contact.js r john # Notice we used r which is an alias for getContact.
- 更新 contact.js
const program = require('commander');
const { prompt } = require('inquirer');
const {
addContact,
getContact,
addMultipleContacts,
getContactList,
updateContact,
deleteContact
} = require('./logic');
const questions = [
{
type : 'input',
name : 'firstname',
message : 'Enter firstname ..'
},
{
type : 'input',
name : 'lastname',
message : 'Enter lastname ..'
},
{
type : 'input',
name : 'phone',
message : 'Enter phone number ..'
},
{
type : 'input',
name : 'email',
message : 'Enter email address ..'
}
];
program
.version('0.0.1')
.description('Contact management system')
program
.command('addContact')
.alias('a')
.description('Add a contact')
.action(() => {
prompt(questions).then((answers) =>
addContact(answers));
});
program
.command('getContact <name>')
.alias('r')
.description('Get contact')
.action(name => getContact(name));
program
.command('updateContact <_id>')
.alias('u')
.description('Update contact')
.action(_id => {
prompt(questions).then((answers) =>
updateContact(_id, answers));
});
program
.command('deleteContact <_id>')
.alias('d')
.description('Delete contact')
.action(_id => deleteContact(_id));
program
.command('getContactList')
.alias('l')
.description('List contacts')
.action(() => getContactList());
// Assert that a VALID command is provided
if (!process.argv.slice(2).length || !/[arudl]/.test(process.argv.slice(2))) {
program.outputHelp();
process.exit();
}
program.parse(process.argv)
在 contact.js 最顶部 添加代码
#!/usr/bin/env node
- 更新 package.json
"name": "contacto",
...........
"preferGlobal": true,
"bin": "./contact.js",
..........
- update logic.js.
const mongoose = require('mongoose'); // An Object-Document Mapper for Node.js
const assert = require('assert'); // N.B: Assert module comes bundled with NodeJS.
mongoose.Promise = global.Promise; // Allows us to use Native promises without throwing error.
// Connect to a single MongoDB instance. The connection string could be that of remote server
// We assign the connection instance to a constant to be used later in closing the connection
const db = mongoose.connect('mongodb://localhost:27017/contact-manager');
// Convert value to to lowercase
function toLower(v) {
return v.toLowerCase();
}
// Define a contact Schema
const contactSchema = mongoose.Schema({
firstname: { type: String, set: toLower },
lastname: { type: String, set: toLower },
phone: { type: String, set: toLower },
email: { type: String, set: toLower }
});
// Define model as an interface with the database
const Contact = mongoose.model('Contact', contactSchema);
/**
* @function [addContact]
* @returns {String} Status
*/
const addContact = (contact) => {
Contact.create(contact, (err) => {
assert.equal(null, err);
console.info('New contact added');
db.disconnect();
});
};
/**
* @function [getContact]
* @returns {Json} contacts
*/
const getContact = (name) => {
// Define search criteria
const search = new RegExp(name, 'i');
Contact.find({$or: [{firstname: search }, {lastname: search }]})
.exec((err, contact) => {
assert.equal(null, err);
console.info(contact);
console.info(`${contact.length} matches`);
db.disconnect();
});
};
/**
* @function [getContactList]
* @returns {Sting} status
*/
const updateContact = (_id, contact) => {
Contact.update({ _id }, contact)
.exec((err, status) => {
assert.equal(null, err);
console.info('Updated successfully');
db.disconnect();
});
};
/**
* @function [deleteContact]
* @returns {String} status
*/
const deleteContact = (_id) => {
Contact.remove({ _id })
.exec((err, status) => {
assert.equal(null, err);
console.info('Deleted successfully');
db.disconnect();
})
}
/**
* @function [getContactList]
* @returns [contactlist] contacts
*/
const getContactList = () => {
Contact.find()
.exec((err, contacts) => {
assert.equal(null, err);
console.info(contacts);
console.info(`${contacts.length} matches`);
db.disconnect();
})
}
// Export all methods
module.exports = {
addContact,
getContact,
getContactList,
updateContact,
deleteContact
};
- contact.js. 最头部添加
#!/usr/bin/env node
#!/usr/bin/env node
const program = require('commander');
const { prompt } = require('inquirer');
const {
addContact,
getContact,
getContactList,
updateContact,
deleteContact
} = require('./logic');
const questions = [
{
type : 'input',
name : 'firstname',
message : 'Enter firstname ..'
},
{
type : 'input',
name : 'lastname',
message : 'Enter lastname ..'
},
{
type : 'input',
name : 'phone',
message : 'Enter phone number ..'
},
{
type : 'input',
name : 'email',
message : 'Enter email address ..'
}
];
program
.version('0.0.1')
.description('contact management system')
program
.command('addContact')
.alias('a')
.description('Add a contact')
.action(() => {
prompt(questions).then((answers) =>
addContact(answers));
});
program
.command('getContact <name>')
.alias('r')
.description('Get contact')
.action(name => getContact(name));
program
.command('updateContact <_id>')
.alias('u')
.description('Update contact')
.action(_id => {
prompt(questions).then((answers) =>
updateContact(_id, answers));
});
program
.command('deleteContact <_id>')
.alias('d')
.description('Delete contact')
.action(_id => deleteContact(_id));
program
.command('getContactList')
.alias('l')
.description('List contacts')
.action(() => getContactList());
// Assert that a VALID command is provided
if (!process.argv.slice(2).length || !/[arudl]/.test(process.argv.slice(2))) {
program.outputHelp();
process.exit();
}
program.parse(process.argv)
- test
$ contacto l # Lists all the contact in the app
$ contacto u <id of the contact to update> # Lauches inquiry session to get the new data to update with.
$ contacto d <id of the contact to delete> # Deletes a contact.
- npm link 命令可以将一个任意位置的npm包链接到全局执行环境,从而在任意位置使用命令行都可以直接运行该npm包
- 更新 package.json
"name": "contacto",
...........
"preferGlobal": true,
"bin": "./contact.js",