コンソール

コンソールはHexoとユーザーとの橋渡しをします。 コンソールコマンドの登録方法を説明します。

概要

hexo.extend.console.register(name, desc, options, function (args) {
  // ...
});

引数	説明
name	名前
desc	説明
options	オプション

関数には引数argsが渡されます。 これはユーザーがターミナルに入力する引数です。 Minimistによって解析されます。

オプション

usage

コンソールコマンドの使用方法。 例えば:

{
  usage: "[layout] <title>";
}
// hexo new [layout] <title>

arguments

コンソールコマンドの各引数の説明。 例えば:

{
  arguments: [
    { name: "layout", desc: "Post layout" },
    { name: "title", desc: "Post title" },
  ];
}

options

コンソールコマンドの各オプションの説明。 例えば:

{
  options: [{ name: "-r, --replace", desc: "Replace existing files" }];
}

desc

コンソールコマンドについてのより詳細な情報。

例

hexo.extend.console.register(
  "config",
  "Display configuration",
  function (args) {
    console.log(hexo.config);
  },
);