包简介

README 文档

README

this package is a fork of original: passchn/silverstripe-vite. note this package may undergo some development overtime so be sure you lock to the version that works in your application. This package is compatible with both nginx and appache servers out of the box.

For local development be sure to run npm run watch in the themes/template folder. if using homestead install npm and run watch from your windows machine to generate correct symlinks and add ability to watch file changes. To thus far no option for npm run dev on homestead, might work on Xamp or Mamp but not tried yet.

For feature requests drop a PR or send a message. Enjoy :)

Silverstripe Version support

0.0.5 supports Silverstripe 4.x | php 7.4
^1.0 supports Silverstripe 4.x | php 8.1
^1.0.1 supports Silverstripe 5.x. | php 8.1
^1.0.2 supports Silverstripe 6.x. | ^php 8.3
^1.0.3 supports Silverstripe 6.x. | ^php 8.3 | changed dataExtension to Extension
^1.0.4 supports Silverstripe 6.x. | ^php 8.3 | changed ViewableData to ModelData

Installation

composer require dima-support/silverstripe-vite

In your mysite.yml:

Page:
  extensions:
    - ViteHelper\Vite\ViteDataExtension

Configuration

You can override the default config in your mysite.yml:

ViteHelper\Vite\ViteHelper:
  forceProductionMode: false
  devHostNeedle: $_SERVER['HTTP_HOST']
  devPort: 3000
  jsSrcDirectory: '/public/_resources/themes/template/src/js/'
  mainJS: 'main.js'
  manifestDir: '/public/manifest.json'

ViteHelper Config setting options:

If you set forceProductionMode to true, the build files (created after running vite build) will be served.
Set the devHostNeedle to distinguish your live site from your local environment, e.g localhost:8080, mysite.test or 127.0.0.1.
- Note: The vite dev server must also be running.
Set the devPort to the port of the vite dev server, e.g. 3000 – the vite port will be shown in the terminal when running the dev server. To set a fixed port (recommended), remember to also set it in the vite config - under server. The port in both configs must always match.
Define the mainJS entry point to where your applications script file is located.
- E.g., if you use TypeScript, change the mainJs prop to "main.ts".
Define the manifestDir for where the manifest file will be located.

Usage

Insert JS / CSS tags in your main template, e.g., Page.ss:

<head>
    ...
    $Vite.HeaderTags.RAW
</head>
<body>
    ...
    $Vite.BodyTags.RAW
</body>

Vite config

The config must match the vite.config.js. You need to ?flush after making changes to yml configs.

Take a look at the ViteHelper.php for more Information.

The config from your vite.config.js or vite.config.ts must match your ViteHelper config for this plugin.

See this example vite.config.ts for default configuration.

Note: When using vite below 2.9.0, the server config will be different. See this config.

dima-support/silverstripe-vite 适用场景与选型建议

dima-support/silverstripe-vite 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 249 次下载、GitHub Stars 达 1，最近一次更新时间为 2023 年 12 月 14 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 dima-support/silverstripe-vite 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 dima-support/silverstripe-vite 我们能提供哪些服务？

定制开发 / 二次开发

基于 dima-support/silverstripe-vite 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

dima-support/silverstripe-vite

包简介