Skip to content

Commit 04af035

Browse files
committed
[GR-66576] Add pre-commit configuration
PullRequest: graalpython/3862
2 parents de20299 + 71c08b6 commit 04af035

File tree

4 files changed

+129
-1
lines changed

4 files changed

+129
-1
lines changed

.pre-commit-config.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
repos:
2+
- repo: local
3+
hooks:
4+
- id: checkcopyrights
5+
name: Copyright check
6+
language: system
7+
entry: mx python-checkcopyrights --assumed-modified --fix --files
8+
types: [text]
9+
- id: eclipseformat
10+
name: Eclipse formatter
11+
language: system
12+
entry: bash scripts/pre-commit-eclipseformat.sh
13+
types: [text]
14+
files: '\.java$'
15+
- id: checkstyle
16+
name: Checkstyle
17+
language: system
18+
entry: bash scripts/pre-commit-checkstyle.sh
19+
types: [text]
20+
files: '\.java$'
21+
- id: pylint
22+
name: Pylint on mx files
23+
language: system
24+
pass_filenames: false
25+
entry: mx --primary pylint --primary
26+
types: [text]
27+
files: '^mx\.graalpython/.*\.py$'
28+
- repo: https://github.com/pre-commit/pre-commit-hooks
29+
rev: v5.0.0
30+
hooks:
31+
- id: trailing-whitespace
32+
name: Trim Trailing Whitespace
33+
entry: trailing-whitespace-fixer
34+
language: python
35+
types: [text]
36+
files: '\.(java|py|md|c|h|sh)$'

mx.graalpython/mx_graalpython.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2000,10 +2000,20 @@ def python_checkcopyrights(args):
20002000
if mx.is_windows():
20012001
# skip, broken with crlf stuff
20022002
return
2003+
files = None
2004+
if '--files' in args:
2005+
i = args.index('--files')
2006+
files = args[i + 1:]
2007+
args = args[:i]
20032008
# we wan't to ignore lib-python/3, because that's just crazy
20042009
listfilename = tempfile.mktemp()
20052010
with open(listfilename, "w") as listfile:
2006-
mx.run(["git", "ls-tree", "-r", "HEAD", "--name-only"], out=listfile)
2011+
if files is None:
2012+
mx.run(["git", "ls-tree", "-r", "HEAD", "--name-only"], out=listfile)
2013+
else:
2014+
for x in files:
2015+
listfile.write(x)
2016+
listfile.write('\n')
20072017
with open(listfilename, "r") as listfile:
20082018
content = listfile.read()
20092019
with open(listfilename, "w") as listfile:

scripts/pre-commit-checkstyle.sh

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
2+
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3+
#
4+
# The Universal Permissive License (UPL), Version 1.0
5+
#
6+
# Subject to the condition set forth below, permission is hereby granted to any
7+
# person obtaining a copy of this software, associated documentation and/or
8+
# data (collectively the "Software"), free of charge and under any and all
9+
# copyright rights in the Software, and any and all patent rights owned or
10+
# freely licensable by each licensor hereunder covering either (i) the
11+
# unmodified Software as contributed to or provided by such licensor, or (ii)
12+
# the Larger Works (as defined below), to deal in both
13+
#
14+
# (a) the Software, and
15+
#
16+
# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
17+
# one is included with the Software each a "Larger Work" to which the Software
18+
# is contributed by such licensors),
19+
#
20+
# without restriction, including without limitation the rights to copy, create
21+
# derivative works of, display, perform, and distribute the Software and make,
22+
# use, sell, offer for sale, import, export, have made, and have sold the
23+
# Software and the Larger Work(s), and to sublicense the foregoing rights on
24+
# either these or other terms.
25+
#
26+
# This license is subject to the following condition:
27+
#
28+
# The above copyright notice and either this complete permission notice or at a
29+
# minimum a reference to the UPL must be included in all copies or substantial
30+
# portions of the Software.
31+
#
32+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38+
# SOFTWARE.
39+
40+
#!/bin/bash
41+
mx -p "$suite" checkstyle --primary --fix-unused-imports --filelist <(echo "${@}" | tr ' ' '\n')

scripts/pre-commit-eclipseformat.sh

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
2+
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3+
#
4+
# The Universal Permissive License (UPL), Version 1.0
5+
#
6+
# Subject to the condition set forth below, permission is hereby granted to any
7+
# person obtaining a copy of this software, associated documentation and/or
8+
# data (collectively the "Software"), free of charge and under any and all
9+
# copyright rights in the Software, and any and all patent rights owned or
10+
# freely licensable by each licensor hereunder covering either (i) the
11+
# unmodified Software as contributed to or provided by such licensor, or (ii)
12+
# the Larger Works (as defined below), to deal in both
13+
#
14+
# (a) the Software, and
15+
#
16+
# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
17+
# one is included with the Software each a "Larger Work" to which the Software
18+
# is contributed by such licensors),
19+
#
20+
# without restriction, including without limitation the rights to copy, create
21+
# derivative works of, display, perform, and distribute the Software and make,
22+
# use, sell, offer for sale, import, export, have made, and have sold the
23+
# Software and the Larger Work(s), and to sublicense the foregoing rights on
24+
# either these or other terms.
25+
#
26+
# This license is subject to the following condition:
27+
#
28+
# The above copyright notice and either this complete permission notice or at a
29+
# minimum a reference to the UPL must be included in all copies or substantial
30+
# portions of the Software.
31+
#
32+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38+
# SOFTWARE.
39+
40+
#!/bin/bash
41+
mx eclipseformat --no-backup --primary --filelist <(echo "${@}" | tr ' ' '\n')

0 commit comments

Comments
 (0)