Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Eptagone/Vite.AspNetCore
Small library to integrate Vite into ASP.NET projects
https://github.com/Eptagone/Vite.AspNetCore
Last synced: about 2 months ago
JSON representation
Small library to integrate Vite into ASP.NET projects
- Host: GitHub
- URL: https://github.com/Eptagone/Vite.AspNetCore
- Owner: Eptagone
- License: mit
- Created: 2023-01-16T05:50:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-26T03:45:43.000Z (3 months ago)
- Last Synced: 2024-06-26T04:45:41.656Z (3 months ago)
- Language: C#
- Size: 522 KB
- Stars: 212
- Watchers: 3
- Forks: 30
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - Vite.AspNetCore - Integration with ASP.NET Core projects. (Integrations with Backends / ASP.NET Core)
- awesome-vite - Vite.AspNetCore - Integration with ASP.NET Core projects. (Integrations with Backends / ASP.NET Core)
README
# Vite.AspNetCore
[)](https://www.nuget.org/packages/Vite.AspNetCore/)
This library offers integration with [ViteJS](https://vitejs.dev/) to be used in ASP.NET applications. It's made to work mainly with MPA (Multi-Page Application).
The library is compatible with:
- MVC
- Razor Pages
- Blazor Server
## Features
This library has the following simple but very useful features:
- A Middleware to forward the requests to the Vite Development Server
- A service to access the Vite manifest.
- Tag Helpers for script and link tags.
- Start the Vite Development Server for you ❤️.
## Setup
Install the package from NuGet.
```PowerShell
dotnet add package Vite.AspNetCore
```
Add the following lines to your `Program.cs` or `Startup` class.
```CSharp
using Vite.AspNetCore;
// ---- Service Configuration ----
// Add Vite services.
builder.Services.AddViteServices();
// ---- App Configuration ----
// Use the Vite Development Server when the environment is Development.
if (app.Environment.IsDevelopment())
{
// WebSockets support is required for HMR (hot module reload).
// Uncomment the following line if your pipeline doesn't contain it.
// app.UseWebSockets();
// Enable all required features to use the Vite Development Server.
// Pass true if you want to use the integrated middleware.
app.UseViteDevelopmentServer(/* false */);
}
```
## Usage
### The Vite Middleware
The [common way](https://vitejs.dev/guide/backend-integration.html) to access **Vite Development Server** assets in your application is by using the following template, specifying the local URL where Vite Server is running.
```HTML
```
Having to set up two ways to access public assets in different environments doesn't look very good. It can also be a problem in some circumstances. Service workers, for example, cannot be properly tested this way and if you are using preprocessors like SASS, you have probably noticed that your 'url()'s are not resolved correctly during development. But don't worry, this middleware will solve all those problems for you.
By using the vite middleware during development, you don't need to pass the development server URL. You can use aspnet paths as usual.
```HTML
```
The middleware will proxy all requests to the Vite Development Server. You won't need alternative paths for images or other resources from your public assets. 🙀🙀🙀
To enable the middleware, pass `true` to the `UseViteDevelopmentServer()` method.
> **Note:** The order of the middlewares is important! Put the `UseViteDevelopmentServer(true)` call in a position according to your needs. Otherwise, your assets will not be served as expected.
### The Vite Manifest
The Vite Manifest is a JSON file that contains the mapping between the original file names and the hashed names. This is useful to access the files in production environments.
By using the Vite Manifest service, you can access the manifest in your application by injecting the `IViteManifest` service. See the following example.
```HTML
@inject IViteManifest Manifest
```
You can also inject the manifest service in your controllers or services. See the following example.
```CSharp
public class HomeController : Controller
{
private readonly IViteManifest _manifest;
public HomeController(IViteManifest manifest)
{
_manifest = manifest;
}
public IActionResult Index()
{
var mainFile = _manifest["main.ts"]?.File;
return View();
}
}
```
### Tag Helpers
Do you want to render your entrypoint scripts and styles in the simplest way possible? You can use the special tag helpers provided by this library. First, add the following line to your `_ViewImports.cshtml` file.
```CSHTML
@addTagHelper *, Vite.AspNetCore
```
Now you can use the `vite-src` and `vite-href` attributes in your scripts and links. See the following example.
```HTML
```
This tag helpers will do the following magic according the state of the Vite Development Server (VDS).
- VDS is enabled:
- If the link tag is a script (you want to include css from a script entrypoint), the link tag will just disappear. This is because Vite loads the styles automatically by including the script.
- If the script of the Vite client is not included, it will be added automatically.
- VDS is disabled:
- The link and script tags will be rendered using the original paths taken from the manifest. The value of the `vite-href` and `vite-src` attributes will be used as the entrypoint to access the manifest.
The rendered HTML when the VDS is enabled will look like this.
```HTML
```
And the rendered HTML when the VDS is disabled will look like this.
```HTML
```
> **Note:** The final paths and filenames depend on how you set it in your `vite.config.ts` file.
## Configuration
The services can be configured by passing options to the `AddViteServices()` function, using environment variables, user secrets, or your `appsettings.json` file.
Passing the options to the `AddViteServices()` function is as simple as you can see in the following example:
```CSharp
// Program.cs
using Vite.AspNetCore;
// ...
// Add the Vite services.
builder.Services.AddViteServices(options =>
{
// By default, the manifest file name is ".vite/manifest.json". If your manifest file has a different name, you can change it here.
options.Manifest = "my-manifest.json",
// More options...
});
/// ...
```
If you prefer not to hardcode the options, you can use environment variables or user secrets. I suggest using `appsettings.json` and/or `appsettings.Development.json` files to share the default configuration with other developers. This information is not sensitive, so it's safe to share it.
```JSONC
// appsettings.json
{
"Vite": {
"Manifest": "my-manifest.json"
}
}
```
```JSONC
// appsettings.Development.json
{
"Vite": {
"Server": {
// Enable the automatic start of the Vite Development Server. The default value is false.
"AutoRun": true,
// The port where the Vite Development Server will be running. The default value is 5173.
"Port": 5174,
// Pass true, if you are using HTTPS to connect to the Vite Development Server. The default value is false.
"Https": false,
}
}
}
```
> In the previous example, i used the `appsettings.json` and `appsettings.Development.json` files to keep the configurations for each environment separated. But you can use only one file if you prefer.
### Available Options
There are more options that you can change. All the available options are listed below. ⚙️
| Property | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `Manifest` | The manifest file name. Default is `.vite/manifest.json` (Vite 5) or `manifest.json` (Vite 4). |
| `Base` | The subfolder where your assets will be located, including the manifest file, relative to the web root path. |
| `Server:Port` | The port where the Vite Development Server will be running. Default value is `5173`. |
| `Server:Host` | The host where the Vite Dev Server will be running. Default value is `localhost`. |
| `Server:TimeOut` | The timeout in seconds spent waiting for the vite dev server. Default is `5` |
| `Server:Https` | Set true, if you are using HTTPS to connect to the Vite Development Server. Default value is `false`. |
| `Server:UseReactRefresh` | If true, the react-refresh script will be injected before the vite client. |
| `Server:AutoRun` | Enable or disable the automatic start of the Vite Dev Server. Default value is `false`. |
| `Server:PackageManager` | The name of the package manager to use. Default value is `npm`. |
| `Server:PackageDirectory` | The directory where the package.json file is located. Default value is the .NET project working directory. |
| `Server:ScriptName` | The script name to run the Vite Development Server. Default value is `dev`. |
> If you are using the `appsettings.json` and/or `appsettings.Development.json` files, all the options must be under the `Vite` property.
## Examples
Do you want to see how to use this library in a real project? Take a look at [these examples](https://github.com/Eptagone/Vite.AspNetCore/tree/main/examples)