@stacksjs/actions 0.37.3

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Stacks Actions
+
+This package contains the Stacks Actions.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/actions
+```
+
+Now, you can use it in your project:
+
+```js
+import * as invoke from '@stacksjs/actions/generate'
+
+// wip
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/copy-types.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+/**
+ * This action copies all the generated types.
+ */
+export {};

package/dist/copy-types.mjs

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { frameworkPath } from "@stacksjs/paths";
+import { copyFolder } from "@stacksjs/fs";
+const destinations = [
+  [frameworkPath("dist/types/components"), frameworkPath("vue-components/dist/types")],
+  [frameworkPath("dist/types/components"), frameworkPath("web-components/dist/types")],
+  [frameworkPath("dist/types/functions"), frameworkPath("functions/dist/types")]
+];
+destinations.forEach(([src, dest]) => {
+  copyFolder(src, dest);
+});

package/dist/generate/component-meta.d.ts

@@ -0,0 +1,22 @@
+import { type ComponentMeta } from 'vue-component-meta';
+/**
+ * ℹ️ Useful links
+ *
+ * vue-component-meta tests: https://github.com/johnsoncodehk/volar/blob/master/vue-language-tools/vue-component-meta/tests/index.spec.ts
+ * Discord thread about improving vue-component-meta: https://discord.com/channels/793943652350427136/1027819645677350912
+ * GitHub issue for improving vue-component-meta based on runtime/dynamic props: https://github.com/johnsoncodehk/volar/issues/1854
+ * Discord chat: https://discord.com/channels/793943652350427136/1027819645677350912
+ * original script: https://raw.githubusercontent.com/jd-solanki/anu/main/scripts/gen-component-meta.ts
+ */
+export interface ComponentApiProps {
+    name: ComponentMeta['props'][number]['name'];
+    description: ComponentMeta['props'][number]['description'];
+    type: ComponentMeta['props'][number]['type'];
+    default: ComponentMeta['props'][number]['default'];
+}
+export interface ComponentApi {
+    props: ComponentApiProps[];
+    events: ComponentMeta['events'];
+    slots: ComponentMeta['slots'];
+}
+export declare function generateComponentMeta(): Promise<void>;

package/dist/generate/component-meta.mjs

@@ -0,0 +1,49 @@
+import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import fg from "fast-glob";
+import MarkdownIt from "markdown-it";
+import { createComponentMetaChecker } from "vue-component-meta";
+import { frameworkPath, join, parse, projectPath } from "@stacksjs/paths";
+const md = new MarkdownIt();
+export async function generateComponentMeta() {
+  const checkerOptions = {
+    forceUseTs: true,
+    schema: { ignore: ["MyIgnoredNestedProps"] },
+    printer: { newLine: 1 }
+  };
+  const tsconfigChecker = createComponentMetaChecker(
+    projectPath("tsconfig.json"),
+    checkerOptions
+  );
+  const filterMeta = (meta) => {
+    const props = [];
+    meta.props.forEach((prop) => {
+      if (prop.global)
+        return;
+      const { name, description, required, type, default: defaultValue } = prop;
+      props.push({
+        name: `${name}${required ? "" : "?"}`,
+        description: md.render(description),
+        type,
+        default: defaultValue || "unknown"
+      });
+    });
+    return {
+      props,
+      events: meta.events,
+      slots: meta.slots
+    };
+  };
+  const components = fg.sync(["components/*.vue", "components/**/*.vue"], {
+    cwd: projectPath(),
+    absolute: true
+  });
+  components.forEach((componentPath) => {
+    const componentExportName = parse(componentPath).name;
+    const meta = filterMeta(tsconfigChecker.getComponentMeta(componentPath, componentExportName));
+    const metaDirPath = frameworkPath("component-meta");
+    if (!existsSync(metaDirPath))
+      mkdirSync(metaDirPath);
+    const metaJsonFilePath = join(metaDirPath, `${componentExportName}.json`);
+    writeFileSync(metaJsonFilePath, JSON.stringify(meta, null, 4));
+  });
+}

package/dist/generate/index.d.ts

@@ -0,0 +1,4 @@
+export * from './lib-entries';
+export * from './package-json';
+export * from './vue-compat';
+export * from './vscode-custom-data';

package/dist/generate/index.mjs

@@ -0,0 +1,4 @@
+export * from "./lib-entries.mjs";
+export * from "./package-json.mjs";
+export * from "./vue-compat.mjs";
+export * from "./vscode-custom-data.mjs";

package/dist/generate/lib-entries.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Based on the config values, this method
+ * will generate the library entry points.
+ *
+ * @param type string
+ */
+export declare function generateLibEntry(type: 'vue-components' | 'web-components' | 'functions'): Promise<void>;

package/dist/generate/lib-entries.mjs

@@ -0,0 +1,79 @@
+import consola from "consola";
+import { kebabCase } from "@stacksjs/strings";
+import { libraryEntryPath } from "@stacksjs/paths";
+import { writeTextFile } from "@stacksjs/fs";
+import { determineResetPreset } from "@stacksjs/helpers";
+import { ExitCode } from "@stacksjs/types";
+import { library } from "../../../../config";
+export async function generateLibEntry(type) {
+  if (type === "vue-components")
+    consola.info("Creating the Vue component library entry point...");
+  else if (type === "web-components")
+    consola.info("Creating the Web Component library entry point...");
+  else
+    consola.info("Creating the function library entry point...");
+  try {
+    await writeTextFile({
+      path: libraryEntryPath(type),
+      data: generateEntryPointData(type)
+    });
+    if (type === "vue-components")
+      consola.success("Created the Vue component library entry point.");
+    else if (type === "web-components")
+      consola.success("Created the Web Component library entry point.");
+    else
+      consola.success("Created the function library entry point.");
+  } catch (err) {
+    consola.error(err);
+  }
+}
+function generateEntryPointData(type) {
+  let arr = [];
+  if (type === "functions") {
+    if (!library.functions.functions) {
+      consola.error("There are no functions defined to be built. Please check your config/library.ts file for potential adjustments.");
+      process.exit(ExitCode.FatalError);
+    }
+    for (const fx of library.functions.functions) {
+      if (Array.isArray(fx))
+        arr.push(`export * as ${fx[1]} from '../../../functions/${fx[0]}'`);
+      else
+        arr.push(`export * from '../../../functions/${fx}'`);
+    }
+    return arr.join("\r\n");
+  }
+  if (type === "vue-components") {
+    if (!library.vueComponents.tags) {
+      consola.error("There are no components defined to be built. Please check your config/library.ts file for potential adjustments.");
+      process.exit(ExitCode.FatalError);
+    }
+    arr = determineResetPreset();
+    for (const component of library.vueComponents.tags.map((tag) => tag.name)) {
+      if (Array.isArray(component))
+        arr.push(`export { default as ${component[1]} } from '../../../components/${component[0]}.vue'`);
+      else
+        arr.push(`export { default as ${component} } from '../../../components/${component}.vue'`);
+    }
+    return arr.join("\r\n");
+  }
+  arr = determineResetPreset();
+  const imports = [...arr, "import { defineCustomElement } from 'vue'"];
+  const declarations = [];
+  const definitions = [];
+  if (!library.webComponents.tags) {
+    consola.error("There are no components defined to be built. Please check your config/library.ts file for potential adjustments.");
+    process.exit(ExitCode.FatalError);
+  }
+  for (const component of library.webComponents.tags.map((tag) => tag.name)) {
+    if (Array.isArray(component)) {
+      imports.push(`import ${component[1]} from '../../../components/${component[0]}.vue'`);
+      declarations.push(`const ${component[1]}CustomElement = defineCustomElement(${component[1]})`);
+      definitions.push(`customElements.define('${kebabCase(component[1])}', ${component[1]}CustomElement)`);
+    } else {
+      imports.push(`import ${component} from '../../../components/${component}.vue'`);
+      declarations.push(`const ${component}CustomElement = defineCustomElement(${component})`);
+      definitions.push(`customElements.define('${kebabCase(component)}', ${component}CustomElement)`);
+    }
+  }
+  return [...imports, ...declarations, ...definitions].join("\r\n");
+}

package/dist/generate/package-json.d.ts

@@ -0,0 +1 @@
+export declare function generatePackageJson(type: 'vue-components' | 'web-components' | 'functions'): Promise<void>;

package/dist/generate/package-json.mjs

@@ -0,0 +1,76 @@
+import consola from "consola";
+import { writeTextFile } from "@stacksjs/fs";
+import { packageJsonPath } from "@stacksjs/paths";
+import { packageManager } from "../../package.json";
+import { library } from "../../../../config";
+export async function generatePackageJson(type) {
+  let name, description, directory, keywords, config;
+  if (type === "vue-components") {
+    name = library.vueComponents.name;
+    description = library.vueComponents.description;
+    directory = "components";
+    keywords = library.vueComponents.keywords;
+    config = "vue-components";
+  } else if (type === "web-components") {
+    name = library.webComponents.name;
+    description = library.webComponents.description;
+    directory = "components";
+    keywords = library.webComponents.keywords;
+    config = "web-components";
+  } else if (type === "functions") {
+    name = library.functions.name;
+    description = library.functions.description;
+    directory = "functions";
+    keywords = library.functions.keywords;
+    config = "functions";
+  }
+  try {
+    await writeTextFile({
+      path: packageJsonPath(type),
+      data: `{
+  "name": "${name}",
+  "type": "module",
+  "version": "",
+  "packageManager": "${packageManager}",
+  "description": "${description}",
+  "author": "${library.author}",
+  "license": "MIT",
+  "homepage": "https://github.com/${library.repository}/tree/main/${directory}#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/${library.repository}.git",
+    "directory": "${directory}"
+  },
+  "bugs": {
+    "url": "https://github.com/${library.repository}/issues"
+  },
+  "keywords": ${JSON.stringify(keywords)},
+  "contributors": ${JSON.stringify(library.contributors)},
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build -c ../build/${config}.ts",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "stacks": "workspace:*"
+  }
+}
+`
+    });
+    consola.success(`Created the ${type} package.json.`);
+  } catch (err) {
+    consola.error(err);
+  }
+}

package/dist/generate/vscode-custom-data.d.ts

@@ -0,0 +1 @@
+export declare function generateVsCodeCustomData(): Promise<void>;

package/dist/generate/vscode-custom-data.mjs

@@ -0,0 +1,22 @@
+import consola from "consola";
+import { customElementsDataPath } from "@stacksjs/paths";
+import { writeTextFile } from "@stacksjs/fs";
+import { library } from "../../../../config";
+export async function generateVsCodeCustomData() {
+  try {
+    await writeTextFile({
+      path: customElementsDataPath(),
+      data: generateComponentInfoData()
+    });
+  } catch (err) {
+    consola.error(err);
+  }
+}
+function generateComponentInfoData() {
+  const componentsData = JSON.stringify(library.vueComponents.tags);
+  return `{
+  "version": 1.1,
+  "tags": ${componentsData}
+}
+`;
+}

package/dist/generate/vue-compat.d.ts

@@ -0,0 +1 @@
+export declare function generateVueCompat(paths: string[]): Promise<void>;

package/dist/generate/vue-compat.mjs

@@ -0,0 +1,12 @@
+import fg from "fast-glob";
+import fs from "fs-extra";
+export async function generateVueCompat(paths) {
+  const files = await fg(paths, {
+    onlyFiles: true
+  });
+  for (const f of files) {
+    const raw = await fs.readFile(f, "utf-8");
+    const changed = raw.replace(/"@vue\/composition-api"/g, "'vue-demi'").replace(/"vue"/g, "'vue-demi'").replace(/'vue'/g, "'vue-demi'");
+    await fs.writeFile(f, changed, "utf-8");
+  }
+}

package/dist/generate-component-meta.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+/**
+ * This action generates the component meta.
+ */
+export {};

package/dist/generate-component-meta.mjs

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import consola from "consola";
+import { hasComponents } from "@stacksjs/fs";
+import { generateComponentMeta } from "./generate/component-meta.mjs";
+async function generate() {
+  if (hasComponents())
+    await generateComponentMeta();
+  else
+    consola.info("No components found. Skipping component meta generation.");
+}
+generate();

package/dist/generate-ide-helpers.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * This action generates the web-types.json & custom-elements.json
+ * files for the components.
+ */
+export {};

package/dist/generate-ide-helpers.mjs

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import consola from "consola";
+import { hasComponents } from "@stacksjs/fs";
+import { generateVsCodeCustomData } from "./generate/vscode-custom-data.mjs";
+async function generate() {
+  if (hasComponents()) {
+    await generateVsCodeCustomData();
+  } else {
+    consola.info("No components found. Skipping IDE helper generation.");
+  }
+}
+generate();

package/dist/generate-lib-entries.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/generate-lib-entries.mjs

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import consola from "consola";
+import { hasComponents, hasFunctions } from "@stacksjs/fs";
+import { generateLibEntry } from "./generate/lib-entries.mjs";
+async function generate() {
+  if (hasComponents()) {
+    await generateLibEntry("vue-components");
+    await generateLibEntry("web-components");
+  } else {
+    consola.info("No components found. Skipping building component entry points.");
+  }
+  if (hasFunctions())
+    await generateLibEntry("functions");
+  else
+    consola.info("No functions found. Skipping building function entry point.");
+}
+generate();

package/dist/generate-package-json.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/generate-package-json.mjs

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { hasComponents, hasFunctions } from "@stacksjs/fs";
+import { generatePackageJson } from "./generate/package-json.mjs";
+async function generate() {
+  if (hasComponents()) {
+    await generatePackageJson("vue-components");
+    await generatePackageJson("web-components");
+  }
+  if (hasFunctions())
+    await generatePackageJson("functions");
+}
+generate();

package/dist/generate-vscode-custom-data.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * This action generates the web-types.json & custom-elements.json
+ * files for the components.
+ */
+export {};

package/dist/generate-vscode-custom-data.mjs

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import consola from "consola";
+import { hasComponents } from "@stacksjs/fs";
+import { generateVsCodeCustomData } from "./generate/vscode-custom-data.mjs";
+async function generate() {
+  if (hasComponents())
+    await generateVsCodeCustomData();
+  else
+    consola.info("No components found. Skipping VS Code custom data generation.");
+}
+generate();

package/dist/generate-vue-compat.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * Thanks for inspiration:
+ * https://github.com/vueuse/vueuse/blob/main/scripts/fix-types.ts
+ */
+export {};

package/dist/generate-vue-compat.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { generateVueCompat } from "./generate/index.mjs";
+generateVueCompat(["wip"]);

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@stacksjs/actions",
+  "type": "module",
+  "version": "0.37.3",
+  "packageManager": "pnpm@7.13.6",
+  "description": "The Stacks actions.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/actions#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/actions"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "actions",
+    "stacks",
+    "framework",
+    "typescript",
+    "javascript",
+    "vite",
+    "nitro",
+    "vue",
+    "components",
+    "library"
+  ],
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=v18.10.0",
+    "pnpm": ">=7.13.6"
+  },
+  "dependencies": {
+    "@stacksjs/fs": "0.37.3",
+    "@stacksjs/helpers": "0.37.3",
+    "@stacksjs/paths": "0.37.3",
+    "@stacksjs/strings": "0.37.3",
+    "@stacksjs/types": "0.37.3",
+    "@types/fs-extra": "^9.0.13",
+    "@vueuse/core": "^9.3.1",
+    "consola": "^2.15.3",
+    "fast-glob": "^3.2.12",
+    "fs-extra": "^10.1.0",
+    "markdown-it": "^13.0.1",
+    "vue-component-meta": "^1.0.8"
+  },
+  "devDependencies": {
+    "mkdist": "^0.3.13"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "typecheck": "tsc --noEmit"
+  }
+}