vueless 0.0.8 → 0.0.10

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

@@ -1,252 +0,0 @@
-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;
-  });
-
-  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: ensureRelative(path.relative(config.cwd, absolutePath)).substring(1), // TODO: maybe substring should be removed when it turns to package
-          symbol: doc.exportName,
-        },
-      },
-    ],
-  };
-}

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

@@ -1,32 +0,0 @@
-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,
-  };
-}

package/index.pcss

@@ -1,3 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;

package/postcss.config.js

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

package/readme/README.md

@@ -1,8 +0,0 @@
-# Vueless:
-
-See:
-* [installation.md](installation.md)
-* [customization.md](customization.md)
-
-## TODO: Create general readme later
-

package/readme/UGroup.md

@@ -1,25 +0,0 @@
-## Form Group config:
-
-Settings for an `UGroup` component.
-
-**upperlined** – Show line above the header.
-- type: Boolean
-- default: undefined
-
-Example:
-
-``` javascript
-upperlined: true
-```
-
-***
-
-**underlined** – show line under the header.
-- type: Boolean
-- default: undefined
-
-Example:
-
-``` javascript
-underlined: true
-```

package/readme/UNotify.md

@@ -1,53 +0,0 @@
-## Notify config:
-
-Settings for an `UNotify` component.
-
-**duration** – component hide time.
-- type: Object
-- default: 
-
-``` javascript
-{
-  short: 4000,
-  medium: 8000,
-  long: 12000,
-  permanent: 300000,
-},
-```
-
-Example with **owervrited** default params:
-
-``` javascript
-duration: {
-  extraShort: 500,
-  short: 1000,
-  medium: 4000,
-  long: 10000,
-  permanent: 250000,
-}
-```
-
-***where***: 
-
-- `short` – duration name which may be used in `UNotify` component.
-- `1000` – duration time in milliseconds.
-
-***
-
-**positionClasses** – if you need to center notify in the non-centred `UPage` use this config.
-- type: Object
-- default: {}
-
-``` javascript
-positionClasses: {
-  page: ".vueless-page-wrapper",
-  aside: ".aside",
-},
-```
-
-***where***:
-
-- `page` – class of page block you're going to center notify component.
-- `aside` – class of aside block to shift this in calculations.
-
-***

package/readme/UPage.md

@@ -1,37 +0,0 @@
-## Page config:
-
-Settings for an `UPage` component (main container component for all pages).
-
-**disabledFixedRounding** – makes fixed lateral rounding inactive.
-- type: String
-- default: false
-
-Example:
-
-``` javascript
-disabledFixedRounding: true
-```
-
-***
-
-**headerPadding** – Active side padding for header.
-- type: Boolean
-- default: undefined
-
-Example:
-
-``` javascript
-headerPadding: true
-```
-
-***
-
-**footerPadding** – side padding for footer.
-- type: Boolean
-- default: undefined
-
-Example:
-
-``` javascript
-footerPadding: true
-```

package/readme/UTopLoader.md

@@ -1,27 +0,0 @@
-## TopLoader config:
-
-Settings for an `ULoaderTop` component (top stripe which appears when API request is pending).
-
-To use this layout, you need to import vuex store from `@vueless/layouts/ui.loader-top/store` and ` @vueless/layouts/ui.loader/store`.
-
-**color** – top stripe color.
-- type: String
-- default: `blue`
-- values: `gray`, `red`, `orange`, `yellow`, `green`, `blue`, `violet`, `fuchsia`
-
-Example:
-
-``` javascript
-color: "red"
-```
-
-**brandColorGetter** – Vuex Getter to get brand color (brand color) from Vuex store.
-- type: String
-- default: `""`
-- expected data: `String` (for example `#434cd0`)
-
-Example:
-
-``` javascript
-colorGetter: "user/topLoaderColor",
-```