vueless 0.0.16 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vueless",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "license": "MIT",
   "description": "Vue Styleless Component Framework.",
   "homepage": "https://vueless.com",
@@ -19,7 +19,7 @@
     "sb:build": "STORYBOOK_VUELESS_ENV=1 storybook build",
     "sb:preview": "vite preview --host --outDir=storybook-static",
     "vueless:update": "yarn add -D file:../vite-plugin-vueless file:../vueless-storybook",
-    "vueless:prepare": "node .web-types-gen && rm -rf dist && mkdir -p dist && cp -r src/* package.json LICENSE web-types.json README.md  dist/"
+    "vueless:prepare": "node src/gen.web-types && rm -rf dist && mkdir -p dist && cp -r src/* package.json LICENSE web-types.json README.md  dist/"
   },
   "dependencies": {
     "@kyvg/vue3-notification": "^3.2.1",
@@ -40,8 +40,8 @@
     "@vitejs/plugin-vue": "^5.0.4",
     "@vue/compiler-sfc": "^3.4.19",
     "@vue/eslint-config-prettier": "^9.0.0",
-    "@vueless/storybook": "file:../vueless-storybook",
-    "@vueless/vite-plugin": "file:../vite-plugin-vueless",
+    "@vueless/plugin-vite": "^0.0.1",
+    "@vueless/storybook": "^0.0.8",
     "autoprefixer": "^10.4.19",
     "cssnano": "^6.1.2",
     "eslint": "^8.55.0",
@@ -54,11 +54,14 @@
     "postcss": "^8.4.7",
     "prettier": "^3.1.0",
     "prettier-eslint": "^16.3.0",
-    "vite": "^5.1.1",
+    "vite": "^5.2.10",
     "vite-plugin-compression": "^0.5.1",
     "vite-plugin-eslint": "^1.8.1",
     "vue": "^3.4.19"
   },
+  "resolutions": {
+    "jackspeak": "2.1.1"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuelessjs/vueless.git"

package/postcss.config.js

@@ -0,0 +1,9 @@
+export default {
+  plugins: {
+    "postcss-import": {},
+    "tailwindcss/nesting": {},
+    tailwindcss: {},
+    autoprefixer: {},
+    ...(process.env.NODE_ENV === "production" ? { cssnano: {} } : {}),
+  },
+};

package/src/gen.web-types/index.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import minimist from "minimist";
+import { extractConfig } from "./lib/config.js";
+import build from "./lib/build.js";
+
+const {
+  _: pathArray,
+  configFile,
+  watch,
+  cwd,
+} = minimist(process.argv.slice(2), {
+  alias: { c: "configFile", w: "watch" },
+});
+
+const conf = await extractConfig(cwd || process.cwd(), watch, configFile, pathArray);
+
+build(conf);

package/src/gen.web-types/lib/build.js

@@ -0,0 +1,254 @@
+import path from "path";
+import { globbySync } from "globby";
+import * as chokidar from "chokidar";
+import { parse } from "vue-docgen-api";
+import * as fs from "fs";
+import mkdirp from "mkdirp";
+import _ from "lodash";
+import merge from "lodash.merge";
+
+export default async function build(config) {
+  config.componentsRoot = path.resolve(config.cwd, config.componentsRoot);
+  config.outFile = path.resolve(config.cwd, config.outFile);
+
+  // then create the watcher if necessary
+  const { watcher, componentFiles } = getSources(config.components, config.componentsRoot);
+
+  // eslint-disable-next-line no-console
+  console.log("Building web-types to " + config.outFile);
+
+  const cache = {};
+  const buildWebTypesBound = rebuild.bind(null, config, componentFiles, cache, watcher);
+
+  try {
+    await buildWebTypesBound();
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error("Error building web-types: " + e.message);
+    await watcher.close();
+
+    return;
+  }
+
+  if (config.watch) {
+    watcher
+      .on("add", buildWebTypesBound)
+      .on("change", buildWebTypesBound)
+      .on("unlink", async (filePath) => {
+        // eslint-disable-next-line no-console
+        console.log("Rebuilding on file removal " + filePath);
+        delete cache[filePath];
+        await writeDownWebTypesFile(config, Object.values(cache), config.outFile);
+      });
+  } else {
+    await watcher.close();
+  }
+}
+
+function getSources(components, cwd) {
+  const watcher = chokidar.watch(components, { cwd });
+
+  const allComponentFiles = globbySync(components, { cwd });
+
+  return { watcher, componentFiles: allComponentFiles };
+}
+
+async function rebuild(config, files, cachedContent, watcher, changedFilePath) {
+  const cacheWebTypesContent = async (filePath) => {
+    cachedContent[filePath.replace(/\\/g, "/")] = await extractInformation(
+      path.join(config.componentsRoot, filePath),
+      config,
+    );
+
+    return true;
+  };
+
+  if (changedFilePath) {
+    // eslint-disable-next-line no-console
+    console.log("Rebuilding on update file " + changedFilePath);
+
+    try {
+      // if in chokidar mode (watch), the path of the file that was just changed
+      // is passed as an argument. We only affect the changed file and avoid re-parsing the rest
+      await cacheWebTypesContent(changedFilePath);
+    } catch (e) {
+      throw new Error(
+        `Error building file ${config.outFile} when file ${changedFilePath} has changed: ${e.message}`,
+      );
+    }
+  } else {
+    try {
+      // if we are initializing the current file, parse all components
+      await Promise.all(files.map(cacheWebTypesContent));
+    } catch (e) {
+      throw new Error(`Error building file ${config.outFile}: ${e.message}`);
+    }
+  }
+
+  // and finally save all concatenated values to the markdown file
+  await writeDownWebTypesFile(config, Object.values(cachedContent), config.outFile);
+}
+
+async function writeDownWebTypesFile(config, definitions, destFilePath) {
+  const destFolder = path.dirname(destFilePath);
+
+  await mkdirp(destFolder);
+  let writeStream = fs.createWriteStream(destFilePath);
+  const contents = {
+    framework: "vue",
+    name: config.packageName,
+    version: config.packageVersion,
+    contributions: {
+      html: {
+        "description-markup": config.descriptionMarkup,
+        "types-syntax": config.typesSyntax,
+        tags: _(definitions)
+          .flatMap((d) => d.tags || [])
+          .orderBy("name", "asc")
+          .value(),
+        attributes: _(definitions)
+          .flatMap((d) => d.attributes || [])
+          .orderBy("name", "asc")
+          .value(),
+        "vue-filters": _(definitions)
+          .flatMap((d) => d["vue-filters"] || [])
+          .orderBy("name", "asc")
+          .value(),
+      },
+    },
+  };
+
+  const html = contents.contributions.html;
+
+  if (html.tags?.length == 0) html.tags = undefined;
+  if (html.attributes?.length == 0) html.attributes = undefined;
+  if (html["vue-filters"]?.length == 0) html["vue-filters"] = undefined;
+
+  writeStream.write(JSON.stringify(contents, null, 2));
+
+  // close the stream
+  writeStream.close();
+}
+
+function ensureRelative(path) {
+  // The .replace() is a fix for paths that end up like "./src\\components\\General\\VerticalButton.vue" on windows machines.
+  return (path.startsWith("./") || path.startsWith("../") ? path : "./" + path).replace(/\\/g, "/");
+}
+
+async function extractInformation(absolutePath, config) {
+  const doc = await parse(absolutePath, config.apiOptions);
+  const name = doc.name || doc.displayName;
+  let description = doc.description?.trim() ?? "";
+
+  // Get default component config
+  const configPath = path.join(path.dirname(absolutePath), "configs/default.config.js");
+  let globalConfig = null;
+  let defaultConfig = null;
+  let defaultValues = null;
+
+  if (fs.existsSync(configPath)) {
+    const defaultConfigFile = fs.readFileSync(configPath).toString();
+    const globalConfigFile = fs.readFileSync(config.cwd + "/vueless.config.js").toString();
+
+    defaultConfig = getDefaultConfigJson(defaultConfigFile);
+    globalConfig = getGlobalConfigJson(globalConfigFile, name);
+    defaultValues = merge(defaultConfig.defaultVariants, globalConfig[name]?.defaultVariants);
+  }
+
+  function getDefaultConfigJson(fileContents) {
+    const objectStartIndex = fileContents.indexOf("{");
+    const variablePattern = /([^:]+):\s*(?!true|false|undefined)([a-zA-Z_]\w*)/g;
+    let objectString = fileContents
+      .substring(objectStartIndex)
+      .replace("};", "}")
+      .replace(/undefined/g, '"undefined"')
+      .replace(variablePattern, (match, key) => key + ": {}");
+
+    return eval("(" + objectString + ")"); // Converting into JS object
+  }
+
+  function getGlobalConfigJson(fileContents, componentName) {
+    const startIndex = fileContents.indexOf(`${componentName}:`);
+
+    // find index of the last closing bracket
+    let endIndex = -1;
+    let braceCount = 0;
+
+    for (let i = startIndex; i < fileContents.length; i++) {
+      if (fileContents[i] === "{") {
+        braceCount++;
+      } else if (fileContents[i] === "}") {
+        braceCount--;
+
+        if (braceCount === 0) {
+          endIndex = i;
+          break;
+        }
+      }
+    }
+
+    // Get component config raw string
+    const rawString = fileContents.slice(startIndex, endIndex);
+
+    // If the stings are present in config but commented - remove them
+    const stringWithoutComments = rawString.replace(/\/\/.*$/gm, "");
+
+    // Check if final JSON string is valid: TODO: find better solution
+    if (!stringWithoutComments.includes("}")) return {};
+
+    const jsonString = `{${stringWithoutComments}\n}}`
+      .replace(/[`']/g, '"')
+      .replace(/(\w+)\s*: /g, '"$1":')
+      .replace(/,\s*}/g, "}");
+
+    return JSON.parse(jsonString);
+  }
+
+  doc.docsBlocks?.forEach((block) => {
+    if (description.length > 0) {
+      if (config.descriptionMarkup === "html") {
+        description += "<br/><br/>";
+      } else {
+        description += "\n\n";
+      }
+    }
+
+    description += block;
+  });
+
+  const componentPath = ensureRelative(path.relative(config.cwd, absolutePath));
+
+  return {
+    tags: [
+      {
+        name,
+        description,
+        attributes: doc.props?.map((prop) => ({
+          name: prop.name,
+          required: prop.required,
+          description: prop.tags?.ignore ? "@ignore: " + prop.description : prop.description,
+          value: {
+            kind: "expression",
+            type: prop.values ? `'${prop.values.join("' | '")}'` : prop.type?.name ?? "any",
+          },
+          default:
+            defaultValues && prop.name in defaultValues
+              ? defaultValues[prop.name].toString()
+              : prop.defaultValue?.value.toString(),
+        })),
+        events: doc.events?.map((event) => ({
+          name: event.name,
+          description: event.description,
+        })),
+        slots: doc.slots?.map((slot) => ({
+          name: slot.name,
+          description: slot.description,
+        })),
+        source: {
+          module: config.isVuelessEnv ? componentPath.replace("./src", "vueless") : componentPath,
+          symbol: doc.exportName,
+        },
+      },
+    ],
+  };
+}

package/src/gen.web-types/lib/config.js

@@ -0,0 +1,32 @@
+import path from "path";
+import fs from "fs";
+import { readFile } from "fs/promises";
+
+export async function extractConfig(cwd, watch = false, configFileFromCmd, pathArray = []) {
+  const configFilePath = configFileFromCmd
+    ? path.resolve(cwd, configFileFromCmd)
+    : path.join(cwd, "web-types.config.js");
+  const [componentsFromCmd, outFileFromCmd] = pathArray;
+
+  const fileContent = await readFile(path.join(cwd, "package.json"), "utf-8");
+  const packageJson = JSON.parse(fileContent);
+
+  let additionalConfig = {};
+
+  if (fs.existsSync(configFilePath)) {
+    additionalConfig = await import(configFilePath);
+  }
+
+  return {
+    cwd,
+    watch,
+    componentsRoot: configFilePath ? path.dirname(configFilePath) : cwd,
+    components: componentsFromCmd || "src/**/*.vue",
+    outFile: outFileFromCmd || packageJson["web-types"] || "./web-types.json",
+    packageName: packageJson["name"],
+    packageVersion: packageJson["version"],
+    typesSyntax: "typescript",
+    descriptionMarkup: "markdown",
+    ...additionalConfig.default,
+  };
+}

package/tailwind.config.js

@@ -0,0 +1,11 @@
+/** @type {import('tailwindcss').Config} */
+import { vuelessPreset } from "./src/preset.tailwind";
+
+export default {
+  presets: [vuelessPreset],
+  theme: {
+    fontFamily: {
+      roboto: ["Roboto", "sans-serif"],
+    },
+  },
+};

package/vite.config.js

@@ -0,0 +1,40 @@
+import { defineConfig } from "vite";
+import path from "path";
+// Plugins
+import Vue from "@vitejs/plugin-vue";
+import Eslint from "vite-plugin-eslint";
+import { Vueless, VuelessUnpluginComponents } from "@vueless/plugin-vite";
+
+export default defineConfig({
+  plugins: [
+    Vue(),
+    Eslint(),
+    Vueless({ mode: "storybook", env: "vueless" }),
+    VuelessUnpluginComponents(),
+  ],
+  resolve: {
+    extensions: [".vue", ".mjs", ".js", ".ts", ".mdx"],
+    alias: {
+      vueless: path.resolve(__dirname, "./src"),
+      "../web-types.json": path.resolve(__dirname, "./web-types.json"),
+      "../../../vueless.config.js": path.resolve(__dirname, "./vueless.config.js"),
+    },
+  },
+  optimizeDeps: {
+    include: [
+      "vuex",
+      "vue-tippy",
+      "@uppy/core",
+      "@uppy/vue/src/drag-drop",
+      "@kyvg/vue3-notification",
+      "@tailwindcss/forms",
+      "tailwindcss/colors.js",
+      "cva",
+      "tailwind-merge",
+      "prettier2",
+      "prettier2/parser-html",
+      "@storybook/blocks",
+      "@storybook/theming/create",
+    ],
+  },
+});

package/vueless.config.js

@@ -0,0 +1,7 @@
+export default {
+  brand: "grayscale",
+  gray: "gray",
+  component: /*tw*/ {
+    // component configs
+  },
+};

package/web-types.config.js

@@ -0,0 +1,3 @@
+export default {
+  isVuelessEnv: true,
+};