@vcmap/plugin-cli 2.0.3 → 2.0.6

package/README.md

@@ -7,9 +7,6 @@
 
 The `vcmplugin` cli helps develop and build plugins for the **VC Map**.
 
-For more information on plugin development refer to [map plugin examples](https://github.com/virtualcitySYSTEMS/map-plugin-examples),
-which provides documentations and a tutorial on plugin development.
-
 ## Features
 
 - Creating basic plugin structure
@@ -116,7 +113,6 @@ as peer dependencies if you use them in your plugin:
 - @vcmap/core
 - @vcmap/cesium
 - ol
-- @vcsuite/ui-components
 - vue
 - @vue/composition-api
 - vuetify

package/assets/helloWorld/src/helloWorld.vue

@@ -3,14 +3,14 @@
     <v-card class="pa-2 ma-2">
       <v-container>
         <v-row class="justify-center mb-4">
-          <h1>Hello World</h1>
+          <h1>{{ $t('helloWorld.helloWorld')}}</h1>
         </v-row>
         <v-row class="justify-center">
           <VcsButton
             icon="mdi-times"
             @click="closeSelf"
           >
-            Close Window
+            {{ $t('helloWorld.close')}}
           </VcsButton>
         </v-row>
       </v-container>
@@ -20,7 +20,7 @@
 
 <script>
   import { inject } from '@vue/composition-api';
-  import { VcsButton } from '@vcsuite/ui-components';
+  import { VcsButton } from '@vcmap/ui';
 
   export const windowId = 'hello_world_window_id';
 

package/assets/helloWorld/src/index.js

@@ -3,19 +3,25 @@ import { version, name } from '../package.json';
 import HelloWorld, { windowId } from './helloWorld.vue';
 
 /**
- * @param {VcsApp} app - the app from which this plugin is loaded.
- * @param {Object} config - the configuration of this plugin instance, passed in from the app.
- * @returns {VcsPlugin}
+ * @param {T} config - the configuration of this plugin instance, passed in from the app.
+ * @returns {import("@vcmap/ui/src/vcsUiApp").VcsPlugin<T>}
+ * @template {Object} T
  */
-export default function helloWorld(app, config) {
+export default function(config) {
   return {
     get name() { return name; },
     get version() { return version; },
+    /**
+     * @param {import("@vcmap/ui").VcsUiApp} vcsUiApp
+     * @returns {Promise<void>}
+     */
     initialize: async (vcsUiApp) => {
       console.log('Called before loading the rest of the current context. Passed in the containing Vcs UI App ');
-      console.log(app, config);
-      console.log(vcsUiApp);
     },
+    /**
+     * @param {import("@vcmap/ui").VcsUiApp} vcsUiApp
+     * @returns {Promise<void>}
+     */
     onVcsAppMounted: async (vcsUiApp) => {
       console.log('Called when the root UI component is mounted and managers are ready to accept components');
       vcsUiApp.windowManager.add({
@@ -28,8 +34,28 @@ export default function helloWorld(app, config) {
         },
       }, name);
     },
+    /**
+     * @returns {Promise<T>}
+     */
     toJSON: async () => {
       console.log('Called when serializing this plugin instance');
     },
+    i18n: {
+      en: {
+        helloWorld: {
+          helloWorld: 'Hello World',
+          close: 'Close',
+        },
+      },
+      de: {
+        helloWorld: {
+          helloWorld: 'Hallo Welt',
+          close: 'Schließen',
+        },
+      },
+    },
+    destroy() {
+      console.log('hook to cleanup');
+    },
   };
-}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.0.3",
+  "version": "2.0.6",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -34,14 +34,14 @@
     "prompts": "^2.4.1",
     "sass": "1.32.13",
     "semver": "^7.3.5",
-    "unplugin-vue-components": "^0.17.21",
+    "unplugin-vue-components": "^0.19.6",
     "vinyl-fs": "^3.0.3",
-    "vite": "^2.9.1",
-    "vite-plugin-vue2": "^1.7.3",
-    "vue-template-compiler": "^2.6.14"
+    "vite": "^2.9.12",
+    "vite-plugin-vue2": "^2.0.1",
+    "vue-template-compiler": "~2.6.14"
   },
   "peerDependencies": {
-    "@vcmap/ui": "^5.0.0-rc.6",
+    "@vcmap/ui": "^5.0.0-rc.9",
     "vue": "^2.6.14"
   },
   "peerDependenciesMeta": {

package/src/build.js

@@ -82,6 +82,9 @@ export default async function buildModule(options) {
         external,
         output: {
           paths: libraryPaths,
+          manualChunks() { // ensure only one chunk will be created
+            return 'index';
+          },
         },
       },
       watch: options.watch ? {

package/src/create.js

@@ -174,7 +174,6 @@ export default async function create() {
   ];
 
   const peerDependencyChoices = [
-    { title: '@vcsuite/ui-components', value: '@vcsuite/ui-components', selected: true },
     { title: '@vcmap/core', value: '@vcmap/core' },
     { title: '@vcmap/cesium', value: '@vcmap/cesium' },
     { title: 'ol', value: 'ol@~6.13.0' },

package/src/serve.js

@@ -78,7 +78,6 @@ export default async function serve(options) {
         '@vcmap/ui',
         '@vcmap/core',
         'ol',
-        '@vcsuite/ui-components',
         'proj4',
       ],
       include: [
@@ -104,6 +103,13 @@ export default async function serve(options) {
       https: options.https,
       proxy,
     },
+    css: {
+      preprocessorOptions: {
+        sass: {
+          additionalData: "\n@import './node_modules/@vcmap/ui/src/styles/variables.scss'\n",
+        },
+      },
+    },
   });
 
   addMapConfigRoute(app, options.mapConfig, options.auth, options.config);