tools: run additional linters

justfile

@@ -79,5 +79,6 @@ lint-format:
     #!/usr/bin/env bash
     shopt -s globstar
     clang-format -i **/*.{c,h}
+    tools/additional_lint
 
 lint: (lint-imports) (lint-format)

tools/additional_lint

@@ -0,0 +1,83 @@
+#!/usr/bin/env python3
+import sys
+from collections.abc import Callable, Iterable
+from dataclasses import dataclass
+from pathlib import Path
+
+from shared.common import DATA_DIR, REPO_DIR, SRC_DIR, TOOLS_DIR
+
+EXTENSIONS = [
+    "Dockerfile",
+    ".h",
+    ".c",
+    ".build",
+    ".ninja",
+    ".py",
+    ".cs",
+    ".xaml",
+    ".csproj",
+    ".txt",
+    ".rc",
+    ".glsl",
+    ".md",
+    ".json",
+    ".json5",
+    "Dockerfile",
+]
+
+
+@dataclass
+class LintWarning:
+    path: Path
+    message: str
+    line: int | None = None
+
+    def __str__(self) -> str:
+        prefix = str(self.path.relative_to(REPO_DIR))
+        if self.line is not None:
+            prefix += f":{self.line}"
+        return f"{prefix}: {self.message}"
+
+
+def get_files() -> Iterable[Path]:
+    for root_dir in (DATA_DIR, SRC_DIR, TOOLS_DIR):
+        for path in root_dir.rglob("**/*"):
+            if path.is_file() and path.suffix in EXTENSIONS:
+                yield path
+
+
+def lint_newlines(path: Path) -> Iterable[LintWarning]:
+    text = path.read_text()
+    if text and not text.endswith("\n"):
+        yield LintWarning(path, "missing newline character at end of file")
+
+
+def lint_trailing_whitespace(path: Path) -> Iterable[LintWarning]:
+    for i, line in enumerate(path.open("r"), 1):
+        if line.rstrip("\n").endswith(" "):
+            yield LintWarning(path, "trailing whitespace", line=i)
+
+
+LINTERS: list[Callable[[], Iterable[LintWarning]]] = [
+    lint_newlines,
+    lint_trailing_whitespace,
+]
+
+
+def main() -> None:
+    files = get_files()
+
+    exit_code = 0
+    for file in files:
+        for linter in LINTERS:
+            for lint_warning in linter(file):
+                print(
+                    str(lint_warning),
+                    file=sys.stderr,
+                )
+                exit_code = 1
+
+    exit(exit_code)
+
+if __name__ == "__main__":
+    main()

tools/config/TR1X_ConfigTool/Controls/CategoryControl.xaml

@@ -1,11 +1,11 @@
-<UserControl
+<UserControl
     x:Class="TR1X_ConfigTool.Controls.CategoryControl"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     xmlns:controls="clr-namespace:TR1X_ConfigTool.Controls"
-    mc:Ignorable="d" 
+    mc:Ignorable="d"
     d:DesignHeight="450"
     d:DesignWidth="800">
 

tools/config/TR1X_ConfigTool/Controls/MainWindow.xaml

@@ -1,4 +1,4 @@
-<Window
+<Window
     x:Class="TR1X_ConfigTool.MainWindow"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
@@ -16,7 +16,7 @@
     Height="575"
     MinWidth="620"
     MinHeight="355">
-    
+
     <Window.Resources>
         <ResourceDictionary>
             <utils:BoolToVisibilityConverter
@@ -35,22 +35,22 @@
     </Window.Resources>
 
     <Window.InputBindings>
-        <utils:RelayKeyBinding 
+        <utils:RelayKeyBinding
             CommandBinding="{Binding OpenCommand}"
             Modifiers="Ctrl"
             Key="O" />
-        <utils:RelayKeyBinding 
+        <utils:RelayKeyBinding
             CommandBinding="{Binding ReloadCommand}"
             Key="F5" />
-        <utils:RelayKeyBinding 
+        <utils:RelayKeyBinding
             CommandBinding="{Binding SaveCommand}"
             Modifiers="Ctrl"
             Key="S" />
-        <utils:RelayKeyBinding 
+        <utils:RelayKeyBinding
             CommandBinding="{Binding SaveAsCommand}"
             Modifiers="Ctrl+Alt"
             Key="S" />
-        <utils:RelayKeyBinding 
+        <utils:RelayKeyBinding
             CommandBinding="{Binding GitHubCommand}"
             Key="F11" />
     </Window.InputBindings>
@@ -121,7 +121,7 @@
                 Visibility="{Binding IsEditorActive, Converter={StaticResource BoolToHiddenConverter}}"/>
             <StatusBarItem>
                 <TextBlock
-                    Text="{Binding IsEditorDirty, Converter={utils:ConditionalViewTextConverter TrueValue='label_unsaved', FalseValue='label_saved'}}" 
+                    Text="{Binding IsEditorDirty, Converter={utils:ConditionalViewTextConverter TrueValue='label_unsaved', FalseValue='label_saved'}}"
                     Foreground="{Binding IsEditorDirty, Converter={utils:ConditionalMarkupConverter TrueValue='DarkRed', FalseValue='DarkGreen'}}"
                     FontWeight="Bold"
                     Visibility="{Binding IsEditorActive, Converter={StaticResource BoolToHiddenConverter}}"/>
@@ -134,7 +134,7 @@
                 <RowDefinition Height="*"/>
                 <RowDefinition Height="Auto"/>
             </Grid.RowDefinitions>
-            
+
             <TabControl
                 Margin="0,0,0,7"
                 Padding="0"
@@ -185,7 +185,7 @@
                         Style="{StaticResource ButtonStyle}"/>
 
                     <Button
-                        Grid.Column="1" 
+                        Grid.Column="1"
                         Margin="7,0,0,0"
                         Command="{Binding LaunchGameCommand}"
                         Content="{Binding ViewText[command_launch_game]}"

tools/config/TR1X_ConfigTool/Controls/NumericUpDown.xaml

@@ -1,11 +1,11 @@
-<UserControl
+<UserControl
     x:Class="TR1X_ConfigTool.Controls.NumericUpDown"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     xmlns:utils="clr-namespace:TR1X_ConfigTool.Utils"
-    mc:Ignorable="d" 
+    mc:Ignorable="d"
     d:DesignHeight="25"
     d:DesignWidth="140">
 
@@ -34,11 +34,11 @@
             </Grid.RowDefinitions>
 
             <TextBox
-                x:Name="_textBox" 
+                x:Name="_textBox"
                 PreviewKeyDown="TextBox_PreviewKeyDown"
-                PreviewTextInput="TextBox_TextInput" 
+                PreviewTextInput="TextBox_TextInput"
-                TextChanged="TextBox_TextChanged" 
+                TextChanged="TextBox_TextChanged"
-                DataObject.Pasting="TextBox_Pasting"                 
+                DataObject.Pasting="TextBox_Pasting"
                 LostFocus="TextBox_LostFocus"
                 Grid.RowSpan="3"
                 Style="{StaticResource NumericTextBoxStyle}">
@@ -70,13 +70,13 @@
                 Style="{StaticResource FlatRepeatButtonStyle}"/>
 
             <Border
-                Background="#666" 
+                Background="#666"
                 Grid.Column="1"
                 Grid.Row="1"/>
 
             <RepeatButton
                 Command="{Binding Data.SpinDownCommand, Source={StaticResource controlProxy}}"
-                Grid.Column="1" 
+                Grid.Column="1"
                 Grid.Row="2"
                 Content="..\Resources\arrow-down.png"
                 ToolTip="{Binding Data.ViewText[spinner_decrease], Source={StaticResource windowProxy}}"

tools/config/TR1X_ConfigTool/Controls/PropertyControl.xaml

@@ -1,4 +1,4 @@
-<UserControl
+<UserControl
     x:Class="TR1X_ConfigTool.Controls.PropertyControl"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
@@ -6,15 +6,15 @@
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     xmlns:controls="clr-namespace:TR1X_ConfigTool.Controls"
     xmlns:models="clr-namespace:TR1X_ConfigTool.Models"
-    mc:Ignorable="d" 
+    mc:Ignorable="d"
     d:DesignHeight="450"
     d:DesignWidth="800">
-    
+
     <StackPanel>
         <TextBlock
             Text="{Binding Title}"
             Style="{StaticResource PropertyTitleStyle}"/>
-        
+
         <TextBlock
             Text="{Binding Description}"
             Style="{StaticResource PropertyDescriptionStyle}"/>

tools/config/TR1X_ConfigTool/Models/Specification/Configuration.cs

@@ -1,4 +1,4 @@
-using Newtonsoft.Json;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System.Collections.Generic;
 using System.IO;
@@ -81,7 +81,7 @@ public class Configuration
 
     public void Read(string jsonPath)
     {
-        JObject externalData = File.Exists(jsonPath) 
+        JObject externalData = File.Exists(jsonPath)
             ? JObject.Parse(File.ReadAllText(jsonPath))
             : new();
         JObject activeData = new();

tools/config/TR1X_ConfigTool/Models/Specification/Types/EnumProperty.cs

@@ -1,11 +1,11 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 
 namespace TR1X_ConfigTool.Models;
 
 public class EnumProperty : BaseProperty
 {
     public string EnumKey { get; set; }
-    
+
     private EnumOption _value;
 
     public EnumOption Value

tools/config/TR1X_ConfigTool/Resources/styles.xaml

@@ -159,7 +159,7 @@
             <Setter.Value>
                 <ControlTemplate
                     TargetType="{x:Type RepeatButton}">
-                    <Border 
+                    <Border
                         Background="{TemplateBinding Background}"
                         Padding="0,2"
                         BorderThickness="1,0,0,0"

tools/mac/x86-64_cross_file.txt

@@ -9,4 +9,4 @@ pkg-config = '/opt/local/bin/pkg-config'
 system = 'darwin'
 cpu_family = 'x86_64'
 cpu = 'x86_64'
-endian = 'little'
+endian = 'little'

tools/shared/common.py

@@ -0,0 +1,6 @@
+from pathlib import Path
+
+TOOLS_DIR = Path(__file__).parent.parent
+REPO_DIR = TOOLS_DIR.parent
+DATA_DIR = REPO_DIR / "src"
+SRC_DIR = REPO_DIR / "src"

tools/sort_imports

@@ -5,9 +5,7 @@ from pathlib import Path
 from shutil import which
 from subprocess import run
 
-TOOLS_DIR = Path(__file__).parent
+from shared.common import SRC_DIR
-REPO_DIR = TOOLS_DIR.parent
-SRC_PATH = REPO_DIR / "src"
 
 
 def fix_imports(path: Path) -> None:
@@ -34,7 +32,7 @@ def custom_sort(source: list[str], forced_order: list[str]) -> list[str]:
 
 def sort_imports(path: Path) -> None:
     source = path.read_text()
-    rel_path = path.relative_to(SRC_PATH)
+    rel_path = path.relative_to(SRC_DIR)
     own_include = str(rel_path.with_suffix(".h"))
     own_include = {
         # files headers of which are not a 1:1 match with their filename
@@ -112,8 +110,8 @@ def main() -> None:
     if not paths:
         paths = sorted(
             path
-            for path in SRC_PATH.glob("**/*.[ch]")
+            for path in SRC_DIR.glob("**/*.[ch]")
-            if path != SRC_PATH / "init.c"
+            if path != SRC_DIR / "init.c"
         )
 
     for path in paths: