Allow options only in command mode.

Author: fenying

CHANGES.md

@@ -2,6 +2,10 @@
 
 [Dep:LRT.Core]: https://github.com/litert/core.js
 
+## v0.2.0
+
+- Now allows that only options input without commands in command mode.
+
 ## v0.1.1
 
 - Update the dependencies.

docs/zh-CN/02-use-command.md

@@ -97,7 +97,7 @@ Help command is found.
 Input: test.txt
 
 $ node dist/samples/sample-07.js --input test.txt
-Exception { _errno: 7, _message: 'No command input.' }
+Input: test.txt
 ```
 
 使用命令解析器时，必须输入命令，否则会返回错误。

docs/zh-CN/interface.ICommandParser.md

@@ -17,7 +17,7 @@ interface ICommandParser extends ISimpleParser {
      *
      * @param opts   主命令信息
      */
-    addCommand(opts: ICommandSettings): ICommandParser;
+    addCommand(opts: ICommandSettings): this;
 
     /**
      * 为一个主命令添加一个新的子命令。遇到如下情况时会抛出异常：
@@ -36,7 +36,7 @@ interface ICommandParser extends ISimpleParser {
     addSubCommand(
         main: string,
         opts: ICommandSettings
-    ): ICommandParser;
+    ): this;
 
     /**
      * 开始分析

docs/zh-CN/interface.IParserSettings.md

@@ -34,6 +34,13 @@ interface IParserSettings {
      * 默认值： false
      */
     "shortAttach"?: boolean;
+
+    /**
+     * 允许只使用选项，而不使用命令。
+     *
+     * 默认值： true
+     */
+    "allowOptionsOnly"?: boolean;
 }
 ```
 

docs/zh-CN/interface.ISimpleParser.md

@@ -17,7 +17,7 @@ interface ISimpleParser extends ISimpleParser {
      *
      * @param opts   选项信息
      */
-    addOption(opts: IOptionSetting): ISimpleParser;
+    addOption(opts: IOptionSetting): this;
 
     /**
      * 开始分析。

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@litert/clap",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "A simple library for parsing commandline arguments.",
   "main": "dist/index.js",
   "scripts": {

package.json

@@ -17,7 +17,7 @@ import Exception from "./class.Exception";
 import * as Errors from "./errors";
 import { ICommandSettings } from "./interfaces";
 
-abstract class AbstractCommand implements ICommandSettings {
+export abstract class AbstractCommand implements ICommandSettings {
 
     protected _name: string;
 
@@ -67,4 +67,4 @@ abstract class AbstractCommand implements ICommandSettings {
     }
 }
 
-export = AbstractCommand;
+export default AbstractCommand;

sources/class.AbstractCommand.ts

@@ -19,8 +19,8 @@ import { CommandParseResult } from "./class.ParseResult";
 import * as External from "./interfaces";
 import * as Errors from "./errors";
 import * as Internal from "./internal";
-import MainCommand = require("./class.MainCommand");
-import { SimpleParser } from "./class.SimpleParser";
+import MainCommand from "./class.MainCommand";
+import SimpleParser from "./class.SimpleParser";
 
 export class CommandParser extends SimpleParser implements External.ICommandParser {
 
@@ -37,7 +37,7 @@ export class CommandParser extends SimpleParser implements External.ICommandPars
         this._shortMainCommands = {};
     }
 
-    public addCommand(opts: External.ICommandSettings): External.ICommandParser {
+    public addCommand(opts: External.ICommandSettings): this {
 
         opts.name = opts.name.toLowerCase();
 
@@ -70,7 +70,7 @@ export class CommandParser extends SimpleParser implements External.ICommandPars
     public addSubCommand(
         main: string,
         opts: External.ICommandSettings
-    ): External.ICommandParser {
+    ): this {
 
         main = main.toLowerCase();
 
@@ -106,20 +106,25 @@ export class CommandParser extends SimpleParser implements External.ICommandPars
                 );
             }
 
-            if (!ret.mainCommand) {
+            if (!this._settings.allowOptionsOnly) {
 
-                throw new Exception(
-                    Errors.E_LACK_MAIN_COMMAND,
-                    "No command input."
-                );
-            }
+                if (!ret.mainCommand) {
+
+                    throw new Exception(
+                        Errors.E_LACK_MAIN_COMMAND,
+                        "No command input."
+                    );
+                }
 
-            if (!ret.subCommand && this._mainCommands[ret.mainCommand].enableSubCommand) {
+                if (!ret.subCommand
+                    && this._mainCommands[ret.mainCommand].enableSubCommand
+                ) {
 
-                throw new Exception(
-                    Errors.E_LACK_SUB_COMMAND,
-                    "No sub command input."
-                );
+                    throw new Exception(
+                        Errors.E_LACK_SUB_COMMAND,
+                        "No sub command input."
+                    );
+                }
             }
 
             ret.setSuccess();

sources/class.CommandParser.ts

@@ -18,9 +18,9 @@ import { IDictionary } from "@litert/core";
 import Exception from "./class.Exception";
 import { ICommandSettings } from "./interfaces";
 import { IMainCommandSettings } from "./internal";
-import AbstractCommand = require("./class.AbstractCommand");
+import AbstractCommand from "./class.AbstractCommand";
 
-class MainCommand extends AbstractCommand implements IMainCommandSettings {
+export class MainCommand extends AbstractCommand implements IMainCommandSettings {
 
     public enableSubCommand?: boolean;
 
@@ -84,4 +84,4 @@ class MainCommand extends AbstractCommand implements IMainCommandSettings {
 
 class SubCommandOption extends AbstractCommand {}
 
-export = MainCommand;
+export default MainCommand;