@vcmap/plugin-cli 2.1.12 → 2.1.14

package/README.md

@@ -44,7 +44,7 @@ conflicts in the used API within a plugin. This means, that _all_ commands
 plugin cli _within the plugin itself_ using npx. When using the `create`
 command, the `@vcmap/plugin-cli` will automatically be installed as a devDependency in
 its current major version. You can then use either the scripts defined
-by the template in your package.json `npm start`, `npm run pack` etc. or `npx`
+by the template in your package.json `npm start`, `npm run bundle` etc. or `npx`
 to execute CLI commands.
 
 All commands have (optional) cli options. Run `vcmplugin --help` or `vcmplugin help [command]` for more information.

package/assets/vitest.config.js

@@ -0,0 +1,32 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { defineConfig } from 'vite';
+import commonViteConfig from '@vcmap/ui/build/commonViteConfig.js';
+
+const configTest = defineConfig({
+  ...commonViteConfig,
+  resolve: {
+    alias: {
+      vue: 'vue/dist/vue.esm.js',
+      tinyqueue: 'tinyqueue/tinyqueue.js',
+    },
+  },
+  css: {
+    preprocessorOptions: {
+      sass: {
+        additionalData: "\n@import '@vcmap/ui/src/styles/variables.scss'\n",
+      },
+    },
+  },
+  test: {
+    server: {
+      deps: {
+        inline: ['vuetify', '@vcmap/ui'],
+      },
+    },
+    environment: 'jsdom',
+    setupFiles: ['tests/setup.js'],
+    isolate: false,
+    threads: false,
+  },
+});
+export default configTest;

package/cli.js

@@ -8,12 +8,22 @@ import buildStagingApp from './src/buildStagingApp.js';
 
 program.version(version);
 
-program.command('create').defaultOptions().safeAction(create);
+program
+  .command('create')
+  .summary('create new plugin')
+  .defaultOptions()
+  .safeAction(create);
 
-program.command('pack').defaultOptions().safeAction(pack);
+program
+  .command('bundle')
+  .summary('pack tar for production')
+  .defaultOptions()
+  .alias('pack')
+  .safeAction(pack);
 
 program
   .command('preview')
+  .summary('start preview server')
   .defaultOptions()
   .defaultServeOptions()
   .option('--vcm [url]', 'URL to a virtualcityMAP application', (val) =>
@@ -23,6 +33,7 @@ program
 
 program
   .command('serve')
+  .summary('start dev server')
   .defaultOptions()
   .defaultServeOptions()
   .option(
@@ -33,6 +44,7 @@ program
 
 program
   .command('build')
+  .description('builds plugin including assets using vite')
   .defaultOptions()
   .option('--development', 'set mode to development')
   .option('--watch', 'watch file changes')
@@ -40,10 +52,14 @@ program
 
 program.command('buildStagingApp').defaultOptions().safeAction(buildStagingApp);
 
-program.command('setup-map-ui').safeAction(setupMapUi);
+program
+  .command('setup-map-ui')
+  .description('make other plugins of @vcmap/ui available in dev server')
+  .safeAction(setupMapUi);
 
 program
   .command('update')
+  .description('update to (latest) VC Map version')
   .defaultOptions()
   .option(
     '--mapVersion [semver]',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.1.12",
+  "version": "2.1.14",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -42,7 +42,7 @@
     "vue-template-compiler": "~2.7.14"
   },
   "peerDependencies": {
-    "@vcmap/ui": "^5.0.0",
+    "@vcmap/ui": "^5.0.1",
     "vue": "~2.7.14"
   },
   "peerDependenciesMeta": {
@@ -79,7 +79,7 @@
   },
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "engines": {
-    "node": "^18.12.0",
-    "npm": "^9.0.0"
+    "node": ">=18.12.0",
+    "npm": ">=9.0.0"
   }
 }

package/src/create.js

@@ -82,6 +82,7 @@ async function downloadAndExtractPluginTar(
     file: tarPath,
     cwd: pluginPath,
     strip: 4,
+    keep: true,
   };
   if (filter) {
     extractOptions.filter = (entryPath) =>
@@ -101,59 +102,19 @@ async function downloadAndExtractPluginTar(
  */
 async function copyPluginTemplate(options, pluginPath) {
   await downloadAndExtractPluginTar('@vcmap/ui', pluginPath, [
-    path.join('plugins', options.template),
+    path.posix.join('plugins', options.template), // tar x filter requires linux path
   ]);
 
-  const pluginPackageJson = JSON.parse(
-    (
-      await fs.promises.readFile(path.join(pluginPath, 'package.json'))
-    ).toString(),
-  );
-  const userPackageJson = createPackageJson(options);
-  const packageJson = { ...pluginPackageJson, ...userPackageJson };
-  if (options.repository) {
-    packageJson.repository = {
-      url: options.repository,
-    };
-  } else {
-    delete options.repository;
-  }
-
-  const writePackagePromise = fs.promises.writeFile(
-    path.join(pluginPath, 'package.json'),
-    JSON.stringify(packageJson, null, 2),
-  );
-
   const configPath = path.join(pluginPath, 'config.json');
   const configJson = fs.existsSync(configPath)
     ? JSON.parse((await fs.promises.readFile(configPath)).toString())
     : {};
   configJson.name = options.name;
 
-  const writeConfigPromise = fs.promises.writeFile(
+  await fs.promises.writeFile(
     path.join(pluginPath, 'config.json'),
     JSON.stringify(configJson, null, 2),
   );
-
-  await Promise.all([writePackagePromise, writeConfigPromise]);
-  logger.debug('created plugin template');
-
-  try {
-    await updatePeerDependencies(packageJson.peerDependencies, pluginPath);
-    logger.spin('installing dependencies... (this may take a while)');
-    if (packageJson.dependencies) {
-      const deps = Object.entries(packageJson.dependencies).map(
-        ([depName, depVersion]) => `${depName}@${depVersion}`,
-      );
-      await installDeps(deps, DepType.DEP, pluginPath);
-    }
-    await installDeps([`${name}@${version}`], DepType.DEV, pluginPath);
-    logger.success('Installed dependencies');
-  } catch (e) {
-    logger.error(e);
-    logger.failure('Failed installing dependencies');
-  }
-  logger.stopSpinner();
 }
 
 /**
@@ -188,7 +149,7 @@ async function createPluginTemplate(options, pluginPath) {
     packageJson.prettier = '@vcsuite/eslint-config/prettier.js';
   }
 
-  const writePackagePromise = fs.promises.writeFile(
+  await fs.promises.writeFile(
     path.join(pluginPath, 'package.json'),
     JSON.stringify(packageJson, null, 2),
   );
@@ -197,24 +158,25 @@ async function createPluginTemplate(options, pluginPath) {
     name: options.name,
   };
 
-  const writeConfigPromise = fs.promises.writeFile(
+  await fs.promises.writeFile(
     path.join(pluginPath, 'config.json'),
     JSON.stringify(configJson, null, 2),
   );
 
-  await fs.promises.mkdir(path.join(pluginPath, 'src'));
-  logger.debug('created src directory');
-
-  const copyIndexPromise = fs.promises.copyFile(
-    path.join(getDirname(), '..', 'assets', 'index.js'),
-    path.join(pluginPath, 'src', 'index.js'),
-  );
+  if (options.template) {
+    await copyPluginTemplate(options, pluginPath);
+  } else {
+    const srcPath = path.join(pluginPath, 'src');
+    if (!fs.existsSync(srcPath)) {
+      await fs.promises.mkdir(srcPath);
+      logger.debug('created src directory');
+    }
 
-  await Promise.all([
-    writePackagePromise,
-    writeConfigPromise,
-    copyIndexPromise,
-  ]);
+    await fs.promises.copyFile(
+      path.join(getDirname(), '..', 'assets', 'index.js'),
+      path.join(pluginPath, 'src', 'index.js'),
+    );
+  }
 
   if (installVitest) {
     logger.debug('setting up test environment');
@@ -223,6 +185,10 @@ async function createPluginTemplate(options, pluginPath) {
       path.join(pluginPath, 'tests'),
       { recursive: true },
     );
+    await fs.promises.copyFile(
+      path.join(getDirname(), '..', 'assets', 'vitest.config.js'),
+      path.join(pluginPath, 'vitest.config.js'),
+    );
   }
 
   try {
@@ -239,8 +205,9 @@ async function createPluginTemplate(options, pluginPath) {
     if (installVitest) {
       devDeps.push(
         'vitest',
-        '@vitest/coverage-c8',
+        '@vitest/coverage-v8',
         'jest-canvas-mock',
+        'resize-observer-polyfill',
         'jsdom',
       );
     }
@@ -324,11 +291,7 @@ async function createPlugin(options) {
     );
   }
 
-  if (options.template) {
-    await copyPluginTemplate(options, pluginPath);
-  } else {
-    await createPluginTemplate(options, pluginPath);
-  }
+  await createPluginTemplate(options, pluginPath);
   await setVcMapVersion(pluginPath);
   logger.success(`Created plugin ${options.name}`);
 }
@@ -350,7 +313,7 @@ export default async function create() {
 
   const scriptChoices = [
     { title: 'build', value: { build: 'vcmplugin build' }, selected: true },
-    { title: 'pack', value: { pack: 'vcmplugin pack' }, selected: true },
+    { title: 'bundle', value: { bundle: 'vcmplugin bundle' }, selected: true },
     { title: 'start', value: { start: 'vcmplugin serve' }, selected: true },
     {
       title: 'preview',
@@ -449,7 +412,7 @@ export default async function create() {
       hint: '- Space to select. Enter to submit',
     },
     {
-      type: (prev, values) => (!values.template ? 'multiselect' : null),
+      type: 'multiselect',
       name: 'peerDeps',
       message: 'Add the following peer dependencies to the package.json.',
       choices: peerDependencyChoices,