index.js 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. 'use strict';
  2. module.exports = function(ctx) {
  3. const { console } = ctx.extend;
  4. console.register('clean', 'Remove generated files and cache.', require('./clean'));
  5. console.register('config', 'Get or set configurations.', {
  6. usage: '[name] [value]',
  7. arguments: [
  8. {name: 'name', desc: 'Setting name. Leave it blank if you want to show all configurations.'},
  9. {name: 'value', desc: 'New value of a setting. Leave it blank if you just want to show a single configuration.'}
  10. ]
  11. }, require('./config'));
  12. console.register('deploy', 'Deploy your website.', {
  13. options: [
  14. {name: '--setup', desc: 'Setup without deployment'},
  15. {name: '-g, --generate', desc: 'Generate before deployment'}
  16. ]
  17. }, require('./deploy'));
  18. console.register('generate', 'Generate static files.', {
  19. options: [
  20. {name: '-d, --deploy', desc: 'Deploy after generated'},
  21. {name: '-f, --force', desc: 'Force regenerate'},
  22. {name: '-w, --watch', desc: 'Watch file changes'},
  23. {name: '-b, --bail', desc: 'Raise an error if any unhandled exception is thrown during generation'},
  24. {name: '-c, --concurrency', desc: 'Maximum number of files to be generated in parallel. Default is infinity'}
  25. ]
  26. }, require('./generate'));
  27. console.register('list', 'List the information of the site', {
  28. desc: 'List the information of the site.',
  29. usage: '<type>',
  30. arguments: [
  31. {name: 'type', desc: 'Available types: page, post, route, tag, category'}
  32. ]
  33. }, require('./list'));
  34. console.register('migrate', 'Migrate your site from other system to Hexo.', {
  35. init: true,
  36. usage: '<type>',
  37. arguments: [
  38. {name: 'type', desc: 'Migrator type.'}
  39. ]
  40. }, require('./migrate'));
  41. console.register('new', 'Create a new post.', {
  42. usage: '[layout] <title>',
  43. arguments: [
  44. {name: 'layout', desc: 'Post layout. Use post, page, draft or whatever you want.'},
  45. {name: 'title', desc: 'Post title. Wrap it with quotations to escape.'}
  46. ],
  47. options: [
  48. {name: '-r, --replace', desc: 'Replace the current post if existed.'},
  49. {name: '-s, --slug', desc: 'Post slug. Customize the URL of the post.'},
  50. {name: '-p, --path', desc: 'Post path. Customize the path of the post.'}
  51. ]
  52. }, require('./new'));
  53. console.register('publish', 'Moves a draft post from _drafts to _posts folder.', {
  54. usage: '[layout] <filename>',
  55. arguments: [
  56. {name: 'layout', desc: 'Post layout. Use post, page, draft or whatever you want.'},
  57. {name: 'filename', desc: 'Draft filename. "hello-world" for example.'}
  58. ]
  59. }, require('./publish'));
  60. console.register('render', 'Render files with renderer plugins.', {
  61. init: true,
  62. desc: 'Render files with renderer plugins (e.g. Markdown) and save them at the specified path.',
  63. usage: '<file1> [file2] ...',
  64. options: [
  65. {name: '--output', desc: 'Output destination. Result will be printed in the terminal if the output destination is not set.'},
  66. {name: '--engine', desc: 'Specify render engine'},
  67. {name: '--pretty', desc: 'Prettify JSON output'}
  68. ]
  69. }, require('./render'));
  70. };