summaryrefslogtreecommitdiffstats
path: root/third_party/python/yamllint/yamllint/rules/document_end.py
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/python/yamllint/yamllint/rules/document_end.py')
-rw-r--r--third_party/python/yamllint/yamllint/rules/document_end.py107
1 files changed, 107 insertions, 0 deletions
diff --git a/third_party/python/yamllint/yamllint/rules/document_end.py b/third_party/python/yamllint/yamllint/rules/document_end.py
new file mode 100644
index 0000000000..e98aac1d12
--- /dev/null
+++ b/third_party/python/yamllint/yamllint/rules/document_end.py
@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2016 Adrien Vergé
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Use this rule to require or forbid the use of document end marker (``...``).
+
+.. rubric:: Options
+
+* Set ``present`` to ``true`` when the document end marker is required, or to
+ ``false`` when it is forbidden.
+
+.. rubric:: Examples
+
+#. With ``document-end: {present: true}``
+
+ the following code snippet would **PASS**:
+ ::
+
+ ---
+ this:
+ is: [a, document]
+ ...
+ ---
+ - this
+ - is: another one
+ ...
+
+ the following code snippet would **FAIL**:
+ ::
+
+ ---
+ this:
+ is: [a, document]
+ ---
+ - this
+ - is: another one
+ ...
+
+#. With ``document-end: {present: false}``
+
+ the following code snippet would **PASS**:
+ ::
+
+ ---
+ this:
+ is: [a, document]
+ ---
+ - this
+ - is: another one
+
+ the following code snippet would **FAIL**:
+ ::
+
+ ---
+ this:
+ is: [a, document]
+ ...
+ ---
+ - this
+ - is: another one
+"""
+
+
+import yaml
+
+from yamllint.linter import LintProblem
+
+
+ID = 'document-end'
+TYPE = 'token'
+CONF = {'present': bool}
+DEFAULT = {'present': True}
+
+
+def check(conf, token, prev, next, nextnext, context):
+ if conf['present']:
+ is_stream_end = isinstance(token, yaml.StreamEndToken)
+ is_start = isinstance(token, yaml.DocumentStartToken)
+ prev_is_end_or_stream_start = isinstance(
+ prev, (yaml.DocumentEndToken, yaml.StreamStartToken)
+ )
+
+ if is_stream_end and not prev_is_end_or_stream_start:
+ yield LintProblem(token.start_mark.line, 1,
+ 'missing document end "..."')
+ elif is_start and not prev_is_end_or_stream_start:
+ yield LintProblem(token.start_mark.line + 1, 1,
+ 'missing document end "..."')
+
+ else:
+ if isinstance(token, yaml.DocumentEndToken):
+ yield LintProblem(token.start_mark.line + 1,
+ token.start_mark.column + 1,
+ 'found forbidden document end "..."')