@blueprintui/cli 0.8.1 → 0.10.0

package/.nvmrc

@@ -1 +1 @@
-20.14.0
+22.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.10.0
+- feat: improved package publishing verification
+
+## 0.9.0
+- feat: add vscode metadata support
+
 ## 0.8.1
 - update to typescript 5.5.x
 

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://badge.fury.io/js/@blueprintui%2Fcli.svg)](https://badge.fury.io/js/@blueprintui%2Fcli)
 
-## Opinionated CLI for creating Web Component Libraries
+## Opinionated Minimal CLI for creating Web Component Libraries
 
 Blueprint CLI provides an out-of-the-box tool kit for compiling and creating
 Web Component libraries. This project is still an experimental work in progress.
@@ -48,10 +48,10 @@ Below are the default values unless otherwise specified.
 export default { 
   library: {
     externals: [],
-    assets: ['./README.md', './LICENSE.md', './package.json'],
+    assets: ['./README.md', './LICENSE.md'],
     customElementsManifestLockFile: './custom-elements.lock.json',
     baseDir: './src',
-    outDir: './dist/lib',
+    outDir: './dist',
     entryPoints: ['./src/**/index.ts'],
     tsconfig: './tsconfig.lib.json',
     sourcemap: false,

package/package.json

@@ -1,45 +1,48 @@
 {
   "name": "@blueprintui/cli",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "description": "",
   "main": "./index.mjs",
   "bin": {
     "bp": "./src/index.mjs"
   },
-  "scripts": {
-    "bp": "./src/index.mjs",
-    "start": "cd docs && lite-server",
-    "deploy": "firebase deploy --only hosting:blueprintui-cli"
+  "engines": {
+    "node": "22.8.0"
   },
   "author": "Crylan Software",
   "license": "MIT",
   "dependencies": {
-    "@custom-elements-manifest/analyzer": "0.10.2",
+    "@custom-elements-manifest/analyzer": "0.10.3",
     "@lit/ts-transformers": "2.0.1",
     "@rollup/plugin-node-resolve": "15.2.3",
     "@rollup/plugin-replace": "5.0.7",
     "@rollup/plugin-typescript": "11.1.6",
     "@rollup/plugin-virtual": "3.0.2",
-    "@skypack/package-check": "0.2.2",
-    "acorn-import-attributes": "1.9.5",
-    "acorn-import-assertions": "1.9.0",
-    "browserslist": "4.23.1",
+    "@rollup/pluginutils": "5.1.0",
+    "browserslist": "4.23.2",
     "commander": "12.1.0",
+    "custom-element-vs-code-integration": "1.4.1",
     "glob": "10.4.1",
     "lightningcss": "1.25.1",
     "minify-html-literals": "1.3.5",
     "path": "0.12.7",
-    "rollup": "4.18.0",
+    "publint": "0.2.10",
+    "rollup": "4.21.3",
     "rollup-plugin-copy": "3.5.0",
     "rollup-plugin-css-modules": "0.1.2",
-    "rollup-plugin-delete": "2.0.0",
+    "rollup-plugin-delete": "2.1.0",
     "rollup-plugin-shell": "1.0.9",
-    "terser": "5.31.1",
-    "tslib": "2.6.3",
-    "typescript": "~5.5.2",
-    "zx": "8.1.2"
+    "terser": "5.32.0",
+    "tslib": "2.7.0",
+    "typescript": "~5.6.2",
+    "zx": "8.1.6"
   },
   "devDependencies": {
     "lite-server": "2.6.1"
+  },
+  "scripts": {
+    "bp": "./src/index.mjs",
+    "start": "cd docs && lite-server",
+    "deploy": "firebase deploy --only hosting:blueprintui-cli"
   }
-}
+}

package/src/custom-elements-manifest.config.mjs

@@ -1,4 +1,5 @@
 import { resolve } from 'path';
+import { customElementVsCodePlugin } from 'custom-element-vs-code-integration';
 
 const cwd = process.cwd();
 const baseSrc = resolve(cwd, 'src');
@@ -10,7 +11,7 @@ if (process.env.BLUEPRINTUI_CONFIG) {
 
 const config = {
   baseDir: './src',
-  outDir: './dist/lib',
+  outDir: './dist',
   ...userConfig?.default?.library
 };
 
@@ -26,7 +27,16 @@ export default {
   ],
   outdir: config.outDir,
   litelement: true,
-  plugins: [tsExtension(), baseDir(), orderElements(), metadata({ tags: ['docs', 'spec', 'status'] })],
+  plugins: [
+    tsExtension(),
+    baseDir(),
+    orderElements(),
+    metadata({ tags: ['docs', 'spec', 'status'] }),
+    customElementVsCodePlugin({
+      outdir: config.outDir,
+      hideLogs: true
+    })
+  ],
 };
 
 function orderElements() {

package/src/index.mjs

@@ -10,6 +10,8 @@ import { cp, lstat, readdir } from 'fs/promises';
 import { readFileSync, writeFileSync } from 'fs';
 import { join, resolve }  from 'path';
 import { getUserConfig } from './utils.mjs';
+import { publint } from 'publint';
+import { formatMessage } from 'publint/utils';
 
 const deepReadDir = async (dirPath) => await Promise.all(
   (await readdir(dirPath)).map(async (entity) => {
@@ -35,7 +37,7 @@ program
   .action(async (options, command) => {
     process.env.BLUEPRINTUI_BUILD = !options.watch ? 'production' : 'development';
     process.env.BLUEPRINTUI_CONFIG = command.args[0] ? path.resolve(command.args[0]) : path.resolve('./blueprint.config.js');
-    buildRollup(options);
+    await buildRollup(options);
   });
 
 program
@@ -85,7 +87,7 @@ program
 program.parse();
 
 function buildRollup(args) {
-  loadConfigFile(path.resolve(__dirname, './rollup.config.mjs'), {}).then(
+  return loadConfigFile(path.resolve(__dirname, './rollup.config.mjs'), {}).then(
     async ({ options, warnings }) => {
       if (warnings.count) {
         console.log(`${warnings.count} warnings`);
@@ -106,8 +108,20 @@ function buildRollup(args) {
         }
         if (bundle) {
           const end = Date.now();
-          console.log(status.success, `Completed in ${(end - start) / 1000} seconds 🎉`);
           await bundle.close();
+
+          const { messages } = await spinner('Verifying Package...', async () => await publint({
+            strict: true
+          }));
+
+          if (messages.length) {
+            const pkg = JSON.parse(readFileSync('./package.json', 'utf8'));
+            for (const message of messages) {
+              console.log(formatMessage(message, pkg))
+            }
+          } else {
+            console.log(status.success, `Success in ${(end - start) / 1000} seconds 🎉`);
+          }
         }
         process.exit(buildFailed ? 1 : 0);
       }

package/src/project/tsconfig.json

@@ -8,7 +8,7 @@
     "useDefineForClassFields": false,
     "allowSyntheticDefaultImports": false,
     "resolveJsonModule": true,
-    "outDir": "./dist/lib",
+    "outDir": "./dist",
     "declaration": true,
     "types": ["jasmine"],
     "alwaysStrict": true,

package/src/project/tsconfig.lib.json

@@ -6,7 +6,7 @@
     "isolatedModules": true,
     "useDefineForClassFields": true,
     "noEmit": true,
-    "tsBuildInfoFile": "./dist/lib/.tsbuildinfo"
+    "tsBuildInfoFile": "./dist/.tsbuildinfo"
   },
   "exclude": [
     "dist",

package/src/rollup.config.mjs

@@ -4,7 +4,6 @@ import replace from '@rollup/plugin-replace';
 import virtual from '@rollup/plugin-virtual';
 import copy from 'rollup-plugin-copy';
 import del from 'rollup-plugin-delete';
-import execute from 'rollup-plugin-shell';
 import { fs, glob, path } from 'zx';
 import { idiomaticDecoratorsTransformer, constructorCleanupTransformer } from '@lit/ts-transformers';
 import { fileURLToPath } from 'url';
@@ -53,15 +52,12 @@ export default [
       createEntrypoints(),
       nodeResolve({ exportConditions: [project.prod ? 'production' : 'development'] }),
       compileTypescript(),
-      typeCheck(),
       project.prod ? [] : writeCache(project),
       project.prod ? minifyHTML() : [],
       project.prod ? minifyJavaScript() : [],
       project.prod ? inlinePackageVersion() : [],
       project.prod ? postClean(): [],
-      project.prod ? packageCheck() : [],
-      project.prod ? customElementsAnalyzer(project) : [],
-      project.prod ? cleanPackageJson() : []
+      project.prod ? customElementsAnalyzer(project) : []
     ],
   },
 ];
@@ -91,10 +87,6 @@ function compileTypescript() {
   });
 }
 
-function typeCheck() {
-  return execute({ commands: [`tsc --noEmit --project ${project.tsconfig}`], hook: 'buildEnd' });
-}
-
 function inlinePackageVersion() {
   return replace({ preventAssignment: false, values: { PACKAGE_VERSION: project.packageJSON.version } });
 }
@@ -102,16 +94,3 @@ function inlinePackageVersion() {
 function postClean() {
   return del({ targets: [`${project.outDir}/**/.tsbuildinfo`, `${project.outDir}/**/_virtual`], hook: 'writeBundle' });
 }
-
-function packageCheck() {
-  return execute({ commands: [`package-check --cwd ${project.outDir}`], sync: true, hook: 'writeBundle' });
-};
-
-function cleanPackageJson() {
-  return {
-    name: 'clean-package-json',
-    writeBundle: async () => {
-      await fs.writeFile(`${project.outDir}/package.json`, JSON.stringify({ ...project.packageJSON, scripts: undefined, devDependencies: undefined }, null, 2));
-    }
-  }
-}

package/src/utils.mjs

@@ -1,7 +1,12 @@
 import { cli } from '@custom-elements-manifest/analyzer/cli.js';
 
 export async function runCustomElementsAnalyzer(customElementsManifestConfig) {
-  return await cli({ argv: ['analyze', '--quiet', '--config', customElementsManifestConfig] });
+  // disable noisy log output from custom-elements-manifest
+  const log = console.log;
+  console.log = () => {};
+  const result = await cli({ argv: ['analyze', '--quiet', '--config', customElementsManifestConfig] });
+  console.log = log;
+  return result;
 }
 
 export async function getUserConfig() {
@@ -12,10 +17,10 @@ export async function getUserConfig() {
 
   return {
     externals: [],
-    assets: ['./README.md', './LICENSE.md', './package.json'],
+    assets: [],
     customElementsManifestLockFile: './custom-elements.lock.json',
     baseDir: './src',
-    outDir: './dist/lib',
+    outDir: './dist',
     entryPoints: ['./src/**/index.ts'],
     tsconfig: './tsconfig.lib.json',
     sourcemap: false,