Documentation on how Jinja's env can be re-used for JinjaX in a Django setup

[AhnafCodes]

The Key to using JInjaX with Django is changing jinja2.env.py and adding JinjaX as environment extension and reusing the jinja env

env.add_extension(JinjaX)
catalog = Catalog(jinja_env=env)

[SmileyChris]

Here's a nicer way that automatically uses the components subdirectory for each jinja2 path that Django uses when it passes the loader:

import jinjax
from jinja2.loaders import FileSystemLoader


def environment(loader: FileSystemLoader, **options):
    env = Environment(loader=loader, **options)

    ...

    env.add_extension(jinjax.JinjaX)
    catalog = jinjax.Catalog(jinja_env=env)
    for dir in loader.searchpath:
        catalog.add_folder(os.path.join(dir, "components"))

    return env

[AhnafCodes]

True, it would be good have a separate "components" folder for shared components and also have "components" subfolder at django-app level. so, it should be:

import jinjax
from jinja2.loaders import FileSystemLoader


def environment(loader: FileSystemLoader, **options):
    env = Environment(loader=loader, **options)

    ...

    env.add_extension(jinjax.JinjaX)
    catalog = jinjax.Catalog(jinja_env=env)

    catalog.add_folder("components")
    for dir in loader.searchpath:
        catalog.add_folder(os.path.join(dir, "components"))

    return env

[SmileyChris]

I'm not sure the root catalog.add_folder("components") is really necessary since loader.searchpath will contain all DIRS (and each app's jinja2 folder if APP_DIRS: True).

To clarify the behaviour here, the app component paths end up as <app>/jinja2/components and the DIRS component paths will append components to each of them (usually <projectroot>/jinja2/components or <projectroot>/templates/components). Personally I like that nesting...