@vcmap/plugin-cli 3.1.2 → 4.0.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "3.1.2",
+  "version": "4.0.0-rc.1",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -31,19 +31,19 @@
   "dependencies": {
     "@vcmap/rollup-plugin-vcs-ol": "^1.0.2",
     "@vcsuite/cli-logger": "^1.0.0",
-    "@vitejs/plugin-vue2": "^2.2.0",
+    "@vitejs/plugin-vue": "^5.0.4",
     "commander": "^10.0.1",
     "express": "^4.18.2",
     "prompts": "^2.4.2",
-    "sass": "1.32.13",
+    "sass": "^1.77.1",
     "semver": "^7.5.4",
     "tar": "^6.1.15",
-    "vite": "^4.5.2",
+    "vite": "^5.2.11",
     "vue-template-compiler": "~2.7.14"
   },
   "peerDependencies": {
-    "@vcmap/ui": "^5.2.0",
-    "vue": "~2.7.14"
+    "@vcmap/ui": "^6.0.0-rc.1",
+    "vue": "~3.4.27"
   },
   "peerDependenciesMeta": {
     "@vcmap/ui": {
@@ -81,7 +81,7 @@
   },
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "engines": {
-    "node": ">=18.12.0",
-    "npm": ">=9.0.0"
+    "node": ">=18.12.0 || >= 20.0.0",
+    "npm": ">=9.0.0 || 10.0.0"
   }
 }

package/src/build.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import { rm, mkdir } from 'node:fs/promises';
 import fs from 'node:fs';
-import vue2 from '@vitejs/plugin-vue2';
+import vue from '@vitejs/plugin-vue';
 import vcsOl from '@vcmap/rollup-plugin-vcs-ol';
 import { logger } from '@vcsuite/cli-logger';
 import { getEntry, getPluginName } from './packageJsonHelpers.js';
@@ -19,7 +19,7 @@ import { executeUiNpm, resolveMapUi } from './hostingHelpers.js';
 export function getDefaultConfig() {
   return {
     publicDir: false,
-    plugins: [vue2(), vcsOl()],
+    plugins: [vue(), vcsOl()],
   };
 }
 

package/src/create.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import prompts from 'prompts';
-import { minVersion, parse, valid } from 'semver';
+import { minVersion, parse, prerelease, valid } from 'semver';
 import tar from 'tar';
 import { logger } from '@vcsuite/cli-logger';
 import { LicenseType, writeLicense } from './licenses.js';
@@ -164,6 +164,11 @@ async function createPluginTemplate(options, pluginPath) {
         root: true,
         extends: '@vcsuite/eslint-config/vue',
       };
+    } else {
+      await fs.promises.copyFile(
+        path.join(getDirname(), '..', 'assets', 'eslintrc.cjs'),
+        path.join(pluginPath, '.eslintrc.cjs'),
+      );
     }
     packageJson.prettier = '@vcsuite/eslint-config/prettier.js';
   }
@@ -214,15 +219,15 @@ async function createPluginTemplate(options, pluginPath) {
         path.join(pluginPath, 'tests'),
         { recursive: true },
       );
+      await fs.promises.copyFile(
+        path.join(getDirname(), '..', 'assets', 'eslintrcTests.cjs'),
+        path.join(pluginPath, '.eslintrc.cjs'),
+      );
     }
     await fs.promises.copyFile(
       path.join(getDirname(), '..', 'assets', 'vitest.config.js'),
       path.join(pluginPath, 'vitest.config.js'),
     );
-    await fs.promises.copyFile(
-      path.join(getDirname(), '..', 'assets', 'eslintrcTests.cjs'),
-      path.join(pluginPath, '.eslintrc.cjs'),
-    );
   }
 
   try {
@@ -230,11 +235,30 @@ async function createPluginTemplate(options, pluginPath) {
       (obj, key) => ({ ...obj, [key]: 'latest' }),
       {},
     );
-    const { major, minor } = parse(
-      minVersion(cliPeerDependencies['@vcmap/ui']),
-    );
-    const mapVersion = `^${major}.${minor}`;
-    await updatePeerDependencies(peerDependencies, pluginPath, { mapVersion });
+
+    if (cliPeerDependencies['@vcmap/ui'].startsWith('git')) {
+      logger.warning('installing git ui peer dependency');
+      const peerDeps = [
+        cliPeerDependencies['@vcmap/ui'],
+        ...Object.keys(peerDependencies),
+      ];
+      await installDeps(peerDeps, DepType.PEER, pluginPath);
+    } else {
+      let mapVersion;
+      const mapSemver = parse(minVersion(cliPeerDependencies['@vcmap/ui']));
+      if (prerelease(mapSemver)) {
+        const { major, minor, patch } = mapSemver;
+        mapVersion = `^${major}.${minor}.${patch}-rc`;
+      } else {
+        const { major, minor } = mapSemver;
+        mapVersion = `^${major}.${minor}`;
+      }
+
+      await updatePeerDependencies(peerDependencies, pluginPath, {
+        mapVersion,
+      });
+    }
+
     logger.spin('installing dependencies... (this may take a while)');
     const devDeps = [`${name}@${version}`];
     if (installEsLint) {

package/src/packageJsonHelpers.js

@@ -74,9 +74,10 @@ export const DepType = {
  * @param {Array<string>} deps
  * @param {DepType} type
  * @param {string} pluginPath
+ * @param {boolean} [force=false]
  * @returns {Promise<void>}
  */
-export async function installDeps(deps, type, pluginPath) {
+export async function installDeps(deps, type, pluginPath, force = false) {
   if (deps.length < 1) {
     return;
   }
@@ -86,6 +87,11 @@ export async function installDeps(deps, type, pluginPath) {
   } else if (type === DepType.DEV) {
     save = '--save-dev';
   }
+
+  if (force) {
+    save = `${save} --force`;
+  }
+
   const installCmd = `npm i ${save} ${deps.map((d) => `"${d}"`).join(' ')}`; // wrap deps with "" for windows
   logger.debug(installCmd);
   const { stdout, stderr } = await promiseExec(installCmd, { cwd: pluginPath });

package/src/preview.js

@@ -13,11 +13,7 @@ import {
   printVcmapUiVersion,
   resolveMapUi,
 } from './hostingHelpers.js';
-import build, {
-  buildMapUI,
-  getDefaultConfig,
-  getLibraryPaths,
-} from './build.js';
+import build, { buildMapUI, getDefaultConfig } from './build.js';
 import { getContext } from './context.js';
 import setupMapUi from './setupMapUi.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
@@ -27,29 +23,12 @@ import { getVcmConfigJs } from './pluginCliHelper.js';
  * @property {string} [vcm] - an optional URL to a VC Map application
  */
 
-/**
- * @param {Object<string, string>} alias
- * @param {Object<string, string>} libraryPaths
- */
-function setAliases(alias, libraryPaths) {
-  Object.values(libraryPaths).forEach((entry) => {
-    alias[entry] = entry.replace(/(..\/)*assets/, '/assets');
-  });
-}
-
 /**
  * @param {VcmConfigJs} options
  * @returns {Promise<import("vite").InlineConfig>}
  */
 async function getServerOptions(options) {
   let proxy = options.proxy || {};
-  const normalLibraries = await getLibraryPaths('normal');
-  const scopedLibraries = await getLibraryPaths('@scoped/plugin');
-  const alias = {
-    '@cesium/engine': '@vcmap-cesium/engine',
-  };
-  setAliases(alias, normalLibraries);
-  setAliases(alias, scopedLibraries);
 
   if (options.vcm) {
     const proxyOptions = {
@@ -75,13 +54,30 @@ async function getServerOptions(options) {
   return {
     publicDir: false,
     plugins: [createConfigJsonReloadPlugin()],
+
     resolve: {
-      alias,
+      alias: [
+        {
+          find: /(\.\.\/)+assets(.*)/,
+          replacement: '/assets$2',
+          customResolver: {
+            resolveId(source) {
+              return source;
+            },
+          },
+        },
+        {
+          find: '@cesium/engine',
+          replacement: '@vcmap-cesium/engine',
+        },
+      ],
     },
     server: {
+      preTransformRequests: false,
       middlewareMode: true,
       proxy,
     },
+    appType: 'custom',
   };
 }
 

package/src/serve.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import { readFile } from 'fs/promises';
 import { createServer } from 'vite';
-import vue2 from '@vitejs/plugin-vue2';
+import vue from '@vitejs/plugin-vue';
 import express from 'express';
 import { logger } from '@vcsuite/cli-logger';
 import path from 'path';
@@ -158,7 +158,7 @@ export default async function serve(options) {
       ],
       include: optimizationIncludes,
     },
-    plugins: [vue2(), createConfigJsonReloadPlugin()],
+    plugins: [vue(), createConfigJsonReloadPlugin()],
     server: {
       middlewareMode: true,
       proxy: { ...mergedOptions.proxy, ...proxy },

package/src/update.js

@@ -1,17 +1,18 @@
 import { logger } from '@vcsuite/cli-logger';
-import { validRange } from 'semver';
+import { validRange, prerelease } from 'semver';
 import {
   checkVcMapVersion,
   DepType,
   getPackageJson,
   installDeps,
 } from './packageJsonHelpers.js';
-import { name, promiseExec } from './pluginCliHelper.js';
+import { name, version, promiseExec } from './pluginCliHelper.js';
 import { getContext } from './context.js';
 
 /**
  * @typedef {Object} UpdateOptions
  * @property {string} [mapVersion] - Optional version of @vcmap/ui to update to. Default is latest
+ * @property {boolean} [force] - Force install
  */
 
 /**
@@ -46,7 +47,7 @@ export async function updatePeerDependencies(
     peerDeps.push(...pluginPeerDeps);
   }
   logger.spin('Updating peer dependencies');
-  await installDeps(peerDeps, DepType.PEER, pluginPath);
+  await installDeps(peerDeps, DepType.PEER, pluginPath, options.force);
   logger.stopSpinner();
   logger.success('Updated peer dependencies');
 }
@@ -58,7 +59,11 @@ export async function updatePeerDependencies(
  */
 async function updateCli(pluginPath) {
   logger.spin(`Updating ${name}`);
-  await installDeps([`${name}@latest`], DepType.DEV, pluginPath);
+  let versionToUse = 'latest';
+  if (prerelease(version)) {
+    versionToUse = `^${version}`;
+  }
+  await installDeps([`${name}@${versionToUse}`], DepType.DEV, pluginPath, true);
   logger.stopSpinner();
   logger.success(`Updated ${name}`);
 }
@@ -72,8 +77,11 @@ async function updateCli(pluginPath) {
 export default async function update(options) {
   const packageJson = await getPackageJson();
   const context = getContext();
-  await updatePeerDependencies(packageJson.peerDependencies, context, options);
-  await checkVcMapVersion(context);
   await updateCli(context);
+  await updatePeerDependencies(packageJson.peerDependencies, context, {
+    force: true,
+    ...options,
+  });
+  await checkVcMapVersion(context);
   logger.success(`Updated plugin ${packageJson.name}`);
 }