feat: add parsing of deprecated arguments

- Add parsing of deprecated arguments Closes #157
linterhub · Aug 17, 2018 · ad9f919 · ad9f919
1 parent b12b5f0
commit ad9f919
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 7 deletions.
diff --git a/src/arguments.js b/src/arguments.js
@@ -16,6 +16,9 @@ const getArgumentObject = (object, context) => {
             object.description, context.regexp.defaultValue),
         description: unifyDescription(object.description.trim()),
     };
+
+    argument.usage = getValueByRegexp(
+        argument.description, context.regexp.usage) ? false : true;
     argument.isFlag = identifyIsFlag(object.arg, argument);
     argument.type = getPropertyType(object.arg, argument, context);
     return argument;

diff --git a/src/template/context.js b/src/template/context.js
@@ -41,6 +41,7 @@ const context = {
             '+[\\S]+[^<\\)\\"])(>|\\)|\\"|,\\s)',
             split: /[\|]|\",\s\"|\"\sor\s\"|,\s/,
         },
+        usage: '(\\[|\\()deprecated(\\]|\\))',
         argument: {
             short: '(\\s|^)(-[^-]*?)(\\s|=|$)',
             long: '()(--.+?)(\\s|=|$)',

diff --git a/src/templatizer.js b/src/templatizer.js
@@ -47,7 +47,7 @@ const templatizer = (context, config) => {
             optionSchema.default = option.defaultValue;
         }
         if (option.enum) optionSchema.enum = option.enum;
-
+        if (!option.usage) optionSchema.usage = option.usage;
         result.definitions.arguments.properties[argumentName] = optionSchema;
     });
 

diff --git a/test/parsing/files/full.example.valid.json b/test/parsing/files/full.example.valid.json
@@ -41,14 +41,16 @@
             "--stdin": {
                "id": "linterhub:stdin",
                "type": "string",
-               "description": "Lint code provided on <STDIN> - (default is 'false\")",
-               "default": false
+               "description": "Lint code provided on <STDIN> - (default is 'false\") [deprecated]",
+               "default": false,
+               "usage": false
             },
             "--SPACE": {
                "id": "args:--SPACE",
                "type": "number",
-               "description": "USE SPACE INDENT INSTEAD OF TABS DEFAULTS TO 2",
-               "default": 2
+               "description": "(Deprecated) USE SPACE INDENT INSTEAD OF TABS DEFAULTS TO 2",
+               "default": 2,
+               "usage": false
             },
             "--parser": {
                "id": "args:--parser",

diff --git a/test/parsing/files/full.example.valid.txt b/test/parsing/files/full.example.valid.txt
@@ -23,8 +23,8 @@
   Options:
 
     --ext [String]     Specify JavaScript file extensions - [default: .js]
-    --stdin            Lint code provided on <STDIN> - (default is 'false")
-    --SPACE            USE SPACE INDENT INSTEAD OF TABS DEFAULTS TO 2
+    --stdin            Lint code provided on <STDIN> - (default is 'false") [deprecated]
+    --SPACE            (Deprecated) USE SPACE INDENT INSTEAD OF TABS DEFAULTS TO 2
     --parser           Which parser to use. <flow|babylon|typescript|css|less|scss|json|json5|json-stringify|graphql|markdown|vue|yaml>
     --arrow-parens=<avoid|always>   Include parentheses around a sole arrow function parameter.
                                     Defaults to avoid.