@vcmap/plugin-cli 2.1.3 → 2.1.5

package/README.md

@@ -136,7 +136,7 @@ in the VC Publishers `plugins` public directory.
 ## vcm config js
 
 The `@vcmap/plugin-cli` supports an optional configuration file, which can be used for the commands `serve` and `preview`.
-It's an alternative to providing cli parameters (which will still have precedence) and even has a few extra feature like proxy.
+It's an alternative to providing cli parameters (which will still have precedence) and even has a few extra feature like proxy or inline config files.
 This can be helpful, if you want to share specific parameters valid for a specific plugin.
 In order to do so just save a `vcm.config.js` in your plugin's root directory.
 This file has to return a js object as default export.
@@ -155,14 +155,15 @@ export default {
 
 The following parameters are valid:
 
-| parameter | type    | description                                                                                   |
-|-----------|---------|-----------------------------------------------------------------------------------------------|
-| config    | string  | an optional fileName to use for configuring the plugin                                        |
-| port      | number  | optional alternative port (default 8008)                                                      |
-| https     | boolean | wether to use http (default) or https                                                         |
-| mapConfig | string  | a filename or URL to a map config (for `serve` command)                                       |
-| vcm       | string  | a filename or URL to a map (for `preview` command)                                            |
-| proxy     | Object  | a server proxy (see [vitejs.dev](https://vitejs.dev/config/server-options.html#server-proxy)) |
+| parameter | type               | description                                                                                   |
+|-----------|--------------------|-----------------------------------------------------------------------------------------------|
+| config    | string|Object | an optional configObject or fileName to use for configuring the plugin                        |
+| auth      | string             | potential auth string to download assets (index.html, config) with                            |
+| port      | number             | optional alternative port (default 8008)                                                      |
+| https     | boolean            | whether to use http (default) or https                                                        |
+| mapConfig | string|Object | an optional configObject resp. fileName or URL to a map config (for `serve` command)          |
+| vcm       | string             | a filename or URL to a map (for `preview` command)                                            |
+| proxy     | Object             | a server proxy (see [vitejs.dev](https://vitejs.dev/config/server-options.html#server-proxy)) |
 
 
 ## About Peer Dependencies

package/assets/.gitlab-ci.yml

@@ -147,8 +147,8 @@ version:
     - npm version patch -m "%s [skip-ci]"
     - TAG=`git describe --abbrev=0`
     - echo git push git@gitlab:vcsuite/"$CI_PROJECT_PATH".git
-    - git push git@gitlab:vcsuite/"$CI_PROJECT_PATH".git $TAG
-    - git push git@gitlab:vcsuite/"$CI_PROJECT_PATH".git HEAD:$CI_COMMIT_REF_NAME
+    - git push git@gitlab:"$CI_PROJECT_PATH".git $TAG
+    - git push git@gitlab:"$CI_PROJECT_PATH".git HEAD:$CI_COMMIT_REF_NAME
   before_script:
     - mkdir -p ~/.ssh
     - chmod 700 ~/.ssh

package/assets/build/staging/Dockerfile

@@ -0,0 +1,2 @@
+FROM httpd:2-buster
+COPY * /usr/local/apache2/htdocs/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "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.21",
+    "@vcmap/ui": "^5.0.0-rc.22",
     "vue": "~2.7.14"
   },
   "peerDependenciesMeta": {

package/src/buildStagingApp.js

@@ -7,6 +7,7 @@ import { getConfigJson, resolveMapUi } from './hostingHelpers.js';
 import { getPluginName } from './packageJsonHelpers.js';
 import buildModule, { buildMapUI, getDefaultConfig } from './build.js';
 import setupMapUi from './setupMapUi.js';
+import { getVcmConfigJs } from './pluginCliHelper.js';
 
 
 /**
@@ -44,7 +45,8 @@ export default async function buildStagingApp() {
     path.join(getContext(), 'node_modules', '@vcmap', 'ui', 'dist', 'index.html'),
     path.join(distPath, 'index.html'),
   );
-  const config = await getConfigJson();
+  const { default: vcmConfigJs } = await getVcmConfigJs();
+  const config = await getConfigJson(vcmConfigJs.mapConfig, vcmConfigJs.auth, false, vcmConfigJs.config);
   // update Entry
   const pluginConfig = config.plugins.find(p => p.name === pluginName);
   if (pluginConfig) {

package/src/create.js

@@ -211,7 +211,7 @@ async function createPluginTemplate(options, pluginPath) {
       devDeps.push('@vcsuite/eslint-config');
     }
     if (installVitest) {
-      devDeps.push('vite', 'vitest', '@vitest/coverage-c8', 'jest-canvas-mock', 'jsdom');
+      devDeps.push('vitest', '@vitest/coverage-c8', 'jest-canvas-mock', 'jsdom');
     }
     await installDeps(devDeps, DepType.DEV, pluginPath);
     logger.success('Installed dependencies');
@@ -279,6 +279,11 @@ async function createPlugin(options) {
       path.join(getDirname(), '..', 'assets', '.gitlab-ci.yml'),
       path.join(pluginPath, '.gitlab-ci.yml'),
     );
+    await fs.promises.cp(
+      path.join(getDirname(), '..', 'assets', 'build'),
+      path.join(pluginPath, 'build'),
+      { recursive: true },
+    );
   }
 
   if (options.template) {

package/src/hostingHelpers.js

@@ -10,7 +10,7 @@ import { promiseExec, getDirname } from './pluginCliHelper.js';
 
 /**
  * @typedef {Object} HostingOptions
- * @property {string} [config] - an optional fileName to use for configuring the plugin
+ * @property {string|Object} [config] - an optional configObject or fileName to use for configuring the plugin
  * @property {string} [auth] - potential auth string to download assets (index.html, config) with
  * @property {number} [port]
  * @property {boolean} [https]
@@ -71,6 +71,18 @@ export async function readConfigJson(fileName) {
   return config;
 }
 
+/**
+ * @param {string} pluginConfig
+ * @returns {Promise<Object>}
+ */
+export async function getPluginConfig(pluginConfig) {
+  const isObject = typeof pluginConfig === 'object' && pluginConfig !== null;
+  if (isObject) {
+    return pluginConfig;
+  }
+  return readConfigJson(pluginConfig);
+}
+
 const configMap = new Map();
 
 /**
@@ -117,8 +129,20 @@ export function getConfigJson(mapConfig, auth, production, configFile) {
   if (configMap.has('map.config.json')) {
     return Promise.resolve(configMap.get('map.config.json'));
   }
-  const isWebVcm = /^https?:\/\//.test(usedConfig);
+  const isObject = typeof mapConfig === 'object' && mapConfig !== null;
+  const isWebVcm = !isObject && /^https?:\/\//.test(usedConfig);
   return new Promise((resolve, reject) => {
+    async function handleConfig(data) {
+      try {
+        const configJson = JSON.parse(data);
+        configMap.set('map.config.json', configJson);
+        const pluginConfig = await getPluginConfig(configFile);
+        await reWriteConfig(configJson, pluginConfig, production);
+        resolve(configJson);
+      } catch (e) {
+        reject(e);
+      }
+    }
     function handleStream(stream) {
       let data = '';
       stream.on('data', (chunk) => {
@@ -126,18 +150,12 @@ export function getConfigJson(mapConfig, auth, production, configFile) {
       });
 
       stream.on('close', async () => {
-        try {
-          const configJson = JSON.parse(data);
-          configMap.set('map.config.json', configJson);
-          const pluginConfig = await readConfigJson(configFile);
-          await reWriteConfig(configJson, pluginConfig, production);
-          resolve(configJson);
-        } catch (e) {
-          reject(e);
-        }
+        await handleConfig(data);
       });
     }
-    if (isWebVcm) {
+    if (isObject) {
+      handleConfig(JSON.stringify(mapConfig));
+    } else if (isWebVcm) {
       httpGet(usedConfig, auth, (res) => {
         if (res.statusCode < 400) {
           handleStream(res);
@@ -213,7 +231,7 @@ export function addMapConfigRoute(app, mapConfig, auth, configFile, production)
  */
 export async function addConfigRoute(app, auth, configFileName, production) { // IDEA pass in available plugins and strip unavailable ones?
   const mapUiDir = resolveMapUi();
-  const pluginConfig = await readConfigJson(configFileName);
+  const pluginConfig = await getPluginConfig(configFileName);
 
   app.get('/config*', async (req, res) => {
     const { url } = req;

package/src/pluginCliHelper.js

@@ -24,6 +24,14 @@ export const { version, name } = JSON.parse(fs.readFileSync(path.join(getDirname
  */
 export const promiseExec = util.promisify(childProcess.exec);
 
+/**
+ * @typedef {ServeOptions} VcmConfigJs
+ * @property {Object} proxy - see https://vitejs.dev/config/server-options.html#server-proxy
+ */
+
+/**
+ * @returns {Promise<VcmConfigJs>}
+ */
 export async function getVcmConfigJs() {
   let vcmConfigJs = {};
   const vcmConfigJsPath = path.resolve(getContext(), 'vcm.config.js');

package/src/preview.js

@@ -42,7 +42,9 @@ async function getServerOptions(hostedVcm, https) {
   let proxy;
   const normalLibraries = await getLibraryPaths('normal');
   const scopedLibraries = await getLibraryPaths('@scoped/plugin');
-  const alias = {};
+  const alias = {
+    '@cesium/engine': '@vcmap-cesium/engine',
+  };
   setAliases(alias, normalLibraries);
   setAliases(alias, scopedLibraries);
 

package/src/serve.js

@@ -20,7 +20,7 @@ import { buildMapUI } from './build.js';
 
 /**
  * @typedef {HostingOptions} ServeOptions
- * @property {string} [mapConfig] - a filename or URL to a map config
+ * @property {string|Object} [mapConfig] - an optional configObject resp. fileName or URL to a map config
  */
 
 async function getProxy(protocol, port) {
@@ -91,6 +91,11 @@ export default async function serve(options) {
   const server = await createServer({
     root: getContext(),
     publicDir: false,
+    resolve: {
+      alias: {
+        '@cesium/engine': '@vcmap-cesium/engine',
+      },
+    },
     optimizeDeps: {
       exclude: [
         '@vcmap/ui',