import os
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
def generate_contributing_section(repo_owner, repo_name, target_dir_relative, filename, language):
repo_url = f"https://github.com/{repo_owner}/{repo_name}"
if language == "zh":
contributing_section = f"""
{{/*
Contributing Section
DO NOT edit this section!
It will be automatically generated by the script.
*/}}
通过直接提交修改来帮助改进文档内容
发现错误或有改进建议？请提交问题反馈
"""
elif language == "en":
contributing_section = f"""
{{/*
Contributing Section
DO NOT edit this section!
It will be automatically generated by the script.
*/}}
Help improve our documentation by contributing directly
Found an error or have suggestions? Let us know
"""
elif language == "ja":
contributing_section = f"""
{{/*
Contributing Section
DO NOT edit this section!
It will be automatically generated by the script.
*/}}
直接貢献することでドキュメントの改善にご協力ください
エラーを見つけたり提案がありますか？お知らせください
"""
else:
raise ValueError("Unsupported language. Supported languages are 'zh', 'en', and 'jp'.")
return contributing_section
def append_content_to_files(
target_dir_relative, repo_owner, repo_name, language, base_dir=BASE_DIR, file_extension=".mdx"
):
target_path = os.path.join(base_dir, target_dir_relative)
if not os.path.isdir(target_path):
print(f"Error: Directory '{target_path}' not found.")
return
fix_md_endings(target_dir_relative, base_dir, file_extension)
appended_count = 0
error_count = 0
for filename in os.listdir(target_path):
if filename.endswith(file_extension):
filepath = os.path.join(target_path, filename)
try:
# Open in text append mode to write
with open(filepath, "a", encoding="utf-8") as f:
f.write(generate_contributing_section(repo_owner, repo_name, target_dir_relative, filename, language))
appended_count += 1
except (IOError, OSError) as e:
print(f"Error processing file {filepath}: {e}")
error_count += 1
print(
f"Finished processing directory '{target_path}'. "
f"Appended to {appended_count} files. Encountered {error_count} errors."
)
def remove_contributing_section(target_dir_relative, base_dir=BASE_DIR, file_extension=".mdx"):
import re
target_path = os.path.join(base_dir, target_dir_relative)
if not os.path.isdir(target_path):
print(f"Error: Directory '{target_path}' not found.")
return
removed_count = 0
error_count = 0
for filename in os.listdir(target_path):
if filename.endswith(file_extension):
filepath = os.path.join(target_path, filename)
try:
with open(filepath, "r", encoding="utf-8") as f:
content = f.read()
pattern = re.compile(r"\{/\*[\s\S]*?Contributing Section[\s\S]*?", re.DOTALL)
new_content = re.sub(pattern, "", content, count=1)
if new_content != content:
with open(filepath, "w", encoding="utf-8") as f:
f.write(new_content)
removed_count += 1
except (IOError, OSError) as e:
print(f"Error processing file {filepath}: {e}")
error_count += 1
fix_md_endings(target_dir_relative, base_dir, file_extension)
print(f"Removed from {removed_count} files. Encountered {error_count} errors.")
def fix_md_endings(target_dir_relative, base_dir=BASE_DIR, file_extension=".mdx"):
target_path = os.path.join(base_dir, target_dir_relative)
if not os.path.isdir(target_path):
print(f"Error: Directory '{target_path}' not found.")
return
fixed_count = 0
error_count = 0
for filename in os.listdir(target_path):
if filename.endswith(file_extension):
filepath = os.path.join(target_path, filename)
try:
with open(filepath, "r", encoding="utf-8") as f:
content = f.read()
processed_content = content.replace("\r\n", "\n")
processed_content = processed_content.rstrip()
processed_content += "\n"
if processed_content != content:
with open(filepath, "w", encoding="utf-8") as f:
f.write(processed_content)
fixed_count += 1
except (IOError, OSError) as e:
print(f"Error processing file {filepath}: {e}")
error_count += 1
print(f"Fixed line endings and trailing lines in {fixed_count} files. Encountered {error_count} errors.")
if __name__ == "__main__":
# test
target_dir_relative = "test"
language = "zh" # "zh", "en", "jp"
repo_name = "dify-docs-plugin-dev"
repo_owner = "alterxyz"
append_content_to_files(
target_dir_relative="plugin-dev-en",
repo_owner="alterxyz",
repo_name="dify-docs-plugin-dev",
language="en"
)
append_content_to_files(
target_dir_relative="plugin-dev-zh",
repo_owner="alterxyz",
repo_name="dify-docs-plugin-dev",
language="zh"
)