coder-xiaomo/vite-plugin-cesium-next
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity GitHub Gitee

Compare commits

base: coder-xiaomo:v1.x
Branches Tags
coder-xiaomo:main coder-xiaomo:upstream
coder-xiaomo:v2.0.4 coder-xiaomo:v2.0.3 coder-xiaomo:v1.x coder-xiaomo:v2.0.1
..
compare: coder-xiaomo:v2.0.1
Branches Tags
coder-xiaomo:main coder-xiaomo:upstream
coder-xiaomo:v2.0.4 coder-xiaomo:v2.0.3 coder-xiaomo:v1.x coder-xiaomo:v2.0.1

11 Commits
v1.x ... v2.0.1

Author SHA1 Message Date
小墨
52c6655b7a release 2.0.1 2025-06-12 07:20:48 +08:00
小墨
266517ac08 chore: 升级 GitHub Action 文件相关依赖版本 2025-06-12 07:19:01 +08:00
小墨
d32625d649 chore: 移除 package-lock.json，避免影响 GitHub Action CI 流程 (yarn) 2025-06-12 07:12:29 +08:00
小墨
e915298dfc chore: update LICENSE copyright year 2025-06-12 07:05:34 +08:00
小墨
a8d9479375 chore: demo 项目跑通 2025-06-12 07:00:06 +08:00
小墨
3c8bad430b 升级依赖版本 2025-06-12 06:33:18 +08:00
小墨
564a6ece40 提交 package-lock.json 文件 2025-06-12 06:14:32 +08:00
小墨
436466b519 README 中更新使用指南 2025-06-12 06:12:51 +08:00
小墨
352ba1eba5 vite-plugin-cesium 更名为 vite-plugin-cesium-next，为发布做准备 2025-06-12 06:07:48 +08:00
小墨
08e0da60dd 当 base 配置为 /foo/bar 格式时，cesium 资源路径改为 /foo/bar/cesium 2025-06-12 05:57:04 +08:00
小墨
50b3f7d545 修复 Cesium 引入相对路径问题 2025-06-12 05:56:48 +08:00
11 changed files with 149 additions and 71 deletions
Expand all files Collapse all files

16
.github/workflows/ci.yml vendored
View File

@@ -12,11 +12,11 @@ jobs:
name: 'Build-Test' name: 'Build-Test'
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v4
- name: Use Node.js - name: Use Node.js
uses: actions/setup-node@v2 uses: actions/setup-node@v4
with: with:
node-version: '16' node-version: '22'
- name: Install Deps - name: Install Deps
run: yarn install run: yarn install
- name: Build - name: Build
@@ -27,18 +27,18 @@ jobs:
strategy: strategy:
matrix: matrix:
os: [ubuntu-latest] os: [ubuntu-latest]
node_version: ['16'] node_version: ['22']
include: include:
- os: macos-latest - os: macos-latest
node_version: 16 node_version: 22
- os: windows-latest - os: windows-latest
node_version: 16 node_version: 22
name: 'Demo-Build-Test: node-${{ matrix.node_version }}, ${{ matrix.os }}' name: 'Demo-Build-Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v4
- name: Set node version to ${{ matrix.node_version }} - name: Set node version to ${{ matrix.node_version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v4
with: with:
node-version: ${{ matrix.node_version }} node-version: ${{ matrix.node_version }}
- name: Package Install deps - name: Package Install deps

8
.github/workflows/publish-to-npm.yml vendored
View File

@@ -7,15 +7,15 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v4
- name: Setup Node - name: Setup Node
uses: actions/setup-node@v2 uses: actions/setup-node@v4
with: with:
node-version: '16.x' node-version: '22.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
- name: Install dependencies and build - name: Install dependencies and build
run: npm install && npm run build run: npm install && npm run build
- name: Publish package on NPM - name: Publish package on NPM
run: npm publish run: npm publish
env: env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

1
.gitignore vendored
View File

@@ -4,3 +4,4 @@ dist
demo/public demo/public
yarn.lock yarn.lock
pnpm-lock.yaml pnpm-lock.yaml
package-lock.json

8
.publish.md Normal file
View File

@@ -0,0 +1,8 @@
## 发包步骤
```sh
nrm use npm
npm adduser
npm publish
nrm use taobao
```

2
LICENSE
View File

@@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2021 Nshen Copyright (c) 2025 coder-xiaomo, 2021 Nshen
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

40
README.md
View File

@@ -1,3 +1,43 @@
# ⚡ vite-plugin-cesium-next
> 本仓库 fork 自 [nshen/vite-plugin-cesium](https://github.com/nshen/vite-plugin-cesium)
本仓库在原仓库代码基础上，主要针对性修复/优化了以下问题
- 相对路径问题：本仓库已支持在 vite.config.ts 中配置以下类型的 base: `'./'`, `'/'`, `'/foo/bar'`, `''`, `(不设置)` (新创建的项目 base 默认为 `'./'`，而原仓库针对 `'./'` 没有做很好的处理)
- 资源请求路径：当 base 形如 `'/foo/bar'` 时，cesium 静态文件由 `/cesium...` 改为请求 `/foo/bar/cesium...`
鉴于原仓库作者可能不再维护此项目(详见：[issue](https://github.com/nshen/vite-plugin-cesium/issues/62#issuecomment-2957419669))，故 fork 本仓库 ([coder-xiaomo/vite-plugin-cesium-next](https://github.com/coder-xiaomo/vite-plugin-cesium-next)) 继续维护，欢迎提交 Issue / Pr ！
## Install
```bash
npm i cesium vite-plugin-cesium-text vite -D
# yarn add cesium vite-plugin-cesium-text vite -D
```
## Usage
add this plugin to `vite.config.js`
```js
import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium-next'; // 👈 添加这一行
export default defineConfig({
plugins: [
// ...
cesium(), // 👈 添加这一行
// 或者如果你需要自定义配置，可以这样写 👇
// cesium({ /* 这里可以添加配置 */ }),
]
});
```
---
以下是原仓库 README
# ⚡ vite-plugin-cesium # ⚡ vite-plugin-cesium
[![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium) [![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium)

24
demo/index.html
View File

@@ -1,14 +1,16 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cesium-vite</title>
<script type="module" src="/src/index.ts"></script>
</head>
<body> <head>
<div id="cesiumContainer"></div> <meta charset="UTF-8" />
</body> <meta http-equiv="X-UA-Compatible" content="IE=edge" />
</html> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cesium-vite</title>
<script type="module" src="/src/index.ts"></script>
</head>
<body>
<div id="cesiumContainer"></div>
</body>
</html>

6
demo/package.json
View File

@@ -9,8 +9,8 @@
"serve": "vite build && vite preview" "serve": "vite build && vite preview"
}, },
"devDependencies": { "devDependencies": {
"cesium": "1.96.0", "cesium": "1.129.0",
"vite": "3.0.4", "vite": "file:../node_modules/vite",
"vite-plugin-cesium": "link:.." "vite-plugin-cesium-next": "file:.."
} }
} }

10
demo/vite.config.ts
View File

@@ -1,6 +1,12 @@
import { defineConfig } from 'vite'; import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium'; import cesium from 'vite-plugin-cesium-next';
export default defineConfig({ export default defineConfig({
plugins: [cesium()] // base: './',
// base: '/',
base: '/foo/bar',
plugins: [
cesium(),
],
}); });

33
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "vite-plugin-cesium", "name": "vite-plugin-cesium-next",
"version": "1.2.23", "version": "2.0.1",
"description": "Cesium library plugin for Vite", "description": "Cesium library plugin for Vite",
"main": "./dist/index.js", "main": "./dist/index.js",
"module": "./dist/index.mjs", "module": "./dist/index.mjs",
@@ -25,29 +25,32 @@
"vite-plugin", "vite-plugin",
"cesium" "cesium"
], ],
"author": "nshen <nshen121@gmail.com>", "author": "coderxiaomo <codingzhang@126.com>",
"contributors": [
"nshen <nshen121@gmail.com>"
],
"license": "MIT", "license": "MIT",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/nshen/vite-plugin-cesium" "url": "git+https://github.com/coder-xiaomo/vite-plugin-cesium-next"
}, },
"bugs": { "bugs": {
"url": "https://github.com/nshen/vite-plugin-cesium/issues" "url": "https://github.com/coder-xiaomo/vite-plugin-cesium-next/issues"
}, },
"dependencies": { "dependencies": {
"fs-extra": "^9.1.0", "fs-extra": "^11.3.0",
"rollup-plugin-external-globals": "^0.6.1", "rollup-plugin-external-globals": "^0.6.1",
"serve-static": "^1.14.1" "serve-static": "^1.16.2"
}, },
"devDependencies": { "devDependencies": {
"@tsconfig/node12": "^1.0.7", "@tsconfig/node22": "^22.0.2",
"@types/fs-extra": "^9.0.8", "@types/fs-extra": "^11.0.4",
"@types/node": "^14.14.31", "@types/node": "^22.15.31",
"@types/serve-static": "^1.13.9", "@types/serve-static": "^1.15.8",
"prettier": "^2.2.1", "prettier": "^3.5.3",
"tsup": "^6.2.1", "tsup": "^8.5.0",
"typescript": "^4.2.2", "typescript": "^5.8.3",
"vite": "^3.0.4" "vite": "^6.1.0"
}, },
"peerDependencies": { "peerDependencies": {
"cesium": "^1.95.0", "cesium": "^1.95.0",

72
src/index.ts
View File

@@ -13,6 +13,7 @@ interface VitePluginCesiumOptions {
cesiumBuildRootPath?: string; cesiumBuildRootPath?: string;
cesiumBuildPath?: string; cesiumBuildPath?: string;
cesiumBaseUrl?: string; cesiumBaseUrl?: string;
viteBase?: string;
} }
export default function vitePluginCesium(options: VitePluginCesiumOptions = {}): Plugin { export default function vitePluginCesium(options: VitePluginCesiumOptions = {}): Plugin {
@@ -21,35 +22,52 @@ export default function vitePluginCesium(options: VitePluginCesiumOptions = {}):
devMinifyCesium = false, devMinifyCesium = false,
cesiumBuildRootPath = 'node_modules/cesium/Build', cesiumBuildRootPath = 'node_modules/cesium/Build',
cesiumBuildPath = 'node_modules/cesium/Build/Cesium/', cesiumBuildPath = 'node_modules/cesium/Build/Cesium/',
cesiumBaseUrl = 'cesium/' cesiumBaseUrl = 'cesium/',
viteBase = undefined,
} = options; } = options;
let CESIUM_BASE_URL = cesiumBaseUrl; const CESIUM_BASE_URL = cesiumBaseUrl.endsWith('/')
if (!CESIUM_BASE_URL.endsWith('/')) { ? cesiumBaseUrl
CESIUM_BASE_URL += '/'; : (cesiumBaseUrl + '/');
const globalVars: {
outDir: string,
base: string,
isBuild: boolean,
cesiumRelativeUrl: string,
} = {
outDir: 'dist',
base: '/',
isBuild: false,
cesiumRelativeUrl: '',
} }
let outDir = 'dist';
let base: string = '/';
let isBuild: boolean = false;
return { return {
name: 'vite-plugin-cesium', name: 'vite-plugin-cesium-next',
config(c, { command }) { config(c, { command }) {
isBuild = command === 'build'; // 项目中 vite.config.ts 配置的 base 路径
if (c.base !== undefined) { if (viteBase) {
base = c.base; globalVars.base = viteBase;
if (base === '') base = './'; } else if (c.base) {
globalVars.base = c.base;
} else {
globalVars.base = '/';
} }
// 是否是打包命令
globalVars.isBuild = command === 'build';
// 输出路径
if (c.build?.outDir) { if (c.build?.outDir) {
outDir = c.build.outDir; globalVars.outDir = c.build.outDir;
} }
CESIUM_BASE_URL = path.posix.join(base, CESIUM_BASE_URL); // 项目浏览器中运行时，Cesium 资源的相对路径
globalVars.cesiumRelativeUrl = path.posix.join(globalVars.base, CESIUM_BASE_URL);
const userConfig: UserConfig = {}; const userConfig: UserConfig = {};
if (!isBuild) { if (!globalVars.isBuild) {
// -----------dev----------- // -----------dev-----------
userConfig.define = { userConfig.define = {
CESIUM_BASE_URL: JSON.stringify(CESIUM_BASE_URL) CESIUM_BASE_URL: JSON.stringify(globalVars.cesiumRelativeUrl)
}; };
} else { } else {
// -----------build------------ // -----------build------------
@@ -60,7 +78,7 @@ export default function vitePluginCesium(options: VitePluginCesiumOptions = {}):
chunkSizeWarningLimit: 5000, chunkSizeWarningLimit: 5000,
rollupOptions: { rollupOptions: {
output: { output: {
intro: `window.CESIUM_BASE_URL = ${JSON.stringify(CESIUM_BASE_URL)};` intro: `window.CESIUM_BASE_URL = ${JSON.stringify(globalVars.cesiumRelativeUrl)};`
} }
} }
}; };
@@ -79,7 +97,7 @@ export default function vitePluginCesium(options: VitePluginCesiumOptions = {}):
configureServer({ middlewares }) { configureServer({ middlewares }) {
const cesiumPath = path.join(cesiumBuildRootPath, devMinifyCesium ? 'Cesium' : 'CesiumUnminified'); const cesiumPath = path.join(cesiumBuildRootPath, devMinifyCesium ? 'Cesium' : 'CesiumUnminified');
middlewares.use(path.posix.join('/', CESIUM_BASE_URL), serveStatic(cesiumPath, { middlewares.use(path.posix.join('/', globalVars.cesiumRelativeUrl), serveStatic(cesiumPath, {
setHeaders: (res, path, stat) => { setHeaders: (res, path, stat) => {
res.setHeader('Access-Control-Allow-Origin', '*') res.setHeader('Access-Control-Allow-Origin', '*')
} }
@@ -87,14 +105,14 @@ export default function vitePluginCesium(options: VitePluginCesiumOptions = {}):
}, },
async closeBundle() { async closeBundle() {
if (isBuild) { if (globalVars.isBuild) {
try { try {
await fs.copy(path.join(cesiumBuildPath, 'Assets'), path.join(outDir, CESIUM_BASE_URL, 'Assets')); await fs.copy(path.join(cesiumBuildPath, 'Assets'), path.join(globalVars.outDir, CESIUM_BASE_URL, 'Assets'));
await fs.copy(path.join(cesiumBuildPath, 'ThirdParty'), path.join(outDir, CESIUM_BASE_URL, 'ThirdParty')); await fs.copy(path.join(cesiumBuildPath, 'ThirdParty'), path.join(globalVars.outDir, CESIUM_BASE_URL, 'ThirdParty'));
await fs.copy(path.join(cesiumBuildPath, 'Workers'), path.join(outDir, CESIUM_BASE_URL, 'Workers')); await fs.copy(path.join(cesiumBuildPath, 'Workers'), path.join(globalVars.outDir, CESIUM_BASE_URL, 'Workers'));
await fs.copy(path.join(cesiumBuildPath, 'Widgets'), path.join(outDir, CESIUM_BASE_URL, 'Widgets')); await fs.copy(path.join(cesiumBuildPath, 'Widgets'), path.join(globalVars.outDir, CESIUM_BASE_URL, 'Widgets'));
if (!rebuildCesium) { if (!rebuildCesium) {
await fs.copy(path.join(cesiumBuildPath, 'Cesium.js'), path.join(outDir, CESIUM_BASE_URL, 'Cesium.js')); await fs.copy(path.join(cesiumBuildPath, 'Cesium.js'), path.join(globalVars.outDir, CESIUM_BASE_URL, 'Cesium.js'));
} }
} catch (err) { } catch (err) {
console.error('copy failed', err); console.error('copy failed', err);
@@ -108,15 +126,15 @@ export default function vitePluginCesium(options: VitePluginCesiumOptions = {}):
tag: 'link', tag: 'link',
attrs: { attrs: {
rel: 'stylesheet', rel: 'stylesheet',
href: normalizePath(path.join(CESIUM_BASE_URL, 'Widgets/widgets.css')), href: normalizePath(path.join(globalVars.cesiumRelativeUrl, 'Widgets/widgets.css')),
} }
} }
]; ];
if (isBuild && !rebuildCesium) { if (globalVars.isBuild && !rebuildCesium) {
tags.push({ tags.push({
tag: 'script', tag: 'script',
attrs: { attrs: {
src: normalizePath(path.join(CESIUM_BASE_URL, 'Cesium.js')), src: normalizePath(path.join(globalVars.cesiumRelativeUrl, 'Cesium.js')),
} }
}); });
} }