1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
def define_env(env):
"""Define variables, macros, and filters.
Args:
env: The environment object used for defining macros and variables.
Returns:
None
"""
@env.macro
def include_file(filename: str) -> str:
"""Include the contents of a file.
Args:
filename (str): The name of the file to include.
Returns:
str: The content of the file with specific replacements made,
or an error message if the file is not found.
Raises:
FileNotFoundError: If the specified file cannot be found.
"""
try:
with open(filename, "r", encoding="utf-8") as file:
content = file.read().replace("website/docs/", "")
content = content.replace(
"[AUTHORS](AUTHORS)", "[AUTHORS](./authors.md)"
)
return content
except FileNotFoundError:
return f"File not found: {filename}"
@env.macro
def get_project_version() -> str:
"""Retrieve the project version from sonar-project.properties.
Returns:
str: The project version if found, or an error message if the file
cannot be read or the version is not specified.
"""
properties_file = "../sonar-project.properties"
try:
with open(properties_file, "r", encoding="utf-8") as file:
for line in file:
if line.startswith("sonar.projectVersion="):
# Extract and return the version number
return line.split("=", 1)[1].strip()
return "Version not found in the properties file."
except FileNotFoundError:
return f"File not found: {properties_file}"
|
