@vcmap/plugin-cli 2.1.1 → 2.1.3

package/README.md

@@ -177,7 +177,7 @@ caching more readily.
 The following libraries are provided by the @vcmap/ui in a deployed application. You should define these
 as peer dependencies if you use them in your plugin:
 - @vcmap/core
-- @vcmap/cesium
+- @vcmap-cesium/engine
 - ol
 - vue
 - vuetify
@@ -197,12 +197,12 @@ a plugin and _that the provided index files_ are used (over directly importing f
 
 For instance: 
 ```js
-import Cartesian3 from '@vcmap/cesium/Source/Core/Cartesian3.js';
+import Cartesian3 from '@vcmap-cesium/engine/Source/Core/Cartesian3.js';
 ```
 
 should be rewritten to:
 ```js
-import { Cartesian3 } from '@vcmap/cesium';
+import { Cartesian3 } from '@vcmap-cesium/engine';
 ```
 
 ### What about openlayers?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -40,7 +40,7 @@
     "vue-template-compiler": "~2.7.14"
   },
   "peerDependencies": {
-    "@vcmap/ui": "^5.0.0-rc.15",
+    "@vcmap/ui": "^5.0.0-rc.21",
     "vue": "~2.7.14"
   },
   "peerDependenciesMeta": {
@@ -56,8 +56,7 @@
     "eslint": "^8.9.0"
   },
   "eslintIgnore": [
-    "node_modules",
-    "assets/helloWorld"
+    "node_modules"
   ],
   "eslintConfig": {
     "extends": "@vcsuite/eslint-config/node",

package/src/build.js

@@ -1,10 +1,12 @@
 import path from 'path';
-import fs from 'fs/promises';
+import { rm, mkdir } from 'fs/promises';
+import fs from 'fs';
 import { createVuePlugin } from 'vite-plugin-vue2';
 import vcsOl from '@vcmap/rollup-plugin-vcs-ol';
 import { logger } from '@vcsuite/cli-logger';
 import { getPluginEntry, getPluginName } from './packageJsonHelpers.js';
 import { getContext } from './context.js';
+import { executeUiNpm, resolveMapUi } from './hostingHelpers.js';
 
 /**
  * @typedef {Object} BuildOptions
@@ -30,12 +32,12 @@ export function getDefaultConfig() {
  */
 export async function getLibraryPaths(pluginName) {
   const { libraries } = await import('@vcmap/ui/build/buildHelpers.js');
-  const pluginPath = path.join('plugins', ...pluginName.split('/'));
+  const pluginPath = path.posix.join('plugins', ...pluginName.split('/'));
   const libraryPaths = {};
   Object.entries(libraries).forEach(([library, assetName]) => {
-    const assetPath = path.join('assets', `${assetName}.js`);
+    const assetPath = path.posix.join('assets', `${assetName}.js`);
 
-    libraryPaths[library] = path.relative(pluginPath, assetPath);
+    libraryPaths[library] = path.posix.relative(pluginPath, assetPath);
   });
   return libraryPaths;
 }
@@ -55,8 +57,8 @@ export default async function buildModule(options) {
   const libraryPaths = await getLibraryPaths(pluginName);
   const distPath = path.join(getContext(), 'dist');
   if (!options.keepDistFolder) {
-    await fs.rm(distPath, { recursive: true, force: true });
-    await fs.mkdir(distPath);
+    await rm(distPath, { recursive: true, force: true });
+    await mkdir(distPath);
   }
   const external = Object.keys(libraryPaths);
   const config = {
@@ -89,3 +91,20 @@ export default async function buildModule(options) {
   const { buildLibrary } = await import('@vcmap/ui/build/buildHelpers.js');
   await buildLibrary(config, options.outputPath ?? '', 'index', '', true);
 }
+
+/**
+ * Builds the @vcmap/ui dependency and removes its own core dependency
+ * @returns {Promise<void>}
+ */
+export async function buildMapUI() {
+  logger.spin('building @vcmap/ui dependency');
+  await executeUiNpm('--production=false --no-package-lock', 'install');
+  // remove own core dependency to allow linking core via git+ssh
+  const coreDepPath = resolveMapUi('node_modules', '@vcmap', 'core');
+  if (fs.existsSync(coreDepPath)) {
+    await rm(coreDepPath, { recursive: true, force: true });
+  }
+  await executeUiNpm('build');
+  logger.stopSpinner();
+  logger.info('@vcmap/ui built');
+}

package/src/buildStagingApp.js

@@ -3,9 +3,9 @@ import path from 'path';
 import fs from 'fs';
 import { logger } from '@vcsuite/cli-logger';
 import { getContext, resolveContext } from './context.js';
-import { executeUiNpm, getConfigJson, resolveMapUi } from './hostingHelpers.js';
+import { getConfigJson, resolveMapUi } from './hostingHelpers.js';
 import { getPluginName } from './packageJsonHelpers.js';
-import buildModule, { getDefaultConfig } from './build.js';
+import buildModule, { buildMapUI, getDefaultConfig } from './build.js';
 import setupMapUi from './setupMapUi.js';
 
 
@@ -37,11 +37,7 @@ export default async function buildStagingApp() {
 
   // In case @vcmap/ui is linked via git+ssh, dist folder is not available and must be built first
   if (!fs.existsSync(resolveMapUi('dist'))) {
-    logger.spin('building @vcmap/ui');
-    await executeUiNpm('--production=false --no-package-lock', 'install');
-    await executeUiNpm('build');
-    logger.stopSpinner();
-    logger.info('@vcmap/ui built');
+    await buildMapUI();
   }
 
   await copyFile(

package/src/create.js

@@ -311,7 +311,7 @@ export default async function create() {
 
   const peerDependencyChoices = [
     { title: '@vcmap/core', value: '@vcmap/core' },
-    { title: '@vcmap/cesium', value: '@vcmap/cesium' },
+    { title: '@vcmap-cesium/engine', value: '@vcmap-cesium/engine' },
     { title: 'ol', value: 'ol' },
     { title: 'vue', value: 'vue' },
     { title: 'vuetify', value: 'vuetify' },

package/src/preview.js

@@ -13,7 +13,7 @@ import {
   printVcmapUiVersion,
   resolveMapUi,
 } from './hostingHelpers.js';
-import build, { getDefaultConfig, getLibraryPaths } from './build.js';
+import build, { buildMapUI, getDefaultConfig, getLibraryPaths } from './build.js';
 import { getContext } from './context.js';
 import setupMapUi from './setupMapUi.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
@@ -79,6 +79,10 @@ export default async function preview(options) {
   const mergedOptions = { ...vcmConfigJs, ...options };
   if (!mergedOptions.vcm) {
     await printVcmapUiVersion();
+    // In case @vcmap/ui is linked via git+ssh, dist folder is not available and must be built first
+    if (!fs.existsSync(resolveMapUi('dist'))) {
+      await buildMapUI();
+    }
   }
   checkReservedDirectories();
   await build({ development: false, watch: true });

package/src/serve.js

@@ -16,6 +16,7 @@ import {
 } from './hostingHelpers.js';
 import { getPluginName } from './packageJsonHelpers.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
+import { buildMapUI } from './build.js';
 
 /**
  * @typedef {HostingOptions} ServeOptions
@@ -56,6 +57,11 @@ async function getProxy(protocol, port) {
     changeOrigin: true,
     secure: false,
   };
+  // Cesium engine assets are not part of Build
+  proxy['/node_modules/@vcmap-cesium/engine/Build/Assets'] = {
+    target,
+    rewrite: p => p.replace(/Build/, 'Source'),
+  };
   return proxy;
 }
 
@@ -71,6 +77,10 @@ export default async function serve(options) {
   const { default: vcmConfigJs } = await getVcmConfigJs();
   const mergedOptions = { ...vcmConfigJs, ...options };
   await printVcmapUiVersion();
+  // In case @vcmap/ui is linked via git+ssh, dist folder is not available and must be built first
+  if (!fs.existsSync(resolveMapUi('dist'))) {
+    await buildMapUI();
+  }
   checkReservedDirectories();
   const app = express();
   const port = mergedOptions.port || 8008;
@@ -92,7 +102,7 @@ export default async function serve(options) {
         'fast-deep-equal',
         'rbush-knn',
         'pbf',
-        '@vcmap/cesium',
+        '@vcmap-cesium/engine',
       ],
     },
     plugins: [