1
0
mirror of https://github.com/konpa/devicon.git synced 2025-08-12 09:34:36 +02:00

Clean up and CONTRIBUTING upgrade (#595)

* Updated CONTRIBUTING

* Clean up various scripts (no functional changes)

* Update CONTRIBUTING.md

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>

* Change icons to use devicon in README and CONTRIBUTING

* Add optimize-bot into CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update README.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update README.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Change release message step name

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Changed all 'svg' to "SVG"

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
This commit is contained in:
Thomas Bui
2021-05-12 00:57:31 -07:00
committed by GitHub
parent 0b86f7c9cb
commit 2c6a21d9f4
9 changed files with 147 additions and 289 deletions

View File

@@ -55,21 +55,6 @@ def get_check_svgs_on_pr_args():
return parser.parse_args()
def get_check_svgs_monthly_args():
"""
Get the commandline arguments for the check_svgs_monthly.py.
"""
parser = ArgumentParser(description="Check the SVGs to ensure their attributes are correct. Run monthly.")
parser.add_argument("devicon_json_path",
help="The path to the devicon.json",
action=PathResolverAction)
parser.add_argument("icons_folder_path",
help="The path to the icons folder",
action=PathResolverAction)
return parser.parse_args()
def get_release_message_args():
"""
Get the commandline arguments for get_release_message.py.

View File

@@ -234,7 +234,7 @@ def get_added_modified_svgs(files_added_json_path: str,
def write_to_file(path: str, value: any):
"""
Write the value to a JSON file.
Write the value to a file.
"""
with open(path, "w") as file:
file.write(value)

View File

@@ -57,39 +57,42 @@ def check_svgs(svg_file_paths: List[Path]):
# batch err messages together so user can fix everything at once
err_msgs = []
for svg_path in svg_file_paths:
tree = et.parse(svg_path)
root = tree.getroot()
namespace = "{http://www.w3.org/2000/svg}"
err_msg = [f"{svg_path}:"]
try:
tree = et.parse(svg_path)
root = tree.getroot()
namespace = "{http://www.w3.org/2000/svg}"
err_msg = [f"{svg_path}:"]
if root.tag != f"{namespace}svg":
err_msg.append(f"-root is '{root.tag}'. Root must be an 'svg' element")
if root.tag != f"{namespace}svg":
err_msg.append(f"-root is '{root.tag}'. Root must be an 'svg' element")
if root.get("viewBox") != "0 0 128 128":
err_msg.append("-'viewBox' is not '0 0 128 128' -> Set it or scale the file using https://www.iloveimg.com/resize-image/resize-svg")
if root.get("viewBox") != "0 0 128 128":
err_msg.append("-'viewBox' is not '0 0 128 128' -> Set it or scale the file using https://www.iloveimg.com/resize-image/resize-svg")
acceptable_size = [None, "128px", "128"]
if root.get("height") not in acceptable_size:
err_msg.append("-'height' is present in svg element but is not '128' or '128px' -> Remove it or set it to '128' or '128px'")
acceptable_size = [None, "128px", "128"]
if root.get("height") not in acceptable_size:
err_msg.append("-'height' is present in svg element but is not '128' or '128px' -> Remove it or set it to '128' or '128px'")
if root.get("width") not in acceptable_size:
err_msg.append("-'width' is present in svg element but is not '128' or '128px' -> Remove it or set it to '128' or '128px'")
if root.get("width") not in acceptable_size:
err_msg.append("-'width' is present in svg element but is not '128' or '128px' -> Remove it or set it to '128' or '128px'")
if root.get("style") is not None and "enable-background" in root.get("style"):
err_msg.append("-deprecated 'enable-background' in style attribute -> Remove it")
if root.get("style") is not None and "enable-background" in root.get("style"):
err_msg.append("-deprecated 'enable-background' in style attribute -> Remove it")
if root.get("x") is not None:
err_msg.append("-unneccessary 'x' attribute in svg element -> Remove it")
if root.get("x") is not None:
err_msg.append("-unneccessary 'x' attribute in svg element -> Remove it")
if root.get("y") is not None:
err_msg.append("-unneccessary 'y' attribute in svg element -> Remove it")
if root.get("y") is not None:
err_msg.append("-unneccessary 'y' attribute in svg element -> Remove it")
style = root.findtext(f".//{namespace}style")
if style != None and "fill" in style:
err_msg.append("-contains style declaration using 'fill' -> Replace classes with the 'fill' attribute instead")
style = root.findtext(f".//{namespace}style")
if style != None and "fill" in style:
err_msg.append("-contains style declaration using 'fill' -> Replace classes with the 'fill' attribute instead")
if len(err_msg) > 1:
err_msgs.append("\n".join(err_msg))
if len(err_msg) > 1:
err_msgs.append("\n".join(err_msg))
except et.ParseError as e:
raise Exception(f"SVG Error in file: {svg_path}. Full Error: \n" + str(e))
if len(err_msgs) > 0:
return "\n\n".join(err_msgs)