chore: Migrate JMBuilder to git submodule

This migration optimizes the repository’s structure by using git submodules, reducing space overhead and improving project reliability. All necessary paths and files were updated, and cross-testing confirmed that the project runs smoothly with the new setup.

- 9b47a71 - chore(pylint): Ignore Python files from 'docs' directory
- 2b458ec - ci(workflow): Update command to include submodules
- 042ae67 - ci(workflow): Ensure git submodules are initialized
- 0441558 - refactor(submodule): Update paths to ensure submodule integration
- 6780c64 - chore(submodule): Migrate JMBuilder to git submodule

Signed-off-by: Ryuu Mitsuki <dhefam31@gmail.com>

.github/workflows/codeql.yml

@@ -51,6 +51,9 @@ jobs:
     steps:
     - name: Checkout Repository
       uses: actions/checkout@v4
+      with:
+        submodules: true  # Ensure that submodules are fetched
+        fetch-depth: 0
 
     # Setup the Java Virtual Machine
     - name: Setup JVM / ${{ matrix.os }}

.github/workflows/pylint.yml

@@ -29,6 +29,9 @@ jobs:
       # Checkout the repo
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          submodules: true  # Ensure that submodules are fetched
+          fetch-depth: 0
 
       # Setup Python
       - name: Set up Python ${{ matrix.python-version }}
@@ -53,4 +56,4 @@ jobs:
       - name: Analyzing the code with pylint
         run: |
           echo "Analyzing the Python code..."
-          pylint --rcfile=.pylintrc $(git ls-files '*.py')
+          pylint --rcfile=.pylintrc $(git ls-files '*.py' --recurse-submodules)

.github/workflows/tests.yml

@@ -53,6 +53,9 @@ jobs:
       # Checkout repository
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          submodules: true  # Ensure that submodules are fetched
+          fetch-depth: 0
 
       # Caching Maven deps
       - name: Cache Maven dependencies
@@ -103,6 +106,9 @@ jobs:
       # Checkout
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          submodules: true  # Ensure that submodules are fetched
+          fetch-depth: 0
 
       # Setup Python
       - name: Setup Python / Ubuntu / ${{ matrix.py-ver }}
@@ -119,9 +125,9 @@ jobs:
         if: ${{ steps.setup-py.outputs.cache-hit != true }}
         run: |
           if [ $debug = 'true' ]; then
-            python -m pip install -r $(git ls-files **/$deps) --debug
+            python -m pip install -r $(git ls-files **/$deps --recurse-submodules) --debug
           else
-            python -m pip install -r $(git ls-files **/$deps)
+            python -m pip install -r $(git ls-files **/$deps --recurse-submodules)
           fi
         shell: bash
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/JMBuilder"]
+	path = vendor/JMBuilder
+	url = https://github.com/mitsuki31/JMBuilder.git

.pylintrc

@@ -55,7 +55,7 @@ ignore=CVS,
 # ignore-list. The regex matches against paths and can be in Posix or Windows
 # format. Because '\\' represents the directory delimiter on Windows systems,
 # it can't be used as an escape character.
-ignore-paths=
+ignore-paths=.*/docs/.+
 
 # Files or directories matching the regular expression patterns are skipped.
 # The regex matches against base names, not paths. The default value ignores

make/Setup.mk

@@ -114,7 +114,7 @@ SOURCE_DIR     := src/main
 TEST_DIR       := src/test
 TARGET_DIR     := target
 DOCS_DIR       := docs
-BUILDER_DIR    := tools/JMBuilder
+BUILDER_DIR    := vendor/JMBuilder
 JAVA_DIR       := $(SOURCE_DIR)/java
 RESOURCE_DIR   := $(SOURCE_DIR)/resources
 CLASSES_DIR    := $(TARGET_DIR)/classes

scripts/retriever.py

@@ -19,6 +19,9 @@
 OUTPUT_DIR : os.PathLike
     The path to the output directory for retrieved information.
 
+BUILDER_DIR : os.PathLike
+    The path to the JMatrix builder directory.
+
 Available Functions
 -------------------
 md5_get
@@ -47,6 +50,7 @@
     os.path.join(os.path.dirname(__file__), '..'))
 TARGET_DIR: os.PathLike = os.path.join(ROOT_DIR, 'target')
 OUTPUT_DIR: os.PathLike = os.path.join(TARGET_DIR, '_retriever')
+BUILDER_DIR: os.PathLike = os.path.join(ROOT_DIR, 'vendor', 'JMBuilder')
 
 
 def md5_get(file: os.PathLike, block_size: int = -1) -> str:
@@ -100,7 +104,7 @@ def setup() -> str:
         directory ``OUTPUT_DIR``.
     """
     # Insert the JMBuilder path to PYTHONPATH environment
-    sys.path.insert(0, os.path.join(ROOT_DIR, 'tools', 'JMBuilder'))
+    sys.path.insert(0, BUILDER_DIR)
 
     # DO NOT TRY TO MOVE THIS IMPORTS TO GLOBAL!! Keep on this function only
     # for speed and performance when commands in Makefile run this