linting: enforce space after license comment for python files

Signed-off-by: James McCorrie <[email protected]>

Author: machshev

.envrc

@@ -1,6 +1,7 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 use flake
 
 # create the venv if it doesn't yet exist

.github/workflows/ci.yml

@@ -1,6 +1,7 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 name: Python application
 
 on:

.gitignore

@@ -1,6 +1,7 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

pyproject.toml

@@ -1,6 +1,7 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 [project]
 name = "dvsim"
 version = "0.1.0"

scripts/license_check.py

@@ -2,6 +2,7 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 """Check all files for license header."""
 
 import subprocess
@@ -25,8 +26,10 @@
 
 IGNORE_SUFFIXES = [".lock"]
 
+OPTIONAL_TRAILING_NEWLINE = [".nix", ".md"]
+
 
-def check_header(text: str) -> bool:
+def check_header(*, text: str, trailing_newline_optional: bool = False) -> bool:
     """Check header complies with license requirmeents."""
     lines = text.splitlines()
 
@@ -37,6 +40,7 @@ def check_header(text: str) -> bool:
                     LICENSE[0] in lines[i],
                     LICENSE[1] in lines[i + 1],
                     LICENSE[2] in lines[i + 2],
+                    trailing_newline_optional or lines[i + 3] == "",
                 ]
             ):
                 return True
@@ -75,7 +79,10 @@ def check_header(text: str) -> bool:
 
     logger.debug("Checking: %s", path)
 
-    if not check_header(text):
+    if not check_header(
+        text=text,
+        trailing_newline_optional=path.suffix in OPTIONAL_TRAILING_NEWLINE,
+    ):
         failed.append(path)
 
 for path in failed:

src/dvsim/__init__.py

@@ -1,4 +1,5 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
+
 """DVSim."""

src/dvsim/cli.py

@@ -1,9 +1,11 @@
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
-"""dvsim is a command line tool to deploy ASIC tool flows such as regressions
-for design verification (DV), formal property verification (FPV), linting and
-synthesis.
+
+"""dvsim is a command line tool to deploy ASIC tool flows.
+
+Examples of a supported flow is regressions for design verification (DV),
+formal property verification (FPV), linting and synthesis.
 
 It uses hjson as the format for specifying what to build and run. It is an
 end-to-end regression manager that can deploy multiple builds (where some tests

src/dvsim/examples/testplanner/common_testplan.hjson

@@ -1,6 +1,7 @@
 // Copyright lowRISC contributors (OpenTitan project).
 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
 // SPDX-License-Identifier: Apache-2.0
+
 {
   testpoints: [
     {

src/dvsim/examples/testplanner/foo_sim_results.hjson

@@ -1,6 +1,7 @@
 // Copyright lowRISC contributors (OpenTitan project).
 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
 // SPDX-License-Identifier: Apache-2.0
+
 {
   timestamp: 10/10/2019 1:55AM
   test_results: [

src/dvsim/examples/testplanner/foo_testplan.hjson

@@ -1,6 +1,7 @@
 // Copyright lowRISC contributors (OpenTitan project).
 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
 // SPDX-License-Identifier: Apache-2.0
+
 {
   // 'name' is mandatory field
   name: "foo"