feat: add parsing of isFlag property by Examples

- Add parsing of argument property isFlag by Examples section Closes #67
linterhub · Aug 16, 2018 · c9505b3 · c9505b3
1 parent a124184
commit c9505b3
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 18 deletions.
diff --git a/src/arguments.js b/src/arguments.js
@@ -96,7 +96,6 @@ const isValueBoolean = (string) => {
  * @return {string} argumentType - type of argument
  */
 const getPropertyType = (string, argument, context) => {
-    if (argument.isFlag) return null;
     const typesDictionary = context.get.template.typesDictionary();
     const argumentAddition = removeExtraArgumentNames(string, argument);
     const result = Object.keys(typesDictionary)
@@ -135,6 +134,21 @@ const removeExtraEnumValues = (enumArray, regexp) => {
     return result.length !== 0 ? result : null;
 };
 
+/**
+ * Set argument property isFlag by examples section
+ * @param {string} section - examples section
+ * @param {object} context - internal config
+ */
+const checkFlagsByExamples = (section, context) => {
+    const regularExp = new RegExp(context.regexp.examplesArgument, 'gim');
+    while (match = regularExp.exec(section)) {
+        let option = context.options.find((option) => {
+            return match[1] === (option.longName || option.shortName);
+        });
+        if (option) option.isFlag = false;
+    }
+};
+
 /**
  * Remove extra coma from string
  * @param {string} string - any string
@@ -225,4 +239,5 @@ exports = module.exports = {
     getArgumentObject,
     getDelimiterValue,
     getValueByRegexp,
+    checkFlagsByExamples,
 };
diff --git a/src/sections.js b/src/sections.js
@@ -40,6 +40,7 @@ const examples = (section, context) => {
     const delimiter = arguments.getDelimiterValue(
         section, context.regexp.delimiter);
     context.delimiter = delimiter ? delimiter : context.delimiter;
+    arguments.checkFlagsByExamples(section, context);
 };
 
 /**

diff --git a/src/template/configDefault.json b/src/template/configDefault.json
@@ -5,9 +5,7 @@
                 "Options"
             ],
             "postfix": [
-                ":",
-                "\n",
-                ":\n"
+                ":"
             ],
             "parseWhole": true
         },
@@ -16,19 +14,15 @@
                 "Usage"
                 ],
             "postfix": [
-                ":",
-                "\n",
-                ":\n"
+                ":"
             ]
         },
         "examples": {
             "names": [
                 "Examples"
                 ],
             "postfix": [
-                ":",
-                "\n",
-                ":\n"
+                ":"
             ]
         }
     },

diff --git a/src/template/context.js b/src/template/context.js
@@ -45,6 +45,7 @@ const context = {
             short: '(\\s|^)-[^-]*?(\\s|=|$)',
             long: '--.+?(\\s|=|$)',
         },
+        examplesArgument: '\\s+(-[\\S]+)(\\s|=)[^-\\s]+',
     },
     options: [],
     delimiter: '',

diff --git a/src/templatizer.js b/src/templatizer.js
@@ -40,7 +40,7 @@ const templatizer = (context, config) => {
             default:
                 const prefix = !option.isFlag ? `${nonFlagPrefix}:` : '';
                 optionSchema.id = prefix + argumentName;
-                optionSchema.type = option.type;
+                optionSchema.type = option.isFlag ? null : option.type;
         }
         optionSchema.description = option.description;
         if (option.defaultValue) optionSchema.default = option.defaultValue;

diff --git a/test/parsing/config.json b/test/parsing/config.json
@@ -8,9 +8,7 @@
             "postfix": [
                 ":",
                 "s",
-                "s:",
-                "s\n",
-                "s:\n"
+                "s:"
             ]
         }
     }

diff --git a/test/parsing/files/full.example.valid.json b/test/parsing/files/full.example.valid.json
@@ -13,8 +13,8 @@
          "type": "object",
          "properties": {
             "--extension": {
-               "id": "--extension",
-               "type": null,
+               "id": "args:--extension",
+               "type": "string",
                "description": "Additional extension to lint [Can be set multiple times]"
             },
             "--no-esnext": {
@@ -154,6 +154,11 @@
                 "type": "object",
                 "description": "Specify parser options"
             },
+            "--spaces": {
+               "id": "args:--spaces",
+               "type": "string",
+               "description": "Spaces"
+            },
             "--ignore": {
                "id": "--ignore",
                "type": null,

diff --git a/test/parsing/files/full.example.valid.txt b/test/parsing/files/full.example.valid.txt
@@ -37,6 +37,7 @@
     -f, --error-filter <path>       a module to filter errors
     --max-warnings [integer]  Number of warnings to trigger nonzero exit code
     --parser-options Object        Specify parser options
+    --spaces            Spaces.
 
 
   Examples:
@@ -45,9 +46,9 @@
   Examples:
     $ xo index.js
     $ xo *.js !foo.js
-    $ xo --space
+    $ xo --spaces=1
     $ xo --env=node --env=mocha
-    $ xo --init --space
+    $ xo --ignore --i
     $ xo --plugin=react
     $ xo --plugin=html --extension=html
     $ echo 'const x=true' | xo --stdin --fix