Add prek.toml for pre-commit hook support

.appveyor.yml

@@ -64,4 +64,3 @@ on_finish:
   - ps: .\.appveyor\coverage_report.ps1
   # running codecov in powershell causes an error so running in cmd
   - cmd: .appveyor\codecov_upload.bat
-

.appveyor/install.ps1

@@ -46,7 +46,7 @@ $toolPaths = @(
 )
 
 $env:PATH = ($pythonPaths + $toolPaths + @($env:PATH)) -join ';'
-# Ensure we have the correct path to the python executable, 
+# Ensure we have the correct path to the python executable,
 # explicitly avoiding MSYS/Cygwin versions.
 $pythonExe = $null
 

.codecov.yml

@@ -29,7 +29,7 @@ coverage:
   status:
     project:
       default:
-        # compare against the current coverage 
+        # compare against the current coverage
         # that PR is attempt to merge to
         # don't consider a drop in coverage success
         target: auto
@@ -38,7 +38,7 @@ coverage:
 
     patch:
       default:
-        # considering only the lines changed 
+        # considering only the lines changed
         # make sure all new lines in the PR are covered
         # to consider a success
         target: 100

.git-blame-ignore-revs

@@ -6,3 +6,5 @@ fbb026ef1145fe29e0ec3c1b66a3e99cac51e18d
 c9d9fa58b796532320a2248ddc5be07b7280adf3
 # Purge vim/emac variable bloat
 ad7207090187a6cd2657cce00096cfc4bc9c3010
+# Apply prek changes
+c06d493e214482f31c69a1159850f50844bf1466

.github/FUNDING.yml

@@ -2,4 +2,3 @@
 
 github: [bdbaddog, mwichmann]
 patreon: bdbaddog
-

.github/workflows/runtest.yml

@@ -11,6 +11,17 @@ defaults:
     shell: bash
 
 jobs:
+  prek:
+    timeout-minutes: 10
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Style checks via prek
+        uses: j178/prek-action@v2
+
   runtest:
     strategy:
       fail-fast: false

.travis/verify_packages.sh

@@ -29,4 +29,4 @@ if [[ $zip_man_files != $expected_man_file_count ]]; then
    retval=3
 fi
 
-exit $retval
+exit $retval

CHANGES.txt

@@ -35,6 +35,8 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
       existing test environments into a single package. Adjusted AppVeyor to
       only run for targets unsupported by GitHub runners.
     - Split `SCons.Util.UtilTests.py` to individual packages where appropriate.
+    - Added `prek.toml` to support pre-commit hooks.
+    - Added prek job to `runtest.yml`, ensuring pre-commit hooks are enforced.
 
   From William Deegan:
     - Fix SCons Docbook schema to work with lxml > 5

NEWS.d/changes/4306.bugfix

@@ -2,4 +2,3 @@
 When debugging (--debug=pdb), the filenames SConstruct and SConscript
 are now recognized when manipulating breakpoints. Previously, only a
 full pathname worked, as otherwise pdb required a .py extension on files.
-

README-SF.rst

@@ -613,4 +613,3 @@ many contributors, including but not at all limited to:
 \... and many others.
 
 Copyright (c) 2001 - 2026 The SCons Foundation
-

README-package.rst

@@ -196,4 +196,3 @@ Check the SCons web site at https://scons.org
 
 
 Copyright (c) 2001 - 2026 The SCons Foundation
-

README.rst

@@ -25,6 +25,9 @@ SCons - a Software Construction Tool
    :target: https://github.com/SCons/scons/actions?query=workflow%3A%22SCons+Build%22
    :alt: Github Actions
 
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
+    :target: https://github.com/j178/prek
+    :alt: prek
 
 What is SCons?
 ==============

RELEASE.txt

@@ -161,6 +161,9 @@ DEVELOPMENT
 
 - Split `SCons.Util.UtilTests.py` to individual packages where appropriate.
 
+- Added `prek.toml` to support pre-commit hooks.
+
+- Added prek job to `runtest.yml`, ensuring pre-commit hooks are enforced.
 
 Thanks to the following contributors listed below for their contributions to this release.
 ==========================================================================================

SCons/Node/FS.py

@@ -3878,4 +3878,3 @@ def invalidate_node_memos(targets: str | Node | list[str | Node]) -> None:
 EntryNode = Entry
 DirNode = Dir
 FileNode = File
-

SCons/Tool/GettextCommon.py

@@ -428,4 +428,3 @@ def _msgfmt_exists(env):
 def tool_list(platform, env):
     """ List tools that shall be generated by top-level `gettext` tool """
     return ['xgettext', 'msginit', 'msgmerge', 'msgfmt']
-

SCons/Tool/MSCommon/MSVC/Config.py

@@ -393,4 +393,3 @@ def verify():
         if vc_version not in MSVC_VERSION_INTERNAL:
             err_msg = f'vc_version {vc_version!r} not in MSVC_VERSION_INTERNAL'
             raise MSVCInternalError(err_msg)
-

SCons/Tool/MSCommon/MSVC/Exceptions.py

@@ -53,4 +53,3 @@ class MSVCSpectreLibsNotFound(MSVCUserError):
 
 class MSVCArgumentError(MSVCUserError):
     pass
-

SCons/Tool/MSCommon/MSVC/Policy.py

@@ -327,4 +327,3 @@ def msvc_scripterror_policy_contextmanager(MSVC_SCRIPTERROR_POLICY=None):
     prev_policy = msvc_set_scripterror_policy(MSVC_SCRIPTERROR_POLICY)
     yield
     msvc_set_scripterror_policy(prev_policy)
-

SCons/Tool/MSCommon/MSVC/PolicyTests.py

@@ -166,4 +166,3 @@ def test_scripterror_handler_error(self) -> None:
 
 if __name__ == "__main__":
     unittest.main()
-

SCons/Tool/MSCommon/MSVC/Registry.py

@@ -118,4 +118,3 @@ def vstudio_sxs_vc7(version):
 
 def devdiv_vs_servicing_component(version, component):
     return '\\'.join([r'DevDiv\VS\Servicing', version, component, 'Install'])
-

SCons/Tool/MSCommon/MSVC/RegistryTests.py

@@ -80,4 +80,3 @@ def test_windows_kit_query_paths(self) -> None:
 
 if __name__ == "__main__":
     unittest.main()
-

SCons/Tool/MSCommon/MSVC/ScriptArguments.py

@@ -1100,4 +1100,3 @@ def reset() -> None:
 def verify() -> None:
     debug('')
     _verify_re_sdk_dispatch_map()
-

SCons/Tool/MSCommon/MSVC/ScriptArgumentsTests.py

@@ -668,4 +668,3 @@ def test_reset(self) -> None:
 
 if __name__ == "__main__":
     unittest.main()
-

SCons/Tool/MSCommon/MSVC/SetupEnvDefault.py

@@ -233,4 +233,3 @@ def register_iserror(env, tool, msvc_exists_func):
 def reset() -> None:
     debug('')
     _Data.reset()
-

SCons/Tool/MSCommon/MSVC/Util.py

@@ -491,4 +491,3 @@ def msvc_sdk_version_components(version):
     )
 
     return msvc_sdk_version_components_def
-

SCons/Tool/MSCommon/MSVC/UtilTests.py

@@ -289,4 +289,3 @@ def test_msvc_sdk_version_components(self) -> None:
 
 if __name__ == "__main__":
     unittest.main()
-

SCons/Tool/MSCommon/MSVC/Warnings.py

@@ -32,4 +32,3 @@ class VisualCWarning(SCons.Warnings.WarningOnByDefault):
 
 class MSVCScriptExecutionWarning(VisualCWarning):
     pass
-

SCons/Tool/MSCommon/MSVC/WinSDK.py

@@ -261,4 +261,3 @@ def reset() -> None:
 def verify() -> None:
     debug('')
     _verify_sdk_dispatch_map()
-

SCons/Tool/MSCommon/MSVC/WinSDKTests.py

@@ -129,4 +129,3 @@ def test_reset(self) -> None:
 
 if __name__ == "__main__":
     unittest.main()
-

SCons/Tool/MSCommon/MSVC/__init__.py

@@ -53,4 +53,3 @@ def _reset() -> None:
 
 def _verify() -> None:
     _Dispatcher.verify()
-

SCons/Tool/MSCommon/README.rst

@@ -752,4 +752,3 @@ into the current document format as appropriate.
     - Since msvc_exists chain of calls does not look at version, we
       can proceed to compiler setup if *any* msvc was found, even if the
       one requested wasn't found.
-

SCons/Tool/MSCommon/vc.py

@@ -2883,4 +2883,3 @@ def msvc_query_version_toolset(version=None, prefer_newest: bool=True, vswhere_e
 
 # internal consistency check (should be last)
 MSVC._verify()
-

SCons/Tool/clangCommon/__init__.py

@@ -15,4 +15,4 @@ def get_clang_install_dirs(platform):
     if platform == 'win32':
         return clang_win32_dirs
     else:
-        return []
+        return []

SCons/Tool/docbook/docs/html.xsl

@@ -33,4 +33,3 @@ set       toc,title
 </xsl:param>
 
 </xsl:stylesheet>
-

SCons/Tool/docbook/docs/pdf.xsl

@@ -39,4 +39,3 @@ set       toc,title
 </xsl:template>
 
 </xsl:stylesheet>
-

SCons/Tool/javacTests.py

@@ -98,7 +98,7 @@ def test_default_unset(self) -> None:
             ['-foopath', '/foo'],
             '/foo',
             '')
-    
+
     def test_list_within_list(self) -> None:
         self.assert_pathopt(['-foopath', os.pathsep.join(['/foo','/bar'])],
                     ['/foo', ['/bar']])

SCons/Tool/linkCommon/README.md

@@ -40,15 +40,15 @@ Which will have a soname baked into it as one of the
    * `${SHLIBPREFIX}lib_name${major version only from SHLIBVERSION}${SHLIBSUFFIX}`
    * `-Wl,-compatibility_version,%s`
    * `-Wl,-current_version,%s`
-   
+
 For **applelink** the version has to follow these rules to verify that the version # is valid.
 
 * For version # = X[.Y[.Z]]
 * where X 0-65535
 * where Y either not specified or 0-255
 * where Z either not specified or 0-255
 
-   
+
 For most platforms this will lead to a series of symlinks eventually pointing to the actual shared library (or loadable module file).
 1. `${SHLIBPREFIX}lib_name${SHLIBSUFFIX} -> ${SHLIBPREFIX}lib_name${SHLIBVERSION}${SHLIBSUFFIX}`
 1. `${SHLIBPREFIX}lib_name${SOVERSION}${SHLIBSUFFIX} -> ${SHLIBPREFIX}lib_name${SHLIBVERSION}${SHLIBSUFFIX}`
@@ -84,6 +84,5 @@ Maybe we can force one at that point?
 SOVERSION can be specified, if not, then defaults to major portion of SHLIBVERSION
 SONAME can be specified, if not defaults to ${SHLIBPREFIX}lib_name${SOVERSION}
 
-NOTE: mongodb uses Append(SHLIBEMITTER=.. )  for their libdeps stuff. (So test 
+NOTE: mongodb uses Append(SHLIBEMITTER=.. )  for their libdeps stuff. (So test
 with that once you have new logic working)
-

SCons/__init__.py

@@ -6,4 +6,4 @@
 __revision__="9573362eaf4dadc6368ad27a75bc2790a3e5e813"
 __build__="9573362eaf4dadc6368ad27a75bc2790a3e5e813"
 # make sure compatibility is always in place
-import SCons.compat  # noqa
+import SCons.compat  # noqa

bench/time_member.py

@@ -46,4 +46,3 @@ def test_no_find_method() -> bool:
 print(f'.find() method time: {time_find:.6f} seconds')
 print(f'"not in" operator time: {time_not_in:.6f} seconds')
 print(f'.find() method time: {time_no_find:.6f} seconds')
-

bin/check_new_contributors.py

@@ -47,7 +47,7 @@ def get_contributors_since(tag: str) -> Set[Tuple[str, str]]:
     # Format: Name|Email
     cmd = ['git', 'log', f'{tag}..HEAD', '--format=%aN|%aE']
     output = get_git_output(cmd)
-    
+
     contributors = set()
     if output:
         for line in output.split('\n'):
@@ -72,7 +72,7 @@ def get_prior_emails(tag: str) -> Set[str]:
     print("Gathering prior contributors (this may take a moment)...")
     cmd = ['git', 'log', tag, '--format=%aE']
     output = get_git_output(cmd)
-    
+
     prior_emails = set()
     if output:
         for line in output.split('\n'):
@@ -102,30 +102,30 @@ def main() -> None:
 
     # Get all prior emails
     prior_emails = get_prior_emails(args.tag)
-    
+
     # Prepare data for display with deduplication
     # Map: display_name -> is_new (boolean)
     contributor_status: Dict[str, bool] = {}
-    
+
     for name, email in recent_contributors:
         display_name = name if name else email
         is_new_email = email.lower() not in prior_emails
-        
+
         if display_name not in contributor_status:
             contributor_status[display_name] = is_new_email
         else:
-            # If the contributor was previously marked as new, but this email 
+            # If the contributor was previously marked as new, but this email
             # is NOT new, then the contributor is not new.
             # If they were already marked as not new, they stay not new.
             if contributor_status[display_name] and not is_new_email:
                 contributor_status[display_name] = False
-    
+
     # Convert to list for sorting and display
     display_list = [(name, is_new) for name, is_new in contributor_status.items()]
-    
+
     # Sort by display name (case insensitive)
     display_list.sort(key=lambda x: x[0].lower())
-    
+
     # Calculate max length for alignment
     if display_list:
         max_length = max(len(x[0]) for x in display_list)
@@ -134,7 +134,7 @@ def main() -> None:
 
     print(f"\nContributors since {args.tag}:")
     print("-" * 40)
-    
+
     for display_name, is_new in display_list:
         # Align left with padding
         if is_new:
@@ -143,4 +143,4 @@ def main() -> None:
             print(f"{display_name}")
 
 if __name__ == "__main__":
-    main()
+    main()

bin/scp-sourceforge

@@ -1,5 +1,5 @@
 #!/bin/bash
-set -x 
+set -x
 set -e
 
 if [ -z "$1" ]; then

bin/xml_export

@@ -180,7 +180,7 @@ in all copies or substantial portions of the Software.
 2. Neither the names of VA Software Corporation, OSDN, SourceForge.net,
 the SourceForge.net Site Documentation project, nor the names of its
 contributors may be used to endorse or promote products derived from
-the Software without specific prior written permission of OSDN. 
+the Software without specific prior written permission of OSDN.
 
 3. The name and trademarks of copyright holders may NOT be used in
 advertising or publicity pertaining to the Software without specific,

bin/xml_export-README

@@ -52,5 +52,3 @@ of the provided manual.
 
 The authoritative source of this software is:
   https://sourceforge.net/projects/sitedocs
-
-