Metadata-Version: 2.4
Name: django-vite-beta
Version: 3.1.0b1
Summary: Integration of Vite in a Django project.
Home-page: https://github.com/elrik/django-vite
Author: Nikola T.
Author-email: "Nikola T." <git@nikola.aleeas.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2021 Paul PAGES
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/elrik/django-vite
Project-URL: Source, https://github.com/elrik/django-vite
Keywords: django,vite,vitejs
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django :: 5.1
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires: Django (>=3.2)
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=3.2
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires

# Django Vite

> **Important note:**  
> This is temporary package that is based on the original package located here:  
> [Original Django-Vite](https://pypi.org/project/django-vite/)  
> There is pending PR with features found here so once it is accepted (if?)
> this package will be removed, so use at your own risk. If you need stability,
> use original package. Also if you find any bugs or want to contribute to the project
> do so in the [originals repository](https://github.com/MrBin99/django-vite)
>
> Reason for this package is that it has custom `runserver` management command that
> handles serving Vite assets. Also this package is based of V3.1.0

[![PyPI version](https://badge.fury.io/py/django-vite.svg)](https://badge.fury.io/py/django-vite)

Integration of [ViteJS](https://vitejs.dev/) in a Django project.

- [Installation](#installation)
  - [Django](#django)
  - [ViteJS](#vitejs)
  - [Assets](#assets)
- [Usage](#usage)
  - [Configuration](#configuration)
  - [Dev Mode](#dev-mode)
  - [Custom runserver](#custom-runserver)
  - [Template tags](#template-tags)
  - [Custom attributes](#custom-attributes)
  - [Loading assets from a CDN](#loading-assets-from-a-cdn)
- [Vite Legacy Plugin](#vite-legacy-plugin)
- [Multi-app configuration](#multi-app-configuration)
- [Configuration Variables](#configuration-variables)
  - [dev\_mode](#dev_mode)
  - [dev\_server\_protocol](#dev_server_protocol)
  - [dev\_server\_host](#dev_server_host)
  - [dev\_server\_port](#dev_server_port)
  - [static\_url\_prefix](#static_url_prefix)
  - [manifest\_path](#manifest_path)
  - [legacy\_polyfills\_motif](#legacy_polyfills_motif)
  - [ws\_client\_url](#ws_client_url)
  - [react\_refresh\_url](#react_refresh_url)
  - [app\_client\_class](#app_client_class)
- [Notes](#notes)
  - [Whitenoise](#whitenoise)
- [Examples](#examples)
- [Thanks](#thanks)


## Installation

### Django

```
pip install django-vite
```

Add `django_vite` to your `INSTALLED_APPS` in your `settings.py`
(before `django.contrib.staticfiles` and your apps that are using it).

```python
INSTALLED_APPS = [
    ...
    'django_vite',
    ...
]
```

### ViteJS

Follow instructions on [https://vitejs.dev/guide/](https://vitejs.dev/guide/).
And mostly the SSR part.

Then in your ViteJS config file :

- Set the `base` options the same as your `STATIC_URL` Django setting.
- Set the `build.outDir` path to where you want the assets to compiled.
- Set the `build.manifest` options to `manifest.json`.
- As you are in SSR and not in SPA, you don't have an `index.html` that
  ViteJS can use to determine which files to compile. You need to tell it
  directly in `build.rollupOptions.input`.

```javascript
export default defineConfig({
  ...
  base: "/static/",
  build: {
    ...
    manifest: "manifest.json",
    outDir: resolve("./assets"),
    rollupOptions: {
      input: {
        <unique key>: '<path to your asset>'
      }
    }
  }
})
```

### Assets

As recommended on Vite's [backend integration guide](https://vitejs.dev/guide/backend-integration.html), your assets should include the modulepreload polyfill.

```javascript
// Add this at the beginning of your app entry.
import 'vite/modulepreload-polyfill';
```

## Usage

### Configuration

Define a default `DJANGO_VITE` configuration in your `settings.py`.

```python
DJANGO_VITE = {
  "default": {
    "dev_mode": True
  }
}
```

Or if you prefer to use the legacy module-level settings, you can use:

```python
DJANGO_VITE_DEV_MODE = True
```

Be sure that the `build.outDir` from `vite.config.js` is included in `STATICFILES_DIRS`.

```python
STATICFILES_DIRS = [
  BASE_DIR / "assets"
]
```

### Dev Mode

The `dev_mode`/`DJANGO_VITE_DEV_MODE` boolean defines if you want to include assets in development mode or production mode.
- In development mode, assets are included as modules using the ViteJS
  webserver. This will enable HMR for your assets.
  The custom runserver command (see [Custom runserver](#custom-runserver))
  handles proxying missing assets to the Vite dev server automatically.
- In production mode, assets are included as standard assets
  (no ViteJS webserver and HMR) like default Django static files.
  This means that your assets must be compiled with ViteJS before.
- This setting may be set as the same value as your `DEBUG` setting in
  Django. But you can do what is good for your needs.

### Custom runserver

Django-Vite provides a custom `runserver` management command that automatically
proxies Vite assets to the Vite development server. When you run `python manage.py runserver`,
the command will:

- Serve files that exist on disk via Django's staticfiles (e.g. vendor JS/CSS)
- Proxy missing assets to the Vite dev server (e.g. uncompiled HMR assets)
- Proxy `__open-in-editor` requests to the Vite dev server for Vue DevTools integration

This means you don't need to manually configure proxying — the handler checks if each
requested file exists in Django's staticfiles first, and only proxies to Vite when
the file is not found on disk. The `__open-in-editor` endpoint (used by Vue DevTools)
is always proxied to Vite regardless.

To disable the Vite proxy and use the standard Django staticfiles handler, use the
`--novite` flag:

```
python manage.py runserver --novite
```

> **Note:** The custom runserver only takes effect when `django_vite` appears before
> `django.contrib.staticfiles` in `INSTALLED_APPS`. This is because Django's management
> command discovery uses the first matching command it finds.

### Template tags

Include this in your base HTML template file.

```
{% load django_vite %}
```

Then in your `<head>` element add this :

```
{% vite_hmr_client %}
```

- This will add a `<script>` tag to include the ViteJS HMR client.
- This tag will include this script only if `DJANGO_VITE_DEV_MODE` is true,
  otherwise this will do nothing.

Then add this tag (in your `<head>` element too) to load your scripts :

```
{% vite_asset '<path to your asset>' %}
```

This will add a `<script>` tag including your JS/TS script :

- In development and production, all scripts are included as modules (`[type=module]`).
- You can pass a second argument to this tag to overrides attributes
  passed to the script tag.
- This tag only accept JS/TS, for other type of assets, they must be
  included in the script itself using `import` statements.
- In production mode, the library will read the `manifest.json` file
  generated by ViteJS and import all CSS files dependent of this script
  (before importing the script).
- You can add as many of this tag as you want, for each input you specify
  in your ViteJS configuration file.
- The path must be relative to your `root` key inside your ViteJS config file.
- The path must be a key inside your manifest file `manifest.json` file
  generated by ViteJS.
  - Alternatively, the path can be an asset name (e.g. `"name": "foo"` in your manifest).
    If you set up multiple entrypoints (`build.rollupOptions.input`) in your Vite config,
    e.g. by following [the Multi-Page App](https://vite.dev/guide/build.html#multi-page-app)
    docs, this would be the key in the entrypoint object.
- In general, this path does not require a `/` at the beginning
  (follow your `manifest.json` file).

```
{% vite_asset_url '<path to your asset>' %}
```

This will generate only the URL to an asset with no tag surrounding it.
**Warning, this does not generate URLs for dependant assets of this one
like the previous tag.**

```
{% vite_react_refresh %}
```
If you're using React, this will generate the Javascript `<script/>` needed to support React HMR.

```
{% vite_react_refresh nonce="{{ request.csp_nonce }}" %}
```

Any kwargs passed to vite_react_refresh will be added to its generated `<script/>` tag. For example, if your site is configured with a Content Security Policy using [django-csp](https://github.com/mozilla/django-csp) you'll want to add this value for `nonce`.

### Custom attributes

By default, all script tags are generated with a `type="module"` and `crossorigin=""` attributes just like ViteJS do by default if you are building a single-page app.
You can override this behavior by adding or overriding this attributes like so :

```jinja-html
{% vite_asset '<path to your asset>' foo="bar" hello="world" data_turbo_track="reload" %}
```

This line will add `foo="bar"`, `hello="world"`, and `data-turbo-track="reload"` attributes.

You can also use context variables to fill attributes values :

```
{% vite_asset '<path to your asset>' foo=request.GET.bar %}
```

If you want to overrides default attributes just add them like new attributes :

```
{% vite_asset '<path to your asset>' crossorigin="anonymous" %}
```

Although it's recommended to keep the default `type="module"` attribute as ViteJS build scripts as ES6 modules.

### Loading assets from a CDN

By default, django-vite will try to load a local `manifest.json`.

If you want django-vite to fetch the manifest from a non-standard source like S3, you can subclass DjangoViteAppClient and override its ManifestClient. Below is a minimal example:

```python
# myapp/django_vite_s3.py
import json
import boto3
from django_vite.core.asset_loader import ManifestClient, DjangoViteAppClient

class S3ManifestClient(ManifestClient):
    def load_manifest(self):
        s3 = boto3.client("s3")
        res = s3.get_object(Bucket='django-vite-public-example', Key='manifest.json')
        manifest_content = res["Body"].read()
        return json.loads(manifest_content)

class S3DjangoViteAppClient(DjangoViteAppClient):
    ManifestClient = S3ManifestClient
```

Then configure your app to use your custom `S3DjangoViteAppClient`:

```python
# settings.py
from django_vite.core.asset_loader import DjangoViteConfig

DJANGO_VITE = {
    "default": DjangoViteConfig(
        dev_mode=False,
        app_client_class="myapp.django_vite_s3.S3DjangoViteAppClient",
        ...
    )
}
```

If your "django.contrib.staticfiles" is configured to use S3, then your assets should load properly without needing further configuration.

Since this feature support is a new work-in-progress, please share with the community any configurations that have worked well for you!

If you find yourself needing greater control over how static asset urls are rendered, you can modify `DjangoViteAppClient.get_production_server_url`:

```python
# myapp/django_vite_s3.py
import json
import boto3
from django_vite.core.asset_loader import ManifestClient, DjangoViteAppClient

class S3ManifestClient(ManifestClient):
    def load_manifest(self):
        s3 = boto3.client("s3")
        res = s3.get_object(Bucket='django-vite-public-example', Key='manifest.json')
        manifest_content = res["Body"].read()
        return json.loads(manifest_content)

class S3DjangoViteAppClient(DjangoViteAppClient):
    ManifestClient = S3ManifestClient

    def get_production_server_url(self, path: str) -> str:
        # Make additional charge here as needed
        ...
```

## Vite Legacy Plugin

If you want to consider legacy browsers that don't support ES6 modules loading
you may use [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy).
Django Vite supports this plugin. You must add stuff in complement of other script imports in the `<head>` tag.

Just before your `<body>` closing tag add this :

```
{% vite_legacy_polyfills %}
```

This tag will do nothing in development, but in production it will loads the polyfills
generated by ViteJS.

And so next to this tag you need to add another import to all the scripts you have
in the head but the 'legacy' version generated by ViteJS like so :

```
{% vite_legacy_asset '<path to your asset>' %}
```

Like the previous tag, this will do nothing in development but in production,
Django Vite will add a script tag with a `nomodule` attribute for legacy browsers.
The path to your asset must contain de pattern `-legacy` in the file name (ex : `main-legacy.js`).

This tag accepts overriding and adding custom attributes like the default `vite_asset` tag.

## Multi-app configuration

If you would like to use django-vite with multiple vite configurations you can specify them in your settings.

```python
DJANGO_VITE = {
  "default": {
    "dev_mode": True,
  },
  "external_app_1": {
    ...
  },
  "external_app_2": {
    ...
  }
}
```

Specify the app in each django-tag tag that you use in your templates. If no app is provided, it will default to using the "default" app.

```html
{% vite_asset '<path to your asset>' %}
{% vite_asset '<path to another asset>' app="external_app_1" %}
{% vite_asset '<path to a third asset>' app="external_app_2" %}
```

You can see an example project [here](https://github.com/Niicck/django-vite-multi-app-example).

## Configuration Variables

You can redefine these values for each app config in `DJANGO_VITE` in `settings.py`.

### dev_mode
- **Type**: `bool`
- **Default**: `False`
- **Legacy Key**: `DJANGO_VITE_DEV_MODE`

Indicates whether to serve assets via the ViteJS development server or from compiled production assets.

Read more: [Dev Mode](#dev-mode)

### dev_server_protocol
- **Type**: `str`
- **Default**: `"http"`
- **Legacy Key**: `DJANGO_VITE_DEV_SERVER_PROTOCOL`

The protocol used by the ViteJS webserver.

### dev_server_host
- **Type**: `str`
- **Default**: `"localhost"`
- **Legacy Key**: `DJANGO_VITE_DEV_SERVER_HOST`

The `server.host` in `vite.config.js` for the ViteJS development server.

### dev_server_port
- **Type**: `int`
- **Default**: `5173`
- **Legacy Key**: `DJANGO_VITE_DEV_SERVER_PORT`

The `server.port` in `vite.config.js` for the ViteJS development server.

### static_url_prefix
- **Type**: `str`
- **Default**: `""`
- **Legacy Key**: `DJANGO_VITE_STATIC_URL_PREFIX`

The directory prefix for static files built by ViteJS.

- Use it if you want to avoid conflicts with other static files in your project.
- It's used in both dev mode and production mode.
- For dev mode, you also need to add this prefix inside vite config's `base`.
- For production mode, you may need to add this to vite config's `build.outDir`.

Example:

```python
# settings.py
DJANGO_VITE_STATIC_URL_PREFIX = 'bundler'
STATICFILES_DIRS = (('bundler', '/srv/app/bundler/dist'),)
```

```javascript
// vite.config.js
export default defineConfig({
  base: '/static/bundler/',
  ...
})
```

### manifest_path
- **Type**: `str | Path`
- **Default**: `Path(settings.STATIC_ROOT) / static_url_prefix / "manifest.json"`
- **Legacy Key**: `DJANGO_VITE_MANIFEST_PATH`

The absolute path, including the filename, to the ViteJS manifest file located in `build.outDir`.

### legacy_polyfills_motif
- **Type**: `str`
- **Default**: `"legacy-polyfills"`
- **Legacy Key**: `DJANGO_VITE_LEGACY_POLYFILLS_MOTIF`

The motif used to identify assets for polyfills in the `manifest.json`. This is only applicable if you are using [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy).

### ws_client_url
- **Type**: `str`
- **Default**: `"@vite/client"`
- **Legacy Key**: `DJANGO_VITE_WS_CLIENT_URL`

The path to the HMR (Hot Module Replacement) client used in the `vite_hmr_client` tag.

### react_refresh_url
- **Type**: `str`
- **Default**: `"@react-refresh""`
- **Legacy Key**: `DJANGO_VITE_REACT_REFRESH_URL`

If you're using React, this will generate the Javascript needed to support React HMR.

### app_client_class
- **Type**: `str`
- **Default**: `"django_vite.core.asset_loader.DjangoViteAppClient"`

This is the fully qualified name of a Python class that extends or replaces `DjangoViteAppClient`. This allows you to customize almost any part of django-vite's loader behavior. The most requested reason for adding this feature is customizing how `manifest.json` is loaded.

See [Loading assets from a CDN](#loading-assets-from-a-cdn) for an example of using a custom class to load the manifest from S3.

## Notes

- In production mode, all generated paths are prefixed with the `STATIC_URL`
  setting of Django.

### Whitenoise

If you are serving your static files with whitenoise, by default your files compiled by vite will not be considered immutable and a bad cache-control will be set. To fix this you will need to set a custom test like so:

```python
import re

# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TEST

def immutable_file_test(path, url):
    # Match vite (rollup)-generated hashes, à la, `some_file-CSliV9zW.js`
    return re.match(r"^.+[.-][0-9a-zA-Z_-]{8,12}\..+$", url)


WHITENOISE_IMMUTABLE_FILE_TEST = immutable_file_test
```

## Examples

For examples of how to setup the project in v3, please see [django-vite-examples](https://github.com/Niicck/django-vite-examples).

For another example that uses the module-level legacy settings, please see this [example project here](https://github.com/MrBin99/django-vite-example).

## Thanks

Thanks to [Evan You](https://github.com/yyx990803) for the ViteJS library.
