diff --git a/.github/scripts/build_assets/arg_getters.py b/.github/scripts/build_assets/arg_getters.py index d086bd331..084321f02 100644 --- a/.github/scripts/build_assets/arg_getters.py +++ b/.github/scripts/build_assets/arg_getters.py @@ -2,7 +2,7 @@ from build_assets.PathResolverAction import PathResolverAction -def get_selenium_runner_args(peek_mode=False): +def get_selenium_runner_args(has_token=True, peek_mode=False): """ Get the commandline arguments for the icomoon_peek.py and icomoon_build.py. @@ -36,7 +36,7 @@ def get_selenium_runner_args(peek_mode=False): if peek_mode: parser.add_argument("pr_title", help="The title of the PR that we are peeking at") - else: + if has_token != False: parser.add_argument("token", help="The GitHub token to access the GitHub REST API.") diff --git a/.github/scripts/build_assets/geckodriver-v0.30.0-win64/geckodriver.exe b/.github/scripts/build_assets/geckodriver-v0.30.0-win64/geckodriver.exe deleted file mode 100644 index c59764ab2..000000000 Binary files a/.github/scripts/build_assets/geckodriver-v0.30.0-win64/geckodriver.exe and /dev/null differ diff --git a/.github/scripts/build_assets/geckodriver-v0.30.0-win64/README.md b/.github/scripts/build_assets/geckodriver-v0.32.2-win64/README.md similarity index 100% rename from .github/scripts/build_assets/geckodriver-v0.30.0-win64/README.md rename to .github/scripts/build_assets/geckodriver-v0.32.2-win64/README.md diff --git a/.github/scripts/build_assets/geckodriver-v0.32.2-win64/geckodriver.exe b/.github/scripts/build_assets/geckodriver-v0.32.2-win64/geckodriver.exe new file mode 100644 index 000000000..27567ab15 Binary files /dev/null and b/.github/scripts/build_assets/geckodriver-v0.32.2-win64/geckodriver.exe differ diff --git a/.github/scripts/icomoon_build_githubless.py b/.github/scripts/icomoon_build_githubless.py new file mode 100644 index 000000000..92fb1aba9 --- /dev/null +++ b/.github/scripts/icomoon_build_githubless.py @@ -0,0 +1,145 @@ +from pathlib import Path +import sys +from selenium.common.exceptions import TimeoutException +import re +import subprocess +import json +from typing import List, Dict +from io import FileIO + +# pycharm complains that build_assets is an unresolved ref +# don't worry about it, the script still runs +from build_assets.selenium_runner.BuildSeleniumRunner import BuildSeleniumRunner +from build_assets import filehandler, arg_getters, util, api_handler + +def main(): + """ + Build the icons using Icomoon. Also optimize the svgs. + """ + runner = None + logfile = open("log.txt", "w") + try: + args = arg_getters.get_selenium_runner_args(has_token=False) + new_icons = get_icons_for_building(args.icomoon_json_path, args.devicon_json_path, logfile) + if len(new_icons) == 0: + sys.exit("No files need to be uploaded. Ending script...") + + print(f"There are {len(new_icons)} icons to be build. Here are they:", *new_icons, sep = "\n", file=logfile) + + print("Begin optimizing files...", file=logfile) + optimize_svgs(new_icons, args.icons_folder_path, logfile=logfile) + + print("Updating the icomoon json...", file=logfile) + update_icomoon_json(new_icons, args.icomoon_json_path, logfile) + + print("Start the building icons process...", file=logfile) + icon_svgs = filehandler.get_svgs_paths( + new_icons, args.icons_folder_path, icon_versions_only=True) + zip_name = "devicon-v1.0.zip" + zip_path = Path(args.download_path, zip_name) + screenshot_folder = filehandler.create_screenshot_folder("./") + + runner = BuildSeleniumRunner(args.download_path, + args.geckodriver_path, args.headless, log_output=logfile) + print("Building icons...", file=logfile) + runner.build_icons(args.icomoon_json_path, zip_path, + icon_svgs, screenshot_folder) + + print("Extracting files...", file=logfile) + filehandler.extract_files(str(zip_path), args.download_path, logfile) + print("Renaming extracted files...", file=logfile) + filehandler.rename_extracted_files(args.download_path, logfile) + + print("Task completed!", file=logfile) + except TimeoutException as e: + util.exit_with_err(Exception("Selenium Time Out Error: \n" + str(e)), logfile) + except Exception as e: + util.exit_with_err(e, logfile) + finally: + print("Exiting", file=logfile) + if runner is not None: + runner.close() + logfile.close() + + +def get_icons_for_building(icomoon_json_path: str, devicon_json_path: str, logfile: FileIO): + """ + Get the icons for building. + :param icomoon_json_path - the path to the `icomoon.json`. + :param devicon_json_path - the path to the `devicon.json`. + :param logfile. + :return a list of dict containing info on the icons. These are + from the `devicon.json`. + """ + + new_icons = [] + + # get any icons that might not have been found by the API + # sometimes happen due to the PR being opened before the latest build release + new_icons_from_devicon_json = filehandler.find_new_icons_in_devicon_json( + devicon_json_path, icomoon_json_path) + + for icon in new_icons_from_devicon_json: + if icon not in new_icons: + new_icons.append(icon) + + return new_icons + + +def optimize_svgs(new_icons: List[str], icons_folder_path: str, logfile: FileIO): + """ + Optimize the newly added svgs. This is done in batches + since the command line has a limit on characters allowed. + :param new_icons - the new icons that need to be optimized. + :param icons_folder_path - the path to the /icons folder. + :param logfile - the file obj to store logging info in. + """ + svgs = filehandler.get_svgs_paths(new_icons, icons_folder_path, icon_versions_only=False) + start = 0 + step = 10 + for i in range(start, len(svgs), step): + batch = svgs[i:i + step] + print(f"Optimizing these files\n{batch}", file=logfile) + subprocess.run(["npm", "run", "optimize-svg", "--", f"--svgFiles={json.dumps(batch)}"], shell=True) + + +def update_icomoon_json(new_icons: List[str], icomoon_json_path: str, logfile: FileIO): + """ + Update the `icomoon.json` if it contains any icons + that needed to be updated. This will remove the icons + from the `icomoon.json` so the build script will reupload + it later. + """ + icomoon_json = filehandler.get_json_file_content(icomoon_json_path) + cur_len = len(icomoon_json["icons"]) + messages = [] + + wrapper_function = lambda icomoon_icon : find_icomoon_icon_not_in_new_icons( + icomoon_icon, new_icons, messages) + icons_to_keep = filter(wrapper_function, icomoon_json["icons"]) + icomoon_json["icons"] = list(icons_to_keep) + + new_len = len(icomoon_json["icons"]) + print(f"Update completed. Removed {cur_len - new_len} icons:", *messages, sep='\n', file=logfile) + filehandler.write_to_file(icomoon_json_path, json.dumps(icomoon_json)) + + +def find_icomoon_icon_not_in_new_icons(icomoon_icon: Dict, new_icons: List, messages: List): + """ + Find all the icomoon icons that are not listed in the new icons. + This also add logging for which icons were removed. + :param icomoon_icon - a dict object from the icomoon.json's `icons` attribute. + :param new_icons - a list of new icons. Each element is an object from the `devicon.json`. + :param messages - an empty list where the function can attach logging on which + icon were removed. + """ + for new_icon in new_icons: + pattern = re.compile(f"^{new_icon['name']}-") + if pattern.search(icomoon_icon["properties"]["name"]): + message = f"-'{icomoon_icon['properties']['name']}' cause it matches '{new_icon['name']}'" + messages.append(message) + return False + return True + +if __name__ == "__main__": + main() diff --git a/.github/workflows/peek_icons.yml b/.github/workflows/peek_icons.yml index 65d42fc13..0e8b4c2bc 100644 --- a/.github/workflows/peek_icons.yml +++ b/.github/workflows/peek_icons.yml @@ -41,7 +41,7 @@ jobs: shell: cmd run: > python ./.github/scripts/icomoon_peek.py - ./.github/scripts/build_assets/geckodriver-v0.30.0-win64/geckodriver.exe ./icomoon.json + ./.github/scripts/build_assets/geckodriver-v0.32.2-win64/geckodriver.exe ./icomoon.json ./devicon.json ./icons ./ --headless "%PR_TITLE%" - name: Upload the err messages (created by icomoon_peek.py) diff --git a/.gitpod.dockerfile b/.gitpod.dockerfile new file mode 100644 index 000000000..7e356ce00 --- /dev/null +++ b/.gitpod.dockerfile @@ -0,0 +1,8 @@ +FROM gitpod/workspace-full-vnc + +RUN sudo apt-get update \ + && sudo apt-get install -y \ + firefox \ + gulp \ + && python -m pip install --upgrade pip \ + && pip install selenium==4.1.0 requests==2.25.1 diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..128ba42f8 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,22 @@ +image: + file: .gitpod.dockerfile + +tasks: + - name: Setup & build + init: chmod +x ./.github/scripts/build_assets/geckodriver-v0.32.2-linux64/geckodriver + command: npm install && npm run build-icons + - name: Build CSS & run web server + init: npm run build-css && npm run dev + +github: + prebuilds: + addBadge: true + addComment: false + addCheck: true + master: true + branches: true + pullRequestsFromForks: true + +ports: + - port: 8000 + onOpen: open-preview diff --git a/README.md b/README.md index 118f59dbf..ea3051c04 100644 --- a/README.md +++ b/README.md @@ -57,17 +57,17 @@
  • Discord Community
  • develop vs master
  • Stale Pull Requests
    • -
  • Go Build Yourself
    • +
  • Building Devicon

    • About the Project

    Devicon aims to gather all logos representing development languages and tools. Each icon comes in several versions: font/SVG, original/plain/line, colored/not colored, wordmark/no wordmark. - Devicon has 150+ icons. And it's growing!
    + Devicon has 150+ icons. And it's growing!

    - See the devicon.json or our website for complete and up to date reference of + See the devicon.json or our website for complete and up to date reference of all available icons.

    @@ -76,20 +76,19 @@

    - All product names, logos, and brands are property of their respective owners. All company, product and service - names used in this website are for identification purposes only. Use of these names, logos, and brands does not + All product names, logos, and brands are property of their respective owners. All company, product and service + names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement. Usage of these logos should be done according to the company/brand/service's brand policy. -

    Getting Started

    - For a super fast setup go check devicon.dev.
    - You can either use the raw SVG icons or our devicon font (which is - also available via CDN). + For a super fast setup, go check devicon.dev.
    + You can either use the raw SVG icons, our Devicon font (which is + also available via CDN), or by building Devicon yourself.

    -

    Use the devicon font (recommended)

    +

    Use the devicon font (recommended)

    You can install devicon as a dependency to your project either with npm or yarn:

    @@ -134,7 +133,7 @@ yarn add devicon An alternate way to use devicon is by copy/pasting the raw SVG code to your project.

    -

    Copy/paste SVG code (from the SVG folder or the project page):

    +

    Copy/paste SVG code (from the SVG folder or the project page):

    ```html @@ -157,7 +156,7 @@ Add the following CSS rules in your stylesheet:

    You can also use the img tag and reference an SVG directly from the repository:

    ```html - + ```

    Requesting an icon

    @@ -177,7 +176,7 @@ We have a Discord community for Devicons. You can easily request icons, discuss,

    develop vs master

    -All official releases shall be in master. Any updates in between (icons, features, etc.) will be kept in develop. +All official releases shall be in master. Any updates in between (icons, features, etc.) will be kept in develop.

    develop contains: