Merge pull request #74 from inventree/react-deps

React deps

Author: SchrodingersGat

plugin_creator/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-PLUGIN_CREATOR_VERSION = "1.10.0"
+PLUGIN_CREATOR_VERSION = "1.11.0"

plugin_creator/cli.py

@@ -14,10 +14,14 @@
 
 def default_values() -> dict:
     """Read default values out from the cookiecutter.json file."""
-    fn = os.path.join(os.path.dirname(__file__), 'template', 'cookiecutter.json')
+    fn = os.path.join(os.path.dirname(__file__), "template", "cookiecutter.json")
 
-    with open(fn, encoding='utf-8') as f:
-        return json.load(f)
+    with open(fn, encoding="utf-8") as f:
+        data = json.load(f)
+
+    data["frontend"] = frontend.define_frontend(True, defaults=True)
+
+    return data
 
 
 def gather_info(context: dict) -> dict:
@@ -31,168 +35,163 @@ def gather_info(context: dict) -> dict:
     - Package name: The Python package name for the plugin (e.g., "custom_plugin").
     - Distribution name: The name used for the Python package distribution (e.g., "inventree-custom-plugin").
     """
-    info('Enter project information:')
+    info("Enter project information:")
 
     # Basic project information
-    context['plugin_title'] = (
+    context["plugin_title"] = (
         questionary.text(
-            'Enter plugin name',
-            default=context['plugin_title'],
+            "Enter plugin name",
+            default=context["plugin_title"],
             validate=validators.ProjectNameValidator,
         )
         .ask()
         .strip()
     )
 
-    context['plugin_description'] = (
+    context["plugin_description"] = (
         questionary.text(
-            'Enter plugin description',
-            default=context['plugin_description'],
+            "Enter plugin description",
+            default=context["plugin_description"],
             validate=validators.NotEmptyValidator,
         )
         .ask()
         .strip()
     )
 
-    context['plugin_name'] = context['plugin_title'].replace(' ', '')
+    context["plugin_name"] = context["plugin_title"].replace(" ", "")
 
     # Convert the project name to a package name
     # e.g. 'Custom Plugin' -> 'custom_plugin'
-    context['plugin_slug'] = context['plugin_title'].replace(' ', '-').lower()
-    context['package_name'] = context['plugin_slug'].replace('-', '_')
+    context["plugin_slug"] = context["plugin_title"].replace(" ", "-").lower()
+    context["package_name"] = context["plugin_slug"].replace("-", "_")
 
     # Convert the package slug to a distribution name
     # e.g. 'custom-plugin' -> 'inventree-custom-plugin'
-    pkg = context['plugin_slug']
+    pkg = context["plugin_slug"]
 
-    if not pkg.startswith('inventree-'):
-        pkg = f'inventree-{pkg}'
+    if not pkg.startswith("inventree-"):
+        pkg = f"inventree-{pkg}"
 
-    context['distribution_name'] = pkg
+    context["distribution_name"] = pkg
 
     success(
         f"Generating plugin '{context['package_name']}' - {context['plugin_description']}"
     )
 
-    info('Enter author information:')
+    info("Enter author information:")
 
-    context['author_name'] = (
+    context["author_name"] = (
         questionary.text(
-            'Author name',
-            default=context['author_name'],
+            "Author name",
+            default=context["author_name"],
             validate=validators.NotEmptyValidator,
         )
         .ask()
         .strip()
     )
 
-    context['author_email'] = (
-        questionary.text('Author email', default=context['author_email']).ask().strip()
+    context["author_email"] = (
+        questionary.text("Author email", default=context["author_email"]).ask().strip()
     )
 
-    context['project_url'] = (
-        questionary.text('Project URL', default=context['project_url']).ask().strip()
+    context["project_url"] = (
+        questionary.text("Project URL", default=context["project_url"]).ask().strip()
     )
 
     # Extract license information
     available_licences = list(license_pkg.iter())
     license_keys = [lic.id for lic in available_licences]
 
-    context['license_key'] = questionary.select(
-        'Select a license', default='MIT', choices=license_keys
+    context["license_key"] = questionary.select(
+        "Select a license", default="MIT", choices=license_keys
     ).ask()
 
-    context['license_text'] = license_pkg.find(context['license_key']).render(
-        name=context['author_name'], email=context['author_email']
+    context["license_text"] = license_pkg.find(context["license_key"]).render(
+        name=context["author_name"], email=context["author_email"]
     )
 
     # Plugin structure information
-    info('Enter plugin structure information:')
+    info("Enter plugin structure information:")
 
     plugin_mixins = mixins.get_mixins()
 
-    context['plugin_mixins'] = {'mixin_list': plugin_mixins}
+    context["plugin_mixins"] = {"mixin_list": plugin_mixins}
 
     # If we want to add frontend code support
-    if 'UserInterfaceMixin' in plugin_mixins:
-        context['frontend'] = {
-            'enabled': True,
-            'features': frontend.select_features(),
-            'translation': frontend.enable_translation(),
-        }
-    else:
-        context['frontend'] = {'enabled': False, 'features': frontend.no_features()}
+    frontend_enabled = "UserInterfaceMixin" in plugin_mixins
+
+    context["frontend"] = frontend.define_frontend(frontend_enabled)
 
     # Devops information
-    info('Enter plugin devops support information:')
+    info("Enter plugin devops support information:")
 
-    git_support = context['git_support'] = questionary.confirm(
-        'Enable Git integration?', default=True
+    git_support = context["git_support"] = questionary.confirm(
+        "Enable Git integration?", default=True
     ).ask()
 
-    context['ci_support'] = devops.get_devops_mode() if git_support else 'None'
+    context["ci_support"] = devops.get_devops_mode() if git_support else "None"
 
     return context
 
 
 def cleanup(plugin_dir: str, context: dict) -> None:
     """Cleanup generated files after cookiecutter runs."""
-    info('Cleaning up generated files...')
+    info("Cleaning up generated files...")
 
-    devops.cleanup_devops_files(context['ci_support'], plugin_dir)
+    devops.cleanup_devops_files(context["ci_support"], plugin_dir)
 
     # Remove frontend code entirely if not enabled
-    if context['frontend']['enabled']:
+    if context["frontend"]["enabled"]:
         frontend.update_frontend(plugin_dir, context)
     else:
         frontend.remove_frontend(plugin_dir)
 
     # Cleanup mixins
     mixins.cleanup_mixins(plugin_dir, context)
 
-    if context['git_support']:
+    if context["git_support"]:
         devops.git_init(plugin_dir)
 
 
 def main():
     """Run plugin scaffolding."""
-    parser = argparse.ArgumentParser(description='InvenTree Plugin Creator Tool')
+    parser = argparse.ArgumentParser(description="InvenTree Plugin Creator Tool")
     parser.add_argument(
-        '--default',
-        action='store_true',
-        help='Use default values for all prompts (non-interactive mode)',
+        "--default",
+        action="store_true",
+        help="Use default values for all prompts (non-interactive mode)",
     )
     parser.add_argument(
-        '--output', action='store', help='Specify output directory', default='.'
+        "--output", action="store", help="Specify output directory", default="."
     )
     parser.add_argument(
-        '--version', action='version', version=f'%(prog)s {PLUGIN_CREATOR_VERSION}'
+        "--version", action="version", version=f"%(prog)s {PLUGIN_CREATOR_VERSION}"
     )
 
     args = parser.parse_args()
 
-    info('InvenTree Plugin Creator Tool')
+    info("InvenTree Plugin Creator Tool")
 
     context = default_values()
     context.update(config.load_config())
 
     # Set version information
-    context['plugin_creator_version'] = PLUGIN_CREATOR_VERSION
+    context["plugin_creator_version"] = PLUGIN_CREATOR_VERSION
 
     if args.default:
-        info('- Using default values for all prompts')
+        info("- Using default values for all prompts")
     else:
         context = gather_info(context)
 
-    src_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'template')
+    src_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "template")
 
     output_dir = os.path.abspath(args.output)
-    plugin_dir = os.path.join(output_dir, context['plugin_name'])
+    plugin_dir = os.path.join(output_dir, context["plugin_name"])
 
     # Save the user config
     config.save_config(context)
 
-    info('- output:', plugin_dir)
+    info("- output:", plugin_dir)
 
     # Run cookiecutter template
     cookiecutter(
@@ -209,5 +208,5 @@ def main():
     success(f"Plugin created -> '{plugin_dir}'")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

plugin_creator/frontend.py

@@ -7,6 +7,11 @@
 from .helpers import remove_file, remove_dir
 
 
+# Minimum version requirements for core frontend libraries
+MIN_REACT_VERSION = "19.1.1"
+MIN_MANTINE_VERSION = "7.16.0"
+
+
 def frontend_features() -> dict:
     """Provide a list of frontend features to enable."""
 
@@ -62,6 +67,30 @@ def remove_frontend(plugin_dir: str) -> None:
     remove_dir(plugin_dir, "frontend")
 
 
+def define_frontend(enabled: bool, defaults: bool = False) -> dict:
+    """Define the frontend code options for the plugin."""
+
+    frontend = {
+        "react_version": MIN_REACT_VERSION,
+        "mantine_version": MIN_MANTINE_VERSION,
+    }
+
+    if enabled:
+        frontend.update({
+            "enabled": True,
+            "features": all_features() if defaults else select_features(),
+            "translation": True if defaults else enable_translation(),
+        })
+    else:
+        frontend.update({
+            "enabled": False,
+            "translation": False,
+            "features": no_features(),
+        })
+
+    return frontend
+
+
 def update_frontend(plugin_dir: str, context: dict) -> None:
     """Update the frontend code for the plugin."""
 

plugin_creator/template/cookiecutter.json

@@ -32,6 +32,8 @@
     "frontend": {
         "enabled": true,
         "translation": true,
+        "react_version": "0.0.0",
+        "mantine_version": "0.0.0",
         "features": {
             "dashboard": true,
             "panel": true,

plugin_creator/template/{{ cookiecutter.plugin_name }}/frontend/package.json

@@ -15,7 +15,13 @@
     "dev": "vite --config vite.dev.config.ts --host"
   },
   "dependencies": {
-    "@inventreedb/ui": "latest"
+    "@inventreedb/ui": "latest",
+    "react": ">= {{ cookiecutter.frontend.react_version }}",
+    "react-dom": ">= {{ cookiecutter.frontend.react_version }}",
+    "@mantine/core": ">= {{ cookiecutter.frontend.mantine_version }}",
+    "@mantine/hooks": ">= {{ cookiecutter.frontend.mantine_version }}",
+    "@mantine/modals": ">= {{ cookiecutter.frontend.mantine_version }}",
+    "@mantine/notifications": ">= {{ cookiecutter.frontend.mantine_version }}"
   },
   "peerDependencies": {},
   "devDependencies": {
@@ -29,7 +35,7 @@
     {%- endif %}
     "@types/react": "latest",
     "@types/react-dom": "latest",
-    "@vitejs/plugin-react": "^4.3.4",
+    "@vitejs/plugin-react": "^4.7.0",
     "globals": "^15.14.0",
     "typescript": "~5.6.2",
     "vite": "^6.0.5",