@vcmap/plugin-cli 2.1.5 → 2.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.1.5",
+  "version": "2.1.6",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",
@@ -8,7 +8,10 @@
     "vcmplugin": "cli.js"
   },
   "scripts": {
-    "lint": "eslint . --env node",
+    "lint:js": "eslint . --ext .vue,.js,.cjs,.mjs,.ts,.cts,.mts",
+    "lint:prettier": "prettier --check .",
+    "lint": "npm run lint:js && npm run lint:prettier",
+    "format": "prettier --write --list-different . && npm run lint:js -- --fix",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -40,7 +43,7 @@
     "vue-template-compiler": "~2.7.14"
   },
   "peerDependencies": {
-    "@vcmap/ui": "^5.0.0-rc.22",
+    "@vcmap/ui": "^5.0.0-rc.23",
     "vue": "~2.7.14"
   },
   "peerDependenciesMeta": {
@@ -52,8 +55,8 @@
     }
   },
   "devDependencies": {
-    "@vcsuite/eslint-config": "^2.1.1",
-    "eslint": "^8.9.0"
+    "@vcsuite/eslint-config": "^3.0.3",
+    "eslint": "^8.38.0"
   },
   "eslintIgnore": [
     "node_modules"
@@ -74,6 +77,7 @@
       ]
     }
   },
+  "prettier": "@vcsuite/eslint-config/prettier.js",
   "engines": {
     "node": "^16.14.0",
     "npm": "^8.3.0"

package/src/build.js

@@ -19,10 +19,7 @@ import { executeUiNpm, resolveMapUi } from './hostingHelpers.js';
 export function getDefaultConfig() {
   return {
     publicDir: false,
-    plugins: [
-      createVuePlugin(),
-      vcsOl(),
-    ],
+    plugins: [createVuePlugin(), vcsOl()],
   };
 }
 
@@ -50,7 +47,9 @@ export default async function buildModule(options) {
   const entry = await getPluginEntry();
   if (path.relative('src', entry).startsWith('.')) {
     logger.warning(`detected irregular entry ${entry}`);
-    logger.warning('vuetify component resolution expects source files to be within "src"');
+    logger.warning(
+      'vuetify component resolution expects source files to be within "src"',
+    );
   }
 
   const pluginName = await getPluginName();
@@ -78,14 +77,17 @@ export default async function buildModule(options) {
         external,
         output: {
           paths: libraryPaths,
-          manualChunks() { // ensure only one chunk will be created
+          manualChunks() {
+            // ensure only one chunk will be created
             return 'index';
           },
         },
       },
-      watch: options.watch ? {
-        skipWrite: true,
-      } : null,
+      watch: options.watch
+        ? {
+            skipWrite: true,
+          }
+        : null,
     },
   };
   const { buildLibrary } = await import('@vcmap/ui/build/buildHelpers.js');

package/src/buildStagingApp.js

@@ -3,15 +3,14 @@ import path from 'path';
 import fs from 'fs';
 import { logger } from '@vcsuite/cli-logger';
 import { getContext, resolveContext } from './context.js';
-import { getConfigJson, resolveMapUi } from './hostingHelpers.js';
+import { getAppConfigJson, 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';
 
-
 /**
- * creates production preview application in the dist folder based on the @vcmap/ui default map configuration.
+ * creates production preview application in the dist folder based on the @vcmap/ui default configuration.
  * @returns {Promise<void>}
  */
 export default async function buildStagingApp() {
@@ -21,11 +20,16 @@ export default async function buildStagingApp() {
   await rm(distPath, { recursive: true, force: true });
   await mkdir(distPath);
   await setupMapUi();
-  const { buildPluginsForPreview } = await import('@vcmap/ui/build/buildHelpers.js');
+  const { buildPluginsForPreview } = await import(
+    '@vcmap/ui/build/buildHelpers.js'
+  );
   await buildPluginsForPreview(getDefaultConfig(), true);
   await mkdir(path.join(distPath, 'plugins', pluginName), { recursive: true });
 
-  await buildModule({ outputPath: `plugins/${pluginName}`, keepDistFolder: true });
+  await buildModule({
+    outputPath: `plugins/${pluginName}`,
+    keepDistFolder: true,
+  });
 
   // copy assets folder if exists
   if (fs.existsSync(resolveContext('plugin-assets'))) {
@@ -42,17 +46,34 @@ export default async function buildStagingApp() {
   }
 
   await copyFile(
-    path.join(getContext(), 'node_modules', '@vcmap', 'ui', 'dist', 'index.html'),
+    path.join(
+      getContext(),
+      'node_modules',
+      '@vcmap',
+      'ui',
+      'dist',
+      'index.html',
+    ),
     path.join(distPath, 'index.html'),
   );
-  const { default: vcmConfigJs } = await getVcmConfigJs();
-  const config = await getConfigJson(vcmConfigJs.mapConfig, vcmConfigJs.auth, false, vcmConfigJs.config);
+  const vcmConfigJs = await getVcmConfigJs();
+  const appConfig = await getAppConfigJson(
+    vcmConfigJs.appConfig,
+    vcmConfigJs.auth,
+    false,
+    vcmConfigJs.config,
+  );
   // update Entry
-  const pluginConfig = config.plugins.find(p => p.name === pluginName);
+  const pluginConfig = appConfig.modules
+    .at(-1)
+    .plugins.find((p) => p.name === pluginName);
   if (pluginConfig) {
     pluginConfig.entry = `plugins/${pluginName}/index.js`;
   }
-  await writeFile(path.join(distPath, 'map.config.json'), JSON.stringify(config, null, 2));
+  await writeFile(
+    path.join(distPath, 'app.config.json'),
+    JSON.stringify(appConfig, null, 2),
+  );
   await cp(
     path.join(getContext(), 'node_modules', '@vcmap', 'ui', 'dist', 'assets'),
     path.join(distPath, 'assets'),

package/src/create.js

@@ -28,10 +28,17 @@ import { name, version, promiseExec, getDirname } from './pluginCliHelper.js';
  * @param {string} pluginPath
  * @param {string[]} filter - files or dirs to be extracted
  */
-async function downloadAndExtractPluginTar(pluginName, pluginPath, filter = undefined) {
+async function downloadAndExtractPluginTar(
+  pluginName,
+  pluginPath,
+  filter = undefined,
+) {
   const logMsg = filter ? filter.join(', ') : pluginName;
   logger.spin(`Downloading and extracting ${logMsg}`);
-  const { stdout: packOut, stderr: packErr } = await promiseExec(`npm pack ${pluginName} --quiet`, { cwd: pluginPath });
+  const { stdout: packOut, stderr: packErr } = await promiseExec(
+    `npm pack ${pluginName} --quiet`,
+    { cwd: pluginPath },
+  );
   logger.error(packErr);
 
   const tarName = packOut.trim();
@@ -42,7 +49,8 @@ async function downloadAndExtractPluginTar(pluginName, pluginPath, filter = unde
     strip: 1,
   };
   if (filter) {
-    extractOptions.filter = entryPath => filter.some(f => entryPath.includes(f));
+    extractOptions.filter = (entryPath) =>
+      filter.some((f) => entryPath.includes(f));
   }
   await tar.x(extractOptions);
   await fs.promises.rm(tarPath);
@@ -59,7 +67,11 @@ async function downloadAndExtractPluginTar(pluginName, pluginPath, filter = unde
 async function copyPluginTemplate(options, pluginPath) {
   await downloadAndExtractPluginTar(options.template, pluginPath);
 
-  const pluginPackageJson = JSON.parse((await fs.promises.readFile(path.join(pluginPath, 'package.json'))).toString());
+  const pluginPackageJson = JSON.parse(
+    (
+      await fs.promises.readFile(path.join(pluginPath, 'package.json'))
+    ).toString(),
+  );
   const userPackageJson = {
     name: options.name,
     version: options.version,
@@ -81,7 +93,11 @@ async function copyPluginTemplate(options, pluginPath) {
     JSON.stringify(packageJson, null, 2),
   );
 
-  const configJson = JSON.parse((await fs.promises.readFile(path.join(pluginPath, 'config.json'))).toString());
+  const configJson = JSON.parse(
+    (
+      await fs.promises.readFile(path.join(pluginPath, 'config.json'))
+    ).toString(),
+  );
   configJson.name = options.name;
 
   const writeConfigPromise = fs.promises.writeFile(
@@ -89,18 +105,16 @@ async function copyPluginTemplate(options, pluginPath) {
     JSON.stringify(configJson, null, 2),
   );
 
-  await Promise.all([
-    writePackagePromise,
-    writeConfigPromise,
-  ]);
+  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}`);
+      const deps = Object.entries(packageJson.dependencies).map(
+        ([depName, depVersion]) => `${depName}@${depVersion}`,
+      );
       await installDeps(deps, DepType.DEP, pluginPath);
     }
     await installDeps([`${name}@${version}`], DepType.DEV, pluginPath);
@@ -118,13 +132,12 @@ async function copyPluginTemplate(options, pluginPath) {
  * @param {string} pluginPath
  */
 async function createPluginTemplate(options, pluginPath) {
-  const installVitest = options.scripts && options.scripts.find(script => script.test);
+  const installVitest =
+    options.scripts && options.scripts.find((script) => script.test);
   if (!installVitest) {
     options.scripts.push({ test: 'echo "Error: no test specified" && exit 1' });
   } else {
-    options.scripts.push(
-      { coverage: 'vitest run --coverage' },
-    );
+    options.scripts.push({ coverage: 'vitest run --coverage' });
   }
 
   const packageJson = {
@@ -133,21 +146,15 @@ async function createPluginTemplate(options, pluginPath) {
     description: options.description,
     type: 'module',
     main: 'src/index.js',
-    scripts: Object.assign({ prepublishOnly: 'vcmplugin build' }, ...options.scripts),
+    scripts: Object.assign(
+      { prepublishOnly: 'vcmplugin build' },
+      ...options.scripts,
+    ),
     author: options.author,
     license: options.license,
     dependencies: {},
-    keywords: [
-      'vcmap',
-      'plugin',
-    ],
-    files: [
-      'src/',
-      'dist/',
-      'plugin-assets/',
-      'LICENSE.md',
-      'README.md',
-    ],
+    keywords: ['vcmap', 'plugin'],
+    files: ['src/', 'dist/', 'plugin-assets/', 'LICENSE.md', 'README.md'],
     exports: {
       '.': './src/index.js',
       './dist': './dist/index.js',
@@ -160,13 +167,14 @@ async function createPluginTemplate(options, pluginPath) {
     };
   }
 
-  const installEsLint = options.scripts.find(script => script.lint);
+  const installEsLint = options.scripts.find((script) => script.lint);
   if (installEsLint) {
     packageJson.eslintIgnore = ['node_modules'];
     packageJson.eslintConfig = {
       root: true,
       extends: '@vcsuite/eslint-config/vue',
     };
+    packageJson.prettier = '@vcsuite/eslint-config/prettier.js';
   }
 
   const writePackagePromise = fs.promises.writeFile(
@@ -199,11 +207,17 @@ async function createPluginTemplate(options, pluginPath) {
 
   if (installVitest) {
     logger.debug('setting up test environment');
-    await downloadAndExtractPluginTar('@vcmap/hello-world', pluginPath, ['tests', 'vitest.config.js']);
+    await downloadAndExtractPluginTar('@vcmap/hello-world', pluginPath, [
+      'tests',
+      'vitest.config.js',
+    ]);
   }
 
   try {
-    const peerDependencies = options.peerDeps.reduce((obj, key) => ({ ...obj, [key]: 'latest' }), {});
+    const peerDependencies = options.peerDeps.reduce(
+      (obj, key) => ({ ...obj, [key]: 'latest' }),
+      {},
+    );
     await updatePeerDependencies(peerDependencies, pluginPath);
     logger.spin('installing dependencies... (this may take a while)');
     const devDeps = [`${name}@${version}`];
@@ -211,7 +225,12 @@ async function createPluginTemplate(options, pluginPath) {
       devDeps.push('@vcsuite/eslint-config');
     }
     if (installVitest) {
-      devDeps.push('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');
@@ -250,10 +269,7 @@ async function createPlugin(options) {
 
   const writeReadmePromise = fs.promises.writeFile(
     path.join(pluginPath, 'README.md'),
-    [
-      `# ${options.name}`,
-      'describe your plugin',
-    ].join('\n'),
+    [`# ${options.name}`, 'describe your plugin'].join('\n'),
   );
 
   const writeChangesPromise = fs.promises.writeFile(
@@ -308,9 +324,27 @@ export default async function create() {
     { title: 'build', value: { build: 'vcmplugin build' }, selected: true },
     { title: 'pack', value: { pack: 'vcmplugin pack' }, selected: true },
     { title: 'start', value: { start: 'vcmplugin serve' }, selected: true },
-    { title: 'preview', value: { preview: 'vcmplugin preview' }, selected: true },
-    { title: 'buildStagingApp', value: { buildStagingApp: 'vcmplugin buildStagingApp' }, selected: true },
-    { title: 'lint', value: { lint: 'eslint "{src,tests}/**/*.{js,vue}"' }, selected: true },
+    {
+      title: 'preview',
+      value: { preview: 'vcmplugin preview' },
+      selected: true,
+    },
+    {
+      title: 'buildStagingApp',
+      value: { buildStagingApp: 'vcmplugin buildStagingApp' },
+      selected: true,
+    },
+    {
+      title: 'lint',
+      value: {
+        'lint:js': 'eslint . --ext .vue,.js,.cjs,.mjs,.ts,.cts,.mts',
+        'lint:prettier': 'prettier --check .',
+        lint: 'npm run lint:js && npm run lint:prettier',
+        format:
+          'prettier --write --list-different . && npm run lint:js -- --fix',
+      },
+      selected: true,
+    },
     { title: 'test', value: { test: 'vitest' }, selected: true },
   ];
 
@@ -342,7 +376,7 @@ export default async function create() {
       name: 'version',
       message: 'Version',
       initial: '1.0.0',
-      validate: value => !!semver.valid(value),
+      validate: (value) => !!semver.valid(value),
     },
     {
       type: 'text',
@@ -367,11 +401,10 @@ export default async function create() {
       name: 'license',
       message: 'License',
       initial: 0,
-      choices: Object.values(LicenseType)
-        .map(type => ({
-          title: type,
-          value: type,
-        })),
+      choices: Object.values(LicenseType).map((type) => ({
+        title: type,
+        value: type,
+      })),
     },
     {
       type: 'select',
@@ -404,7 +437,11 @@ export default async function create() {
     },
   ];
 
-  const answers = await prompts(questions, { onCancel() { process.exit(0); } });
+  const answers = await prompts(questions, {
+    onCancel() {
+      process.exit(0);
+    },
+  });
 
   await createPlugin(answers);
 }

package/src/defaultCommand.js

@@ -3,20 +3,28 @@ import { logger } from '@vcsuite/cli-logger';
 import { setContext } from './context.js';
 
 Command.prototype.defaultOptions = function defaultOptions() {
-  this
-    .option('--context [path]', 'an optional context, default is cwd', (value) => {
+  this.option(
+    '--context [path]',
+    'an optional context, default is cwd',
+    (value) => {
       setContext(value);
       return value;
-    });
+    },
+  );
 
   return this;
 };
 
 Command.prototype.defaultServeOptions = function defaultServeOptions() {
-  this
-    .option('-p, --port [port]', 'the port to listen on', /\d+/)
-    .option('--auth <user:password>', 'an optional auth to append to proxy requests')
-    .option('-c, --config <config>', 'a config override to not use the default plugin config')
+  this.option('-p, --port [port]', 'the port to listen on', /\d+/)
+    .option(
+      '--auth <user:password>',
+      'an optional auth to append to proxy requests',
+    )
+    .option(
+      '-c, --config <config>',
+      'a config override to not use the default plugin config',
+    )
     .option('--https', 'use https for serving');
 
   return this;