Support --stdin-display-name and the mixed style of files and stdin (#…

…278)

* Support --stdin-alt-name and the mix style such as `vint a.vim - b.vim`

* Care Python 2

* Add available options in README

* fixup! Care Python 2

* fixup! Care Python 2

* Update README

* Rename --stdin-alt-path to --stdin-display-name

* Add a test for stdin

* fixup! Support --stdin-alt-name and the mix style such as `vint a.vim - b.vim`

README.rst

@@ -122,6 +122,40 @@ You can configure linting severity, max errors, ... as following:
 
     $ vint --color --style ~/.vimrc
 
+And you can see all available options by using `--help`:
+
+::
+    $ vint --help
+    usage: vint [-h] [-v] [-V] [-e] [-w] [-s] [-m MAX_VIOLATIONS] [-c]
+                [--no-color] [-j] [-t] [--enable-neovim] [-f FORMAT]
+                [--stdin-alt-path STDIN_ALT_PATH]
+                [files [files ...]]
+    
+    Lint Vim script
+    
+    positional arguments:
+      files                 file or directory path to lint
+    
+    optional arguments:
+      -h, --help            show this help message and exit
+      -v, --version         show program's version number and exit
+      -V, --verbose         output verbose message
+      -e, --error           report only errors
+      -w, --warning         report errors and warnings
+      -s, --style-problem   report errors, warnings and style problems
+      -m MAX_VIOLATIONS, --max-violations MAX_VIOLATIONS
+                            limit max violations count
+      -c, --color           colorize output when possible
+      --no-color            do not colorize output
+      -j, --json            output json style
+      -t, --stat            output statistic info
+      --enable-neovim       enable Neovim syntax
+      -f FORMAT, --format FORMAT
+                            set output format
+      --stdin-display-name STDIN_DISPLAY_NAME
+                            specify a file path that is used for reporting when
+                            linting standard inputs
+
 Comment config
 ~~~~~~~~~~~~~~
 

dev_tool/show_encoding.py

@@ -19,5 +19,5 @@
 
     file_path = Path(namespace['file'][0])
     decoder = Decoder(default_decoding_strategy)
-    decoder.read(file_path)
+    decoder.decode(file_path)
     pprint(decoder.debug_hint)

test/acceptance/test_cli.py

@@ -144,5 +144,17 @@ def test_exec_vint_with_color_flag(self):
         self.assertRegex(got_output, expected_output_pattern)
 
 
+    def test_exec_vint_with_pipe(self):
+        cmd = 'echo "foo" =~ "bar" | bin/vint --stdin-display-name STDIN_TEST -'
+
+        with self.assertRaises(subprocess.CalledProcessError) as context_manager:
+            subprocess.check_output(cmd, shell=True, universal_newlines=True)
+
+        got_output = context_manager.exception.output
+
+        expected_output_pattern = '^STDIN_TEST:'
+        self.assertRegex(got_output, expected_output_pattern)
+
+
 if __name__ == '__main__':
     unittest.main()

test/asserting/policy.py

@@ -4,6 +4,8 @@
 from vint.compat.itertools import zip_longest
 from vint.linting.policy_set import PolicySet
 from vint.linting.linter import Linter
+from vint.linting.config.config_default_source import ConfigDefaultSource
+from vint.linting.lint_target import LintTargetFile
 from vint.linting.level import Level
 
 
@@ -31,7 +33,7 @@ def assertFoundViolationsEqual(self, path, Policy, expected_violations, policy_o
             config_dict['policies'][policy_name] = policy_options
 
         linter = Linter(policy_set, config_dict)
-        violations = linter.lint_file(path)
+        violations = linter.lint(LintTargetFile(path))
 
         pprint(violations)
         self.assertEqual(len(violations), len(expected_violations))
@@ -43,9 +45,13 @@ def assertFoundViolationsEqual(self, path, Policy, expected_violations, policy_o
     def assertViolation(self, actual_violation, expected_violation):
         self.assertIsNot(actual_violation, None)
         self.assertIsNot(expected_violation, None)
+
+        pprint(actual_violation)
+
         self.assertEqual(actual_violation['name'], expected_violation['name'])
         self.assertEqual(actual_violation['position'], expected_violation['position'])
         self.assertEqual(actual_violation['level'], expected_violation['level'])
+
         self.assertIsInstance(actual_violation['description'], str)
 
 

test/integration/vint/ast/plugin/test_scope_plugin.py

@@ -10,6 +10,7 @@
     is_declarative_identifier,
 )
 from vint.ast.plugin.scope_plugin import ScopePlugin
+from vint.linting.lint_target import LintTargetFile
 
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
@@ -41,7 +42,7 @@ class Fixtures(enum.Enum):
 class TestScopePlugin(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path.value)
+        ast = parser.parse(LintTargetFile(file_path.value))
         return ast
 
 

test/integration/vint/linting/test_linter.py

@@ -4,6 +4,7 @@
 from vint.linting.level import Level
 from vint.linting.policy.abstract_policy import AbstractPolicy
 from vint.linting.linter import Linter
+from vint.linting.lint_target import LintTargetFile
 
 INVALID_VIM_SCRIPT = Path('test', 'fixture', 'linter', 'invalid.vim')
 BROKEN_VIM_SCRIPT = Path('test', 'fixture', 'linter', 'broken.vim')
@@ -86,7 +87,7 @@ def test_lint(self):
         }
 
         linter = Linter(policy_set, config_dict_global)
-        got_violations = linter.lint_file(INVALID_VIM_SCRIPT)
+        got_violations = linter.lint(LintTargetFile(INVALID_VIM_SCRIPT))
 
         expected_violations = [
             {
@@ -147,7 +148,7 @@ def test_lint_with_broken_file(self):
         }
 
         linter = Linter(policy_set, config_dict_global)
-        got_violations = linter.lint_file(BROKEN_VIM_SCRIPT)
+        got_violations = linter.lint(LintTargetFile(BROKEN_VIM_SCRIPT))
 
         expected_violations = [
             {

test/unit/vint/ast/plugin/scope_plugin/test_call_node_parser.py

@@ -10,6 +10,7 @@
     get_lambda_string_expr_content,
     FUNCTION_REFERENCE_STRING_EXPR_CONTENT,
 )
+from vint.linting.lint_target import LintTargetFile
 
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
@@ -27,7 +28,7 @@ class Fixtures(enum.Enum):
 class TestCallNodeParser(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path.value)
+        ast = parser.parse(LintTargetFile(file_path.value))
         return ast
 
 

test/unit/vint/ast/plugin/scope_plugin/test_identifier_classifier.py

@@ -21,6 +21,7 @@
     IDENTIFIER_ATTRIBUTE_LAMBDA_ARGUMENT_FLAG,
     IDENTIFIER_ATTRIBUTE_LAMBDA_BODY_CONTEXT,
 )
+from vint.linting.lint_target import LintTargetFile
 
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
@@ -64,7 +65,7 @@
 class TestIdentifierClassifier(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path)
+        ast = parser.parse(LintTargetFile(file_path))
         return ast
 
 

test/unit/vint/ast/plugin/scope_plugin/test_identifier_collector.py

@@ -3,6 +3,7 @@
 
 from vint.ast.parsing import Parser
 from vint.ast.plugin.scope_plugin.identifier_classifier import IdentifierClassifier
+from vint.linting.lint_target import LintTargetFile
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
 
@@ -15,7 +16,7 @@
 class TestIdentifierCollector(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path)
+        ast = parser.parse(LintTargetFile(file_path))
 
         id_classifier = IdentifierClassifier()
         attached_ast = id_classifier.attach_identifier_attributes(ast)

test/unit/vint/ast/plugin/scope_plugin/test_redir_assignment_parser.py

@@ -9,6 +9,7 @@
     RedirAssignmentParser,
     get_redir_content,
 )
+from vint.linting.lint_target import LintTargetFile
 
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
@@ -22,7 +23,7 @@ class Fixtures(enum.Enum):
 class TestRedirAssignmentParser(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path.value)
+        ast = parser.parse(LintTargetFile(file_path.value))
         return ast
 
 

test/unit/vint/ast/plugin/scope_plugin/test_reference_reachability_tester.py

@@ -8,6 +8,7 @@
     is_reachable_reference_identifier,
     is_referenced_declarative_identifier,
 )
+from vint.linting.lint_target import LintTargetFile
 
 
 FIXTURE_BASE_PATH = Path('test', 'fixture', 'ast', 'scope_plugin')
@@ -31,7 +32,7 @@ class Fixtures(enum.Enum):
 class TestReferenceReachabilityTester(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path.value)
+        ast = parser.parse(LintTargetFile(file_path.value))
         return ast
 
 

test/unit/vint/ast/plugin/scope_plugin/test_scope_linker.py

@@ -4,6 +4,8 @@
 from pathlib import Path
 
 from vint.ast.parsing import Parser
+from vint.ast.plugin.scope_plugin.scope_linker import ScopeLinker, ScopeVisibility
+from vint.linting.lint_target import LintTargetFile
 from vint.ast.plugin.scope_plugin.scope_linker import ScopeLinker
 from vint.ast.plugin.scope_plugin.scope import (
     Scope,
@@ -34,7 +36,8 @@ class Fixtures(enum.Enum):
 class TestScopeLinker(unittest.TestCase):
     def create_ast(self, file_path):
         parser = Parser()
-        ast = parser.parse_file(file_path.value)
+        lint_target = LintTargetFile(file_path.value)
+        ast = parser.parse(lint_target)
         return ast
 
 

test/unit/vint/ast/test_parsing.py

@@ -1,6 +1,7 @@
 import unittest
 from vint.ast.parsing import Parser
 from vint.ast.node_type import NodeType
+from vint.linting.lint_target import LintTargetFile
 from test.asserting.ast import get_fixture_path
 
 FIXTURE_FILE = get_fixture_path('fixture_to_parse.vim')
@@ -10,27 +11,27 @@
 
 
 class TestParser(unittest.TestCase):
-    def test_parse_file(self):
+    def test_parse(self):
         parser = Parser()
-        ast = parser.parse_file(FIXTURE_FILE)
+        ast = parser.parse(LintTargetFile(FIXTURE_FILE))
         self.assertIs(ast['type'], 1)
 
 
     def test_parse_file_on_ff_dos_and_fenc_cp932(self):
         parser = Parser()
-        ast = parser.parse_file(FIXTURE_FILE_FF_DOS_FENC_CP932)
+        ast = parser.parse(LintTargetFile(FIXTURE_FILE_FF_DOS_FENC_CP932))
         self.assertIs(ast['type'], 1)
 
 
     def test_parse_file_when_neovim_enabled(self):
         parser = Parser(enable_neovim=True)
-        ast = parser.parse_file(FIXTURE_FILE_NEOVIM)
+        ast = parser.parse(LintTargetFile(FIXTURE_FILE_NEOVIM))
         self.assertIs(ast['type'], 1)
 
 
     def test_parse_empty_file(self):
         parser = Parser()
-        ast = parser.parse_file(FIXTURE_FILE_EMPTY)
+        ast = parser.parse(LintTargetFile(FIXTURE_FILE_EMPTY))
         self.assertIs(ast['type'], 1)
 
 

test/unit/vint/ast/test_traversing.py

@@ -4,14 +4,15 @@
 from vint.ast.parsing import Parser
 from vint.ast.node_type import NodeType
 from vint.ast.traversing import traverse, SKIP_CHILDREN
+from vint.linting.lint_target import LintTargetFile
 
 FIXTURE_FILE = get_fixture_path('fixture_to_traverse.vim')
 
 
 class TestTraverse(unittest.TestCase):
     def setUp(self):
         parser = Parser()
-        self.ast = parser.parse_file(FIXTURE_FILE)
+        self.ast = parser.parse(LintTargetFile(FIXTURE_FILE))
 
     def test_traverse(self):
         expected_order_of_events = [

test/unit/vint/linting/config/test_config_next_line_comment_source.py

@@ -1,6 +1,7 @@
 import unittest
 import enum
 from vint.linting.linter import Linter
+from vint.linting.lint_target import LintTargetFile
 from vint.linting.policy_set import PolicySet
 from vint.ast.node_type import NodeType
 from vint.linting.level import Level
@@ -20,9 +21,10 @@ def test_simple_example(self):
         global_config_dict = {'cmdargs': {'severity': Level.ERROR}}
         policy_set = PolicySet([TestConfigNextLineCommentSource.ProhibitStringPolicy])
         linter = Linter(policy_set, global_config_dict)
+        lint_target = LintTargetFile(Fixtures.SIMPLE.value)
 
         reported_string_node_values = [violation['description']
-                                       for violation in linter.lint_file(Fixtures.SIMPLE.value)]
+                                       for violation in linter.lint(lint_target)]
 
         self.assertEqual(reported_string_node_values, [
             "'report me because I have no line config comments'",
@@ -34,9 +36,10 @@ def test_lambda_string_expr(self):
         global_config_dict = {'cmdargs': {'severity': Level.ERROR}}
         policy_set = PolicySet([TestConfigNextLineCommentSource.ProhibitStringPolicy])
         linter = Linter(policy_set, global_config_dict)
+        lint_target = LintTargetFile(Fixtures.LAMBDA_STRING_EXPR.value)
 
         reported_string_node_values = [violation['description']
-                                       for violation in linter.lint_file(Fixtures.LAMBDA_STRING_EXPR.value)]
+                                       for violation in linter.lint(lint_target)]
 
         self.assertEqual(reported_string_node_values, [
             "'report me because I have no line config comments'",

test/unit/vint/linting/formatter/test_json_formatter.py

@@ -9,8 +9,7 @@
 
 class TestJSONFormatter(FormatterAssertion, unittest.TestCase):
     def test_format_violations(self):
-        cmdargs = {}
-        formatter = JSONFormatter(cmdargs)
+        formatter = JSONFormatter()
 
         violations = [
             {
@@ -21,7 +20,7 @@ def test_format_violations(self):
                 'position': {
                     'line': 1,
                     'column': 2,
-                    'path': Path('path', 'to', 'file1')
+                    'path': str(Path('path', 'to', 'file1'))
                 },
             },
             {
@@ -32,7 +31,7 @@ def test_format_violations(self):
                 'position': {
                     'line': 11,
                     'column': 21,
-                    'path': Path('path', 'to', 'file2')
+                    'path': str(Path('path', 'to', 'file2'))
                 },
             },
         ]