doc: Add License and pre-commit hook (#67)

.github/license-short.txt

@@ -0,0 +1,3 @@
+Copyright (c) 2021-2023 Arista Networks, Inc.
+Use of this source code is governed by the MIT license
+that can be found in the LICENSE file.

.pre-commit-config.yaml

@@ -1,5 +1,7 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+files: ^(j2lint|tests)/
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.4.0
@@ -10,6 +12,33 @@ repos:
       - id: check-added-large-files
       - id: check-merge-conflict
 
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.4
+    hooks:
+      - name: Check and insert license on Python files
+        id: insert-license
+        files: .*\.py$
+        args:
+          - --license-filepath
+          - .github/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --no-extra-eol
+
+      - name: Check and insert license on Jinja2 files
+        id: insert-license
+        files: .*\.j2$
+        args:
+          - --license-filepath
+          - .github/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --comment-style
+          - '{#||#}'
+          - --no-extra-eol
+
   - repo: https://github.com/pycqa/flake8
     rev: 6.1.0
     hooks:

j2lint/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """__init__.py - A command-line utility that checks for best practices in Jinja2.
 """
 NAME = "j2lint"

j2lint/__main__.py

@@ -1,4 +1,7 @@
 #!/usr/bin/python
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """__main__.py - A command-line utility that checks for best practices in Jinja2.
 """
 import sys

j2lint/cli.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """cli.py - Command line argument parser.
 """
 from __future__ import annotations

j2lint/linter/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.

j2lint/linter/collection.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """collection.py - Class to create a collection of linting rules.
 """
 from __future__ import annotations

j2lint/linter/error.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """error.py - Error classes to format the lint errors.
 """
 from __future__ import annotations

j2lint/linter/indenter/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.

j2lint/linter/indenter/node.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """node.py - Class node for creating a parse tree for jinja statements and
              checking jinja statement indentation.
 """

j2lint/linter/indenter/statement.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """statement.py - Class and variables for jinja statements.
 """
 from __future__ import annotations

j2lint/linter/rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """rule.py - Base class for all the lint rules with functions for mathching
              line and text based rule.
 """

j2lint/linter/runner.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """runner.py - Class to run the rules collection for all the files.
 """
 from __future__ import annotations

j2lint/logger.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """logger.py - Creates logger object.
 """
 import logging

j2lint/rules/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.

j2lint/rules/jinja_operator_has_spaces_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_operator_has_spaces_rule.py - Rule class to check if operator has
                                   surrounding spaces.
 """

j2lint/rules/jinja_statement_delimiter_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_statement_delimiter_rule.py - Rule class to check if jinja delimiters
                                     are wrong.
 """

j2lint/rules/jinja_statement_has_spaces_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_statement_has_spaces_rule.py - Rule class to check if jinja statement has
                                         at least a single space surrounding the
                                         delimiter.

j2lint/rules/jinja_template_indentation_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_template_indentation_rule.py - Rule class to check the jinja statement
                                      indentation is correct.
 """

j2lint/rules/jinja_template_no_tabs_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_template_no_tabs_rule.py - Rule class to check the file does not use tabs
                                 for indentation.
 """

j2lint/rules/jinja_template_single_statement_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_template_single_statement_rule.py - Rule class to check if only a single
                                          jinja statement is present on each
                                          line.

j2lint/rules/jinja_template_syntax_error_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_template_syntax_error_rule.py - Rule class to check that file does not
                                      have jinja syntax errors.
 """

j2lint/rules/jinja_variable_has_space_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_variable_has_space_rule.py - Rule class to check if jinja variables have
                                   single space between curly brackets and
                                   variable name.

j2lint/rules/jinja_variable_name_case_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """jinja_variable_name_case_rule.py - Rule class to check the variables use
                                   lower case.
 """

j2lint/rules/jinja_variable_name_format_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """ jinja_variable_name_format_rule.py - Rule class to check that variable names
                                      only use underscores.
 """

j2lint/utils.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """utils.py - Utility functions for jinja2 linter.
 """
 from __future__ import annotations

tests/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.

tests/conftest.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 content of conftest.py
 """

tests/data/test.j2

@@ -0,0 +1,5 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}

tests/test_cli.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.cli.py
 """

tests/test_linter/data/disable-rule-3.j2

@@ -1,2 +1,7 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {# j2lint: disable=test-rule-3 #}
 blah

tests/test_linter/data/test.j2

@@ -0,0 +1,5 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}

tests/test_linter/test_collection.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.collection.py
 """

tests/test_linter/test_error.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.error.py
 """

tests/test_linter/test_indenter/test_node.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.node.py
 """

tests/test_linter/test_indenter/test_statement.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.indenter.statement.py
 

tests/test_linter/test_rule.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.rule.py
 """
@@ -49,7 +52,7 @@ def test_is_valid_language(self, test_rule, file):
                 None,
                 1,
                 {"path": f"{TEST_DATA_DIR}/test.j2"},
-                [("T0", 42)],
+                [("T0", 42), ("T0", 42), ("T0", 42), ("T0", 42), ("T0", 42)],
                 [],
                 id="checkline rule error",
             ),

tests/test_linter/test_runner.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.linter.runner.py
 """

tests/test_logger.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2021-2023 Arista Networks, Inc.
+# Use of this source code is governed by the MIT license
+# that can be found in the LICENSE file.
 """
 Tests for j2lint.logger.py
 """

tests/test_rules/data/jinja_operator_has_spaces_rule.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {{ test|list }}
 {{ test| list }}
 {{ test |list }}

tests/test_rules/data/jinja_statement_delimiter_rule.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {%+ if test %}
 {% endif %}
 {%- if test %}

tests/test_rules/data/jinja_statement_has_spaces_rule.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {%set test=42%}
 {% set test=42%}
 {%set test=42 %}

tests/test_rules/data/jinja_template_indentation_rule.IndexError.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 7{% if test %}
 {% set tets=42%}
 {% endif %}

tests/test_rules/data/jinja_template_indentation_rule.JinjaLinterError.j2

@@ -1,2 +1,7 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {% if test %}
 {% endfor %}

tests/test_rules/data/jinja_template_indentation_rule.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {% if test %}
 {%  endif %}
 

tests/test_rules/data/jinja_template_indentation_rule.missing_end_tag.j2

@@ -1,2 +1,7 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {% if test %}
 {# missing the endif #}

tests/test_rules/data/jinja_template_no_tabs_rule.j2

@@ -1 +1,6 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 	I put a tab before

tests/test_rules/data/jinja_template_single_statement_rule.j2

@@ -1 +1,6 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {% set test=42 %}{% set blah=43 %}

tests/test_rules/data/jinja_template_syntax_error_rule.j2

@@ -1 +1,6 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {% set test %}

tests/test_rules/data/jinja_variable_has_space_rule.j2

@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2021-2023 Arista Networks, Inc.
+ Use of this source code is governed by the MIT license
+ that can be found in the LICENSE file.
+#}
 {{ethernet}}
 {{ ethernet}}
 # Too many spaces