@vcmap/plugin-cli 4.0.1 → 4.1.0

package/README.md

@@ -2,12 +2,42 @@
 
 > Part of the [VC Map Project](https://github.com/virtualcitySYSTEMS/map-ui)
 
-> Note: This documentation is for version @vcmap/ui 6.0.0, compatible with the [VC Map](https://github.com/virtualcitySYSTEMS/map-ui).
+> Note: This documentation is for version @vcmap/ui 6, compatible with the [VC Map](https://github.com/virtualcitySYSTEMS/map-ui).
 >
-> [Migration Guide](https://github.com/virtualcitySYSTEMS/map-ui/blob/release-v6.0/MIGRATION_V6.md) for Plugins from @vcmap/ui 5.0.0
+> [Migration Guide](https://github.com/virtualcitySYSTEMS/map-ui/blob/release-v6.0/MIGRATION_V6.md) for Plugins from @vcmap/ui 5
 
 The `@vcmap/plugin-cli` helps develop and build plugins for the **VC Map**.
 
+### Migration to Eslint9
+
+If you are updating a plugin, you should also update to the new eslint config. To
+do so, remove the eslint config and any eslint plugins (or even eslint itself) from
+the devDependencies, then add the eslint config again:
+
+```bash
+npm uninstall @vcsuite/eslint-config eslint
+npm i -D @vcsuite/eslint-config
+```
+
+You should then create a `eslint.config.js` in the root of your project.
+You should then extend the `vue` or `vueTs` config, depending on
+your project using typescript or not. You can then remove any .eslintrc files still left in your
+project, plus the eslintConfig and eslintIgnore from your package.json.
+
+```bash
+echo "import { configs } from '@vcsuite/eslint-config';" > eslint.config.js
+echo "" >> eslint.config.js
+echo "export default [" >> eslint.config.js
+echo "  ...configs.vueTs," >> eslint.config.js
+echo "  { ignores: ['node_modules/', 'dist/'] }," >> eslint.config.js
+echo "];" >> eslint.config.js
+echo "" >> eslint.config.js
+```
+
+You can then remove any .eslintrc(.js) (including the one in the tests directory) files and any eslint config from your package.json.
+To fix issues in the default vcs interface spec & setup, you can copy paste the template from [this projects assets folder](https://github.com/virtualcitySYSTEMS/map-plugin-cli/tree/main/assets/).
+Be sure to copy the typescript or vanilla folder, depending on your project.
+
 ## Features
 
 - Creating basic plugin structure
@@ -189,19 +219,6 @@ This can be helpful, if you want to share specific parameters valid for a specif
 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.
 
-Example `vcm.config.js` defining proxy and port:
-
-```js
-export default {
-  // server.proxy see https://vitejs.dev/config/server-options.html#server-proxy
-  proxy: {
-    // string shorthand: http://localhost:8008/foo -> https://vc.systems/foo
-    '/foo': 'https://vc.systems',
-  },
-  port: 5005,
-};
-```
-
 The following parameters are valid:
 
 | parameter | type               | description                                                                                                               |
@@ -213,9 +230,73 @@ The following parameters are valid:
 | vcm       | string             | A filename or URL to a VC Map application. Only works for `preview` command! Takes precedence over `appConfig` parameter. |
 | proxy     | Object             | A server proxy (see [vitejs.dev](https://vitejs.dev/config/server-options.html#server-proxy))                             |
 
-> The `vcm` parameter uses a hosted map application to preview the plugin. The plugin is bundled and added to the application. This parameter is only working for `preview` mode.
+Examples:
+
+- defining modules:
+  > For the `appConfig` option, map and plugin are bundled to create a preview environment.
+  > You can provide modules from absolute or relative URLs or inline configurations.
+  > This parameter is working for both `preview` and `serve` mode.
+
+```js
+export default {
+  appConfig: {
+    modules: [
+      "https://www.virtualcitymap.de/config/www.config.json",
+      "./node_modules/@vcmap/ui/config/dev.config.json",
+      {
+        "name": "myCustomConfig",
+        "startingViewpointName": "start",
+        "viewpoints": [
+          {
+            "type": "Viewpoint",
+            "name": "start",
+            "groundPosition": [...],
+            "distance": 100
+          }
+        ],
+        "layers": [
+          {
+            "name": "geojsonClassification",
+            "type": "GeoJSONLayer",
+            "features": [
+              {
+                "type": "Feature",
+                "geometry": {
+                  "type": "Polygon",
+                  "coordinates": [...]
+                },
+              }
+            ],
+            "activeOnStartup": true,
+          },
+        ]
+      }
+    ]
+  }
+}
+```
+
+- referencing a hosted application
+  > The `vcm` parameter uses a hosted map application to preview the plugin. The plugin is bundled and added to the application. This parameter is only working for `preview` mode.
 
-> For the `appConfig` option, map and plugin are bundled to create a preview environment. Here only the configuration is loaded from the provided url or object. This parameter is working for both `preview` and `serve` mode.
+```js
+export default {
+  vcm: 'https://www.virtualcitymap.de/app.config.json',
+};
+```
+
+- defining proxy and port:
+
+```js
+export default {
+  // server.proxy see https://vitejs.dev/config/server-options.html#server-proxy
+  proxy: {
+    // string shorthand: http://localhost:8008/foo -> https://vc.systems/foo
+    '/foo': 'https://vc.systems',
+  },
+  port: 5005,
+};
+```
 
 ## About Peer Dependencies
 
@@ -426,12 +507,25 @@ If a plugin does not provide a config editor, the JsonEditor is always used as f
 To provide a custom editor, the plugin has to implement a `getConfigEditors` method returning one or more editors.
 A plugin config editor definition consists of
 
-- component: The vue component providing the ui of the editor. This vue component has to extend the `AbstractConfigEditor.vue`, which can be imported from `@vcmap/ui`. The component has to provide two props: `getConfig` for getting the serialized configuration and `setConfig` to update the changed configuration.
+- component: The vue component providing the ui of the editor. This vue component has to extend the `AbstractConfigEditor.vue`, which can be imported from `@vcmap/ui`.
+  The component has to provide two props:
+  - `getConfig` for getting the serialized configuration and
+  - `setConfig` to update the changed configuration (do not pass proxies or anything by reference to setConfig! See note below for more information)
 - title: An optional title displayed in the window header of the editor and on action buttons (e.g. tooltip)
 - collectionName: The collection the item belongs to. Default is `plugins` collection. For a layer config editor you would provide `layers`.
 - itemName: The item the editor can be used for. Can be a name or className. Default is the plugin's name. For a layer you would provide `MyNewLayer.className`.
 - infoUrlCallback: An optional function returning an url referencing help or further information regarding the config editor.
 
+> IMPORTANT NOTE:
+>
+> Make sure you do not pass proxy elements or internals by reference to `setConfig`!
+>
+> - proxies can be removed by using vue's `toRaw` function
+> - `toRaw` is not deep, therefor nested proxy elements like arrays have to be manually removed, e.g. by iterating over the array and calling `toRaw` on each array item
+> - everything passed by reference has to be deeply cloned, e.g. using `structuredClone`
+>
+> Best practice: Use `setConfig(structuredClone(...))` because it will throw, if you pass a proxy
+
 An example of plugin config editor can look like this:
 
 ```vue
@@ -462,7 +556,7 @@ An example of plugin config editor can look like this:
     VcsLabel,
     VcsTextField,
   } from '@vcmap/ui';
-  import { ref } from 'vue';
+  import { ref, toRaw } from 'vue';
   import { getDefaultOptions } from '../defaultOptions.js';
 
   export default {
@@ -492,7 +586,8 @@ An example of plugin config editor can look like this:
       const localConfig = ref({ ...defaultOptions, ...config });
 
       const apply = () => {
-        props.setConfig(localConfig.value);
+        // Do not pass proxy elements or internals by reference! See note above example for more information
+        props.setConfig(structuredClone(toRaw(localConfig.value)));
       };
 
       return {

package/assets/.gitlab-ci.yml

@@ -9,6 +9,7 @@ stages:
   - test
   - bundle
   - deploy
+  - prepublish
   - version
   - publish
   - deployCluster
@@ -104,7 +105,7 @@ deployStaging:
     name: gcr.io/kaniko-project/executor:debug
     entrypoint: ['']
   script:
-    - /kaniko/executor --context dist/ --dockerfile build/staging/Dockerfile --destination $CI_REGISTRY_IMAGE/staging:$CI_COMMIT_REF_SLUG
+    - /kaniko/executor --context dist/ --dockerfile node_modules/@vcmap/plugin-cli/assets/build/staging/Dockerfile --destination $CI_REGISTRY_IMAGE/staging:$CI_COMMIT_REF_SLUG
   before_script:
     - mkdir -p /kaniko/.docker
     - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json
@@ -144,6 +145,24 @@ deployStagingCluster:
     project: vcsuite/devops/manifests
     branch: main
 
+sshDependenciesCheck:
+  <<: *after_build_definition
+  stage: prepublish
+  only:
+    variables:
+      - $PUBLISH
+    refs:
+      - /^(main|release-v.*)$/
+  script:
+    - echo "Checking for SSH dependencies in package.json..."
+    - |
+      if grep -E "git(\+ssh)?://git@gitlab|ssh://git@gitlab:|gitlab:" package.json; then
+        echo "Error: SSH link dependencies found in package.json."
+        exit 1
+      else
+        echo "No SSH link dependencies found."
+      fi
+
 version:
   <<: *after_build_definition
   stage: version

package/assets/build/staging/Dockerfile

@@ -1,2 +1,9 @@
 FROM httpd:2-buster
-COPY * /usr/local/apache2/htdocs/
+COPY . /usr/local/apache2/htdocs/
+# allow for proxy
+RUN sed -i '/LoadModule rewrite_module/s/^#//g' /usr/local/apache2/conf/httpd.conf && \
+    sed -i '/LoadModule proxy_module/s/^#//g' /usr/local/apache2/conf/httpd.conf && \
+    sed -i '/LoadModule proxy_http_module/s/^#//g' /usr/local/apache2/conf/httpd.conf && \
+    sed -i '/LoadModule ssl_module/s/^#//g' /usr/local/apache2/conf/httpd.conf && \
+    sed -i 's#AllowOverride [Nn]one#AllowOverride All#' /usr/local/apache2/conf/httpd.conf && \
+    echo "SSLProxyEngine On" | tee -a /usr/local/apache2/conf/httpd.conf

package/assets/eslintConfig.js

@@ -0,0 +1,8 @@
+import { configs } from '@vcsuite/eslint-config';
+
+export default [
+  ...configs.vue,
+  {
+    ignores: ['node_modules/', 'dist/'],
+  },
+];

package/assets/eslintConfigTs.js

@@ -0,0 +1,8 @@
+import { configs } from '@vcsuite/eslint-config';
+
+export default [
+  ...configs.vueTs,
+  {
+    ignores: ['node_modules/', 'dist/'],
+  },
+];

package/assets/index.ts

@@ -1,4 +1,4 @@
-import { VcsPlugin, VcsUiApp, PluginConfigEditor } from '@vcmap/ui';
+import type { VcsPlugin, VcsUiApp, PluginConfigEditor } from '@vcmap/ui';
 import { name, version, mapVersion } from '../package.json';
 
 type PluginConfig = Record<never, never>;
@@ -67,7 +67,7 @@ export default function plugin(
     /**
      * components for configuring the plugin and/ or custom items defined by the plugin
      */
-    getConfigEditors(): PluginConfigEditor[] {
+    getConfigEditors(): PluginConfigEditor<object>[] {
       return [];
     },
     destroy(): void {

package/assets/tests/setup.js

@@ -1,4 +1,4 @@
-/* eslint-disable import/no-extraneous-dependencies, import/first */
+/* eslint-disable import/first */
 import { vi } from 'vitest';
 
 vi.hoisted(() => {

package/assets/tests/vcsPluginInterface.spec.js

@@ -9,8 +9,8 @@ function sleep(ms = 0) {
   });
 }
 
-window.VcsPluginLoaderFunction = (name, module) => ({
-  default: () => plugin({ name }, module),
+window.VcsPluginLoaderFunction = () => ({
+  default: (config, baseUrl) => plugin(config, baseUrl),
 });
 
 const testPropSymbol = Symbol('testProp');
@@ -34,9 +34,11 @@ describe('VcsPlugin Interface test', () => {
       expect(pluginInstance).to.have.property('name', packageJSON.name);
       expect(isValidPackageName(pluginInstance.name)).to.be.true;
     });
+
     it('should return the plugin version from the package.json', () => {
       expect(pluginInstance).to.have.property('version', packageJSON.version);
     });
+
     it('should return the plugin mapVersion from the package.json', () => {
       expect(pluginInstance).to.have.property(
         'mapVersion',
@@ -51,6 +53,7 @@ describe('VcsPlugin Interface test', () => {
         expect(pluginInstance?.i18n).to.be.a('object').with.property('en');
       }
     });
+
     it('should use unscoped, camel-case plugin name as namespace for plugin specific i18n entries', () => {
       if (pluginInstance?.i18n) {
         expect(pluginInstance.i18n).to.be.a('object');
@@ -74,12 +77,14 @@ describe('VcsPlugin Interface test', () => {
           .throw;
       }
     });
+
     it('may implement onVcsAppMounted', () => {
       if (pluginInstance?.onVcsAppMounted) {
         expect(pluginInstance.onVcsAppMounted).to.be.a('function');
         expect(pluginInstance.onVcsAppMounted(new VcsUiApp())).to.not.throw;
       }
     });
+
     it('should implement destroy', () => {
       if (pluginInstance?.destroy) {
         expect(pluginInstance.destroy).to.be.a('function');
@@ -93,6 +98,7 @@ describe('VcsPlugin Interface test', () => {
         expect(pluginInstance.getDefaultOptions()).to.be.a('object');
       }
     });
+
     it('may implement toJSON returning the plugin config', () => {
       if (pluginInstance?.toJSON) {
         expect(pluginInstance.toJSON()).to.be.a('object');

package/assets/testsTypescript/setup.js

@@ -0,0 +1,15 @@
+/* global global */
+/* eslint-disable import/first */
+import { vi } from 'vitest';
+
+vi.hoisted(() => {
+  global.jest = vi;
+});
+
+import ResizeObserver from 'resize-observer-polyfill';
+
+global.ResizeObserver = ResizeObserver;
+
+import 'jest-canvas-mock';
+
+window.CESIUM_BASE_URL = '/node_modules/@vcmap-cesium/engine/Build/';

package/assets/testsTypescript/vcsPluginInterface.spec.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect, beforeAll, afterAll } from 'vitest';
-import { VcsUiApp, loadPlugin, isValidPackageName, VcsPlugin } from '@vcmap/ui';
+import type { VcsPlugin } from '@vcmap/ui';
+import { VcsUiApp, loadPlugin, isValidPackageName } from '@vcmap/ui';
 import plugin from '../src/index.js';
 import packageJSON from '../package.json';
 
@@ -12,14 +13,11 @@ function sleep(ms = 0): Promise<void> {
 type TestPluginInstance = VcsPlugin<object, object>;
 
 // @ts-expect-error: not defined on global
-window.VcsPluginLoaderFunction = (
-  name: string,
-  module: string,
-): {
-  default: () => TestPluginInstance;
+window.VcsPluginLoaderFunction = (): {
+  default: (config: object, module: string) => TestPluginInstance;
 } => ({
   // @ts-expect-error: interface may not use this
-  default: () => plugin({ name }, module),
+  default: (config, baseUrl) => plugin(config, baseUrl),
 });
 
 const testPropSymbol = Symbol('testProp');
@@ -43,9 +41,11 @@ describe('VcsPlugin Interface test', () => {
       expect(pluginInstance).to.have.property('name', packageJSON.name);
       expect(isValidPackageName(pluginInstance.name)).to.be.true;
     });
+
     it('should return the plugin version from the package.json', () => {
       expect(pluginInstance).to.have.property('version', packageJSON.version);
     });
+
     it('should return the plugin mapVersion from the package.json', () => {
       expect(pluginInstance).to.have.property(
         'mapVersion',
@@ -57,11 +57,10 @@ describe('VcsPlugin Interface test', () => {
   describe('internationalization', () => {
     it('may provide an i18n object and should provide at least en as fallback language', () => {
       if (pluginInstance?.i18n) {
-        expect(pluginInstance?.i18n)
-          .to.be.a('object')
-          .with.property('en');
+        expect(pluginInstance?.i18n).to.be.a('object').with.property('en');
       }
     });
+
     it('should use unscoped, camel-case plugin name as namespace for plugin specific i18n entries', () => {
       if (pluginInstance?.i18n) {
         expect(pluginInstance.i18n).to.be.a('object');
@@ -85,12 +84,16 @@ describe('VcsPlugin Interface test', () => {
           .throw;
       }
     });
+
     it('may implement onVcsAppMounted', () => {
       if (pluginInstance?.onVcsAppMounted) {
         expect(pluginInstance.onVcsAppMounted).to.be.a('function');
-        expect(pluginInstance.onVcsAppMounted(new VcsUiApp())).to.not.throw;
+        expect(() => {
+          pluginInstance.onVcsAppMounted(new VcsUiApp());
+        }).to.not.throw;
       }
     });
+
     it('should implement destroy', () => {
       if (pluginInstance?.destroy) {
         expect(pluginInstance.destroy).to.be.a('function');
@@ -104,6 +107,7 @@ describe('VcsPlugin Interface test', () => {
         expect(pluginInstance.getDefaultOptions()).to.be.a('object');
       }
     });
+
     it('may implement toJSON returning the plugin config', () => {
       if (pluginInstance?.toJSON) {
         expect(pluginInstance.toJSON()).to.be.a('object');
@@ -145,7 +149,9 @@ describe('VcsPlugin Interface test', () => {
     });
 
     it('should reincarnate the plugin correctly', async () => {
-      expect(() => app.plugins.remove(pluginInstance2!)).to.not.throw;
+      expect(() => {
+        app.plugins.remove(pluginInstance2!);
+      }).to.not.throw;
       app.plugins.remove(pluginInstance2!);
       await sleep(0);
       expect(app.plugins.getByKey(packageJSON.name)).not.to.have.property(

package/assets/ts.gitlab-ci.yml

@@ -9,6 +9,7 @@ stages:
   - test
   - bundle
   - deploy
+  - prepublish
   - version
   - publish
   - deployCluster
@@ -102,7 +103,7 @@ deployStaging:
     name: gcr.io/kaniko-project/executor:debug
     entrypoint: ['']
   script:
-    - /kaniko/executor --context dist/ --dockerfile build/staging/Dockerfile --destination $CI_REGISTRY_IMAGE/staging:$CI_COMMIT_REF_SLUG
+    - /kaniko/executor --context dist/ --dockerfile node_modules/@vcmap/plugin-cli/assets/build/staging/Dockerfile --destination $CI_REGISTRY_IMAGE/staging:$CI_COMMIT_REF_SLUG
   before_script:
     - mkdir -p /kaniko/.docker
     - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json
@@ -142,6 +143,24 @@ deployStagingCluster:
     project: vcsuite/devops/manifests
     branch: main
 
+sshDependenciesCheck:
+  <<: *after_build_definition
+  stage: prepublish
+  only:
+    variables:
+      - $PUBLISH
+    refs:
+      - /^(main|release-v.*)$/
+  script:
+    - echo "Checking for SSH dependencies in package.json..."
+    - |
+      if grep -E "git(\+ssh)?://git@gitlab|ssh://git@gitlab:|gitlab:" package.json; then
+        echo "Error: SSH link dependencies found in package.json."
+        exit 1
+      else
+        echo "No SSH link dependencies found."
+      fi
+
 version:
   <<: *after_build_definition
   stage: version

package/assets/vitest.config.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
 import { defineConfig } from 'vite';
 import commonViteConfig from '@vcmap/ui/build/commonViteConfig.js';
 

package/cli.js

@@ -14,6 +14,7 @@ program
   .summary('create new plugin')
   .defaultOptions()
   .option('-t --typescript', 'Create a plugin using typescript')
+  .option('-d --default <name>', 'use defaults')
   .safeAction(create);
 
 program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -45,6 +45,9 @@
     "@vcmap/ui": "^6.0.0",
     "vue": "~3.4.38"
   },
+  "overrides": {
+    "esbuild": "^0.25.0"
+  },
   "peerDependenciesMeta": {
     "@vcmap/ui": {
       "optional": true
@@ -54,34 +57,11 @@
     }
   },
   "devDependencies": {
-    "@vcsuite/eslint-config": "^3.0.7",
-    "eslint": "^8.38.0"
-  },
-  "eslintIgnore": [
-    "node_modules",
-    "assets/tests",
-    "assets/testsTypescript",
-    "assets/index.ts"
-  ],
-  "eslintConfig": {
-    "extends": "@vcsuite/eslint-config/node",
-    "parserOptions": {
-      "ecmaVersion": 2020
-    },
-    "rules": {
-      "import/no-unresolved": [
-        2,
-        {
-          "ignore": [
-            "^@vcmap/ui"
-          ]
-        }
-      ]
-    }
+    "@vcsuite/eslint-config": "^4.0.0"
   },
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "engines": {
-    "node": ">=18.12.0 || >= 20.0.0",
-    "npm": ">=9.0.0 || 10.0.0"
+    "node": ">= 20.0.0",
+    "npm": ">=10.0.0"
   }
 }

package/src/buildStagingApp.js

@@ -9,6 +9,38 @@ import buildModule, { buildMapUI, getDefaultConfig } from './build.js';
 import setupMapUi from './setupMapUi.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
 
+/**
+ * @param {VcmConfigJs} config
+ * @returns {string | undefined}
+ */
+function getHtaccess(config) {
+  let htaccess;
+  if (config.htaccess) {
+    ({ htaccess } = config);
+  } else if (config.proxy) {
+    const htaccessLines = Object.keys(config.proxy).map((key) => {
+      const value = config.proxy[key];
+      let target;
+      if (typeof value === 'string') {
+        target = value;
+      } else {
+        ({ target } = value);
+        console.log(
+          `proxy settings for ${key} may be more complex, simply using rewrite to target: ${target}`,
+        );
+      }
+      return `RewriteRule ^${key.replace(/^\^/, '')}(.*) ${target}$1 [P,L]`;
+    });
+
+    if (htaccessLines.length > 0) {
+      htaccessLines.unshift('RewriteEngine On');
+      htaccess = htaccessLines.join('\n');
+    }
+  }
+
+  return htaccess;
+}
+
 /**
  * creates production preview application in the dist folder based on the @vcmap/ui default configuration.
  * @returns {Promise<void>}
@@ -70,6 +102,12 @@ export default async function buildStagingApp() {
   if (pluginConfig) {
     pluginConfig.entry = `plugins/${pluginName}/index.js`;
   }
+  const htaccess = getHtaccess(vcmConfigJs);
+  if (htaccess) {
+    await writeFile(path.join(distPath, '.htaccess'), htaccess);
+    logger.log('built .htaccess');
+  }
+
   await writeFile(
     path.join(distPath, 'app.config.json'),
     JSON.stringify(appConfig, null, 2),

package/src/create.js

@@ -19,12 +19,12 @@ import {
  * @typedef {Object} PluginTemplateOptions
  * @property {string} name
  * @property {string} version
- * @property {string} description
+ * @property {string} [description]
  * @property {Array<Object>} scripts
- * @property {string} author
- * @property {string} repository
+ * @property {string} [author]
+ * @property {string} [repository]
  * @property {string} license
- * @property {string} template
+ * @property {string} [template]
  * @property {Array<string>} peerDeps
  * @property {boolean} gitlabCi
  * @property {boolean} typescript
@@ -160,14 +160,14 @@ async function createPluginTemplate(options, pluginPath) {
   if (installEsLint) {
     packageJson.eslintIgnore = ['node_modules', 'dist', 'plugin-assets'];
     if (!options.typescript) {
-      packageJson.eslintConfig = {
-        root: true,
-        extends: '@vcsuite/eslint-config/vue',
-      };
+      await fs.promises.copyFile(
+        path.join(getDirname(), '..', 'assets', 'eslintConfig.js'),
+        path.join(pluginPath, 'eslint.config.js'),
+      );
     } else {
       await fs.promises.copyFile(
-        path.join(getDirname(), '..', 'assets', 'eslintrc.cjs'),
-        path.join(pluginPath, '.eslintrc.cjs'),
+        path.join(getDirname(), '..', 'assets', 'eslintConfigTs.js'),
+        path.join(pluginPath, 'eslint.config.js'),
       );
     }
     packageJson.prettier = '@vcsuite/eslint-config/prettier.js';
@@ -178,13 +178,12 @@ async function createPluginTemplate(options, pluginPath) {
     JSON.stringify(packageJson, null, 2),
   );
 
-  const configJson = {
-    name: options.name,
-  };
-
   await fs.promises.writeFile(
     path.join(pluginPath, 'config.json'),
-    JSON.stringify(configJson, null, 2),
+    `{
+  "name": "${options.name}"
+}
+`,
   );
 
   if (options.template) {
@@ -205,25 +204,14 @@ async function createPluginTemplate(options, pluginPath) {
 
   if (installVitest) {
     logger.debug('setting up test environment');
-    await fs.promises.cp(
-      path.join(getDirname(), '..', 'assets', 'tests'),
-      path.join(pluginPath, 'tests'),
-      { recursive: true },
-    );
-    if (options.typescript) {
-      await fs.promises.rm(
-        path.join(pluginPath, 'tests', 'vcsPluginInterface.spec.js'),
-      );
-      await fs.promises.cp(
-        path.join(getDirname(), '..', 'assets', 'testsTypescript'),
-        path.join(pluginPath, 'tests'),
-        { recursive: true },
-      );
-      await fs.promises.copyFile(
-        path.join(getDirname(), '..', 'assets', 'eslintrcTests.cjs'),
-        path.join(pluginPath, '.eslintrc.cjs'),
-      );
-    }
+    const testSrcPath = options.typescript
+      ? path.join(getDirname(), '..', 'assets', 'testsTypescript')
+      : path.join(getDirname(), '..', 'assets', 'tests');
+
+    await fs.promises.cp(testSrcPath, path.join(pluginPath, 'tests'), {
+      recursive: true,
+    });
+
     await fs.promises.copyFile(
       path.join(getDirname(), '..', 'assets', 'vitest.config.js'),
       path.join(pluginPath, 'vitest.config.js'),
@@ -291,14 +279,14 @@ async function createPluginTemplate(options, pluginPath) {
 async function createPlugin(options) {
   if (!options.name) {
     logger.error('please provide a plugin name as input parameter');
-    process.exit(1);
+    throw new Error('no plugin name provided');
   }
   logger.debug(`creating new plugin: ${options.name}`);
 
   const pluginPath = path.join(process.cwd(), options.name);
   if (fs.existsSync(pluginPath)) {
     logger.error('plugin with the provided name already exists');
-    process.exit(1);
+    throw new Error('path already exists');
   }
 
   await fs.promises.mkdir(pluginPath);
@@ -314,14 +302,17 @@ async function createPlugin(options) {
     path.join(pluginPath, 'README.md'),
     [
       `# ${options.name}`,
+      '',
       '> Part of the [VC Map Project](https://github.com/virtualcitySYSTEMS/map-ui)',
+      '',
       'describe your plugin',
+      '',
     ].join('\n'),
   );
 
   const writeChangesPromise = fs.promises.writeFile(
     path.join(pluginPath, 'CHANGELOG.md'),
-    `# v${options.version}\nDocument features and fixes`,
+    `# v${options.version}\n\nDocument features and fixes\n`,
   );
 
   const copyGitIgnorePromise = fs.promises.copyFile(
@@ -351,11 +342,6 @@ async function createPlugin(options) {
       path.join(getDirname(), '..', 'assets', gitlabFile),
       path.join(pluginPath, '.gitlab-ci.yml'),
     );
-    await fs.promises.cp(
-      path.join(getDirname(), '..', 'assets', 'build'),
-      path.join(pluginPath, 'build'),
-      { recursive: true },
-    );
   }
 
   if (options.typescript) {
@@ -364,8 +350,8 @@ async function createPlugin(options) {
       path.join(pluginPath, 'tsconfig.json'),
     );
     await fs.promises.copyFile(
-      path.join(getDirname(), '..', 'assets', 'eslintrc.cjs'),
-      path.join(pluginPath, '.eslintrc.cjs'),
+      path.join(getDirname(), '..', 'assets', 'eslintConfigTs.js'),
+      path.join(pluginPath, 'eslint.config.js'),
     );
   }
 
@@ -375,9 +361,10 @@ async function createPlugin(options) {
 }
 
 /**
+ * @param {{ default?: string }} cliOptions
  * @returns {Promise<void>}
  */
-export default async function create() {
+export default async function create(cliOptions) {
   const templateChoices = [
     { title: 'no template (basic structure)', value: null },
     { title: 'hello-world', value: '@vcmap-show-case/hello-world' },
@@ -521,15 +508,29 @@ export default async function create() {
     },
   ];
 
-  const answers = await prompts(questions, {
-    onCancel() {
-      process.exit(0);
-    },
-  });
+  if (cliOptions.default) {
+    logger.info(`creating default plugin ${cliOptions.default}`);
+    await createPlugin({
+      name: cliOptions.default,
+      version: '1.0.0',
+      scripts: scriptChoices.filter((s) => s.selected).map((s) => s.value),
+      license: LicenseType.MIT,
+      peerDeps: [],
+      gitlabCi: true,
+      typescript: true,
+    });
+  } else {
+    const answers = await prompts(questions, {
+      onCancel() {
+        // eslint-disable-next-line n/no-process-exit
+        process.exit(0);
+      },
+    });
 
-  if (answers.template && answers.typescript) {
-    answers.typescript = !!answers.keepTs;
-  }
+    if (answers.template && answers.typescript) {
+      answers.typescript = !!answers.keepTs;
+    }
 
-  await createPlugin(answers);
+    await createPlugin(answers);
+  }
 }

package/src/defaultCommand.js

@@ -48,6 +48,7 @@ Command.prototype.safeAction = function safeAction(action) {
         logger.error(e);
       }
       logger.stopSpinner();
+      // eslint-disable-next-line n/no-process-exit
       process.exit(1);
     }
   });

package/src/hostingHelpers.js

@@ -244,12 +244,18 @@ export function addAppConfigRoute(
   production,
 ) {
   app.get('/app.config.json', (req, res) => {
-    getAppConfigJson(appConfig, auth, production, configFile).then((config) => {
-      const stringConfig = JSON.stringify(config, null, 2);
-      res.setHeader('Content-Type', 'application/json');
-      res.write(stringConfig);
-      res.end();
-    });
+    getAppConfigJson(appConfig, auth, production, configFile)
+      .then((config) => {
+        const stringConfig = JSON.stringify(config, null, 2);
+        res.setHeader('Content-Type', 'application/json');
+        res.write(stringConfig);
+        res.end();
+      })
+      .catch((e) => {
+        logger.error(e);
+        res.statusCode = 500;
+        res.end();
+      });
   });
 }
 

package/src/licenses.js

@@ -7,19 +7,18 @@ import path from 'path';
  * @returns {string}
  */
 function mit(user, year) {
-  return `
-Copyright ${year} ${user}
+  return `Copyright ${year} ${user}
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
-THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 
-OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 `;
 }
@@ -30,8 +29,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR TH
  * @returns {string}
  */
 function apache(user, year) {
-  return `
-Copyright ${year} ${user}
+  return `Copyright ${year} ${user}
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -53,8 +51,7 @@ limitations under the License.
  * @returns {string}
  */
 function gpl3(user, year) {
-  return `
-Copyright (C) ${year} ${user}
+  return `Copyright (C) ${year} ${user}
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -77,8 +74,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  * @returns {string}
  */
 function isc(user, year) {
-  return `
-Copyright (c) ${year}, ${user}
+  return `Copyright (c) ${year}, ${user}
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/src/pack.js

@@ -80,12 +80,12 @@ async function zip(name) {
   const read = fs.createReadStream(fileName);
   const write = fs.createWriteStream(`${fileName}.gz`);
 
-  await new Promise((res, rej) => {
+  await new Promise((resolve, reject) => {
     pipeline([read, createGzip(), write], (err) => {
       if (err) {
-        rej(err);
+        reject(err);
       } else {
-        res();
+        resolve();
       }
     });
   });

package/src/pluginCliHelper.js

@@ -28,7 +28,8 @@ export const promiseExec = util.promisify(childProcess.exec);
 
 /**
  * @typedef {PreviewOptions} VcmConfigJs
- * @property {Object} proxy - see https://vitejs.dev/config/server-options.html#server-proxy
+ * @property {Object} [proxy] - see https://vitejs.dev/config/server-options.html#server-proxy. when building a staging app, we try to deduce an .htaccess from it.
+ * @property {string} [htaccess] - a string representing an .htaccess file content for use in staging apps.
  */
 
 /**

package/assets/eslintrc.cjs

@@ -1,25 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-// const sharedLib = require('eslint-config-airbnb-typescript/lib/shared.js');
-
-module.exports = {
-  root: true,
-  extends: ['@vcsuite/eslint-config/vue-ts'],
-  env: {
-    node: true,
-  },
-  rules: {
-    'no-restricted-syntax': 'off',
-  },
-  overrides: [
-    {
-      files: ['*.ts', '*.vue'],
-      parserOptions: {
-        project: ['./tsconfig.json'],
-      },
-      rules: {
-        '@typescript-eslint/no-non-null-assertion': 'off',
-      },
-    },
-  ],
-  ignorePatterns: ['dist/', 'node_modules/'],
-};

package/assets/eslintrcTests.cjs

@@ -1,25 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-// const sharedLib = require('eslint-config-airbnb-typescript/lib/shared.js');
-
-module.exports = {
-  root: true,
-  extends: ['@vcsuite/eslint-config/vue-ts'],
-  env: {
-    node: true,
-  },
-  rules: {
-    'no-restricted-syntax': 'off',
-  },
-  overrides: [
-    {
-      files: ['*.ts', '*.vue'],
-      parserOptions: {
-        project: ['./tsconfig.json', './tests/tsconfig.json'],
-      },
-      rules: {
-        '@typescript-eslint/no-non-null-assertion': 'off',
-      },
-    },
-  ],
-  ignorePatterns: ['dist/', 'node_modules/'],
-};

package/assets/tests/.eslintrc

@@ -1,6 +0,0 @@
-{
-  "extends": ["@vcsuite/eslint-config/mocha"],
-  "rules": {
-    "import/extensions": ["error", "always"]
-  }
-}