1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
|
%global _empty_manifest_terminate_build 0
Name: python-django-vite
Version: 2.1.2
Release: 1
Summary: Integration of ViteJS in a Django project.
License: Apache License, Version 2.0
URL: https://github.com/MrBin99/django-vite
Source0: https://mirrors.aliyun.com/pypi/web/packages/ba/fa/f811d91d48630f6563ab03b6418eb5a3a5e78e0a44aa91b00ced7374c718/django-vite-2.1.2.tar.gz
BuildArch: noarch
Requires: python3-Django
Requires: python3-black
Requires: python3-flake8
%description
# Django Vite
[](https://badge.fury.io/py/django-vite)
Integration of [ViteJS](https://vitejs.dev/) in a Django project.
## Installation
### Django
```
pip install django-vite
```
Add `django_vite` to your `INSTALLED_APPS` in your `settings.py`
(before 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 `true`.
- 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 your ViteJS config file add the following :
```javascript
export default defineConfig({
build {
...
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 setting variable in your `settings.py` named `DJANGO_VITE_ASSETS_PATH`
containing the absolute path to where your assets are built.
- This must correspond to your `build.outDir` in your ViteJS configuration.
- The `DJANGO_VITE_ASSETS_PATH` must be included in your `STATICFILES_DIRS`
Django setting.
- Define a setting variable in your `settings.py` named `DJANGO_VITE_DEV_MODE`
containing a boolean defining 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.
- 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.
Note : `DJANGO_VITE_ASSETS_PATH` supports `pathlib.Path` syntax or pure `str`.
### 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 mode, all scripts are included as modules.
- In development mode, all scripts are marked as `async` and `defer`.
- 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.
- 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 needed to support React HMR.
### Custom attributes
By default, all scripts 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 :
```
{% vite_asset '<path to your asset>' foo="bar" hello="world" %}
```
This line will add `foo="bar"` and `hello="world"` 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.
## 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.
## Miscellaneous configuration
You can redefine those variables in your `settings.py` :
- `DJANGO_VITE_DEV_SERVER_PROTOCOL` : ViteJS webserver protocol
(default : `http`).
- `DJANGO_VITE_DEV_SERVER_HOST` : ViteJS webserver hostname
(default : `localhost`).
- `DJANGO_VITE_DEV_SERVER_PORT` : ViteJS webserver port
(default : `3000`)
- `DJANGO_VITE_WS_CLIENT_URL` : ViteJS webserver path to the HMR client used
in the `vite_hmr_client` tag (default : `@vite/client`).
- `DJANGO_VITE_MANIFEST_PATH` : Absolute path (including filename)
to your ViteJS manifest file. This file is generated in your
`DJANGO_VITE_ASSETS_PATH`. But if you are in production (`DEBUG` is false)
then it is in your `STATIC_ROOT` after you collected your
[static files](https://docs.djangoproject.com/en/3.1/howto/static-files/) (supports `pathlib.Path` or `str`).
- `DJANGO_VITE_LEGACY_POLYFILLS_MOTIF` : The motif used to find the assets for polyfills inside the `manifest.json` (only if you use [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy)).
- `DJANGO_VITE_STATIC_URL_PREFIX` : prefix directory of your static files built by Vite.
(default : `""`)
- Use it if you want to avoid conflicts with other static files in your project.
- It may be used with `STATICFILES_DIRS`.
- You also need to add this prefix inside vite config's `base`.
e.g.:
```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/',
...
})
```
## Notes
- In production mode, all generated path are prefixed with the `STATIC_URL`
setting of Django.
- 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
# Vite generates files with 8 hash digits
# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TEST
def immutable_file_test(path, url):
# Match filename with 12 hex digits before the extension
# e.g. app.db8f2edc0c8a.js
return re.match(r"^.+\.[0-9a-f]{8,12}\..+$", url)
WHITENOISE_IMMUTABLE_FILE_TEST = immutable_file_test
```
## Example
If you are struggling on how to setup a project using Django / ViteJS and Django Vite,
I've made an [example project here](https://github.com/MrBin99/django-vite-example).
## Thanks
Thanks to [Evan You](https://github.com/yyx990803) for the ViteJS library.
%package -n python3-django-vite
Summary: Integration of ViteJS in a Django project.
Provides: python-django-vite
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-django-vite
# Django Vite
[](https://badge.fury.io/py/django-vite)
Integration of [ViteJS](https://vitejs.dev/) in a Django project.
## Installation
### Django
```
pip install django-vite
```
Add `django_vite` to your `INSTALLED_APPS` in your `settings.py`
(before 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 `true`.
- 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 your ViteJS config file add the following :
```javascript
export default defineConfig({
build {
...
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 setting variable in your `settings.py` named `DJANGO_VITE_ASSETS_PATH`
containing the absolute path to where your assets are built.
- This must correspond to your `build.outDir` in your ViteJS configuration.
- The `DJANGO_VITE_ASSETS_PATH` must be included in your `STATICFILES_DIRS`
Django setting.
- Define a setting variable in your `settings.py` named `DJANGO_VITE_DEV_MODE`
containing a boolean defining 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.
- 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.
Note : `DJANGO_VITE_ASSETS_PATH` supports `pathlib.Path` syntax or pure `str`.
### 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 mode, all scripts are included as modules.
- In development mode, all scripts are marked as `async` and `defer`.
- 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.
- 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 needed to support React HMR.
### Custom attributes
By default, all scripts 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 :
```
{% vite_asset '<path to your asset>' foo="bar" hello="world" %}
```
This line will add `foo="bar"` and `hello="world"` 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.
## 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.
## Miscellaneous configuration
You can redefine those variables in your `settings.py` :
- `DJANGO_VITE_DEV_SERVER_PROTOCOL` : ViteJS webserver protocol
(default : `http`).
- `DJANGO_VITE_DEV_SERVER_HOST` : ViteJS webserver hostname
(default : `localhost`).
- `DJANGO_VITE_DEV_SERVER_PORT` : ViteJS webserver port
(default : `3000`)
- `DJANGO_VITE_WS_CLIENT_URL` : ViteJS webserver path to the HMR client used
in the `vite_hmr_client` tag (default : `@vite/client`).
- `DJANGO_VITE_MANIFEST_PATH` : Absolute path (including filename)
to your ViteJS manifest file. This file is generated in your
`DJANGO_VITE_ASSETS_PATH`. But if you are in production (`DEBUG` is false)
then it is in your `STATIC_ROOT` after you collected your
[static files](https://docs.djangoproject.com/en/3.1/howto/static-files/) (supports `pathlib.Path` or `str`).
- `DJANGO_VITE_LEGACY_POLYFILLS_MOTIF` : The motif used to find the assets for polyfills inside the `manifest.json` (only if you use [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy)).
- `DJANGO_VITE_STATIC_URL_PREFIX` : prefix directory of your static files built by Vite.
(default : `""`)
- Use it if you want to avoid conflicts with other static files in your project.
- It may be used with `STATICFILES_DIRS`.
- You also need to add this prefix inside vite config's `base`.
e.g.:
```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/',
...
})
```
## Notes
- In production mode, all generated path are prefixed with the `STATIC_URL`
setting of Django.
- 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
# Vite generates files with 8 hash digits
# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TEST
def immutable_file_test(path, url):
# Match filename with 12 hex digits before the extension
# e.g. app.db8f2edc0c8a.js
return re.match(r"^.+\.[0-9a-f]{8,12}\..+$", url)
WHITENOISE_IMMUTABLE_FILE_TEST = immutable_file_test
```
## Example
If you are struggling on how to setup a project using Django / ViteJS and Django Vite,
I've made an [example project here](https://github.com/MrBin99/django-vite-example).
## Thanks
Thanks to [Evan You](https://github.com/yyx990803) for the ViteJS library.
%package help
Summary: Development documents and examples for django-vite
Provides: python3-django-vite-doc
%description help
# Django Vite
[](https://badge.fury.io/py/django-vite)
Integration of [ViteJS](https://vitejs.dev/) in a Django project.
## Installation
### Django
```
pip install django-vite
```
Add `django_vite` to your `INSTALLED_APPS` in your `settings.py`
(before 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 `true`.
- 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 your ViteJS config file add the following :
```javascript
export default defineConfig({
build {
...
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 setting variable in your `settings.py` named `DJANGO_VITE_ASSETS_PATH`
containing the absolute path to where your assets are built.
- This must correspond to your `build.outDir` in your ViteJS configuration.
- The `DJANGO_VITE_ASSETS_PATH` must be included in your `STATICFILES_DIRS`
Django setting.
- Define a setting variable in your `settings.py` named `DJANGO_VITE_DEV_MODE`
containing a boolean defining 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.
- 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.
Note : `DJANGO_VITE_ASSETS_PATH` supports `pathlib.Path` syntax or pure `str`.
### 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 mode, all scripts are included as modules.
- In development mode, all scripts are marked as `async` and `defer`.
- 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.
- 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 needed to support React HMR.
### Custom attributes
By default, all scripts 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 :
```
{% vite_asset '<path to your asset>' foo="bar" hello="world" %}
```
This line will add `foo="bar"` and `hello="world"` 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.
## 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.
## Miscellaneous configuration
You can redefine those variables in your `settings.py` :
- `DJANGO_VITE_DEV_SERVER_PROTOCOL` : ViteJS webserver protocol
(default : `http`).
- `DJANGO_VITE_DEV_SERVER_HOST` : ViteJS webserver hostname
(default : `localhost`).
- `DJANGO_VITE_DEV_SERVER_PORT` : ViteJS webserver port
(default : `3000`)
- `DJANGO_VITE_WS_CLIENT_URL` : ViteJS webserver path to the HMR client used
in the `vite_hmr_client` tag (default : `@vite/client`).
- `DJANGO_VITE_MANIFEST_PATH` : Absolute path (including filename)
to your ViteJS manifest file. This file is generated in your
`DJANGO_VITE_ASSETS_PATH`. But if you are in production (`DEBUG` is false)
then it is in your `STATIC_ROOT` after you collected your
[static files](https://docs.djangoproject.com/en/3.1/howto/static-files/) (supports `pathlib.Path` or `str`).
- `DJANGO_VITE_LEGACY_POLYFILLS_MOTIF` : The motif used to find the assets for polyfills inside the `manifest.json` (only if you use [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy)).
- `DJANGO_VITE_STATIC_URL_PREFIX` : prefix directory of your static files built by Vite.
(default : `""`)
- Use it if you want to avoid conflicts with other static files in your project.
- It may be used with `STATICFILES_DIRS`.
- You also need to add this prefix inside vite config's `base`.
e.g.:
```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/',
...
})
```
## Notes
- In production mode, all generated path are prefixed with the `STATIC_URL`
setting of Django.
- 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
# Vite generates files with 8 hash digits
# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TEST
def immutable_file_test(path, url):
# Match filename with 12 hex digits before the extension
# e.g. app.db8f2edc0c8a.js
return re.match(r"^.+\.[0-9a-f]{8,12}\..+$", url)
WHITENOISE_IMMUTABLE_FILE_TEST = immutable_file_test
```
## Example
If you are struggling on how to setup a project using Django / ViteJS and Django Vite,
I've made an [example project here](https://github.com/MrBin99/django-vite-example).
## Thanks
Thanks to [Evan You](https://github.com/yyx990803) for the ViteJS library.
%prep
%autosetup -n django-vite-2.1.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-django-vite -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 2.1.2-1
- Package Spec generated
|
