jky-component-lib 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Starter Templates Collective
+
+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,80 @@
+# Vue 3 Component Library Starter Template
+
+[![GitHub Release Version](https://img.shields.io/github/v/release/starter-collective/jky-component-lib?label=Release&color=%42b883)](https://github.com/starter-collective/jky-component-lib/releases)
+[![NPM Version](https://img.shields.io/npm/v/jky-component-lib?style=flat&label=npm&color=%42b883)](https://www.npmjs.com/package/jky-component-lib)
+[![Build Status](https://github.com/starter-collective/jky-component-lib/actions/workflows/ci.yml/badge.svg?branch=main&color=%42b883)](https://github.com/starter-collective/jky-component-lib/actions/workflows/ci.yml)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/6b182d34-7d30-4206-aad9-9789d1c8ed11/deploy-status)](https://app.netlify.com/sites/jky-component-lib/deploys)
+
+Vue 3 component library starter template, provides VitePress documentation, supports building ESM, CJS and UMD formats.
+
+- [Live Demo](https://jky-component-lib.netlify.app/)
+- [Play on Stackblitz](https://stackblitz.com/github/starter-collective/jky-component-lib)
+
+## Features
+
+- Build package with [Vite](https://vite.dev/guide/build.html#library-mode) - Library mode with no config.
+- Out-of-the-box unit testing with [Vitest](https://github.com/vitest-dev/vitest).
+- [VitePress](https://vitepress.dev/) documentation - Deploy on [Netlify](https://app.netlify.com/) with zero-config, supports other deployment methods as well.
+- Manage versions using the [bumpp](https://github.com/antfu-collective/bumpp), and publish to npm with zero-configPublish to [npm](https://www.npmjs.com) with zero-config.
+
+## Usage
+
+[Create a repo](https://github.com/starter-collective/jky-component-lib/generate) from this template on GitHub.
+
+```bash
+git clone <git remote url>
+```
+
+Install npm dependencies.
+
+```bash
+cd jky-component-lib # Or your project directory
+
+pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
+```
+
+Just run `dev` script to build your files.
+
+```bash
+pnpm dev
+```
+
+Open documentation for the library, you can run:
+
+```bash
+pnpm docs:dev
+```
+
+To build the library, you can run:
+
+```bash
+pnpm build
+```
+
+If you want to publish it, you can run:
+
+```bash
+pnpm release
+```
+
+## Clean Template
+
+If you prefer to do it manually with the cleaner git history:
+
+```bash
+npx degit starter-collective/jky-component-lib jky-component-lib
+
+cd jky-component-lib
+
+pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
+```
+
+When you use this template, try follow the checklist to update your info properly:
+
+- [ ] Change the package name in `package.json` and the global `umd` variable in `vite.config.ts`.
+- [ ] Change the import name in `src/volar.d.ts` for better TypeScript support.
+- [ ] Update the website information, favicon, and logo icons in `docs/*`.
+
+## License
+
+[MIT License](./LICENSE) © 2024-PRESENT [Kieran Wang](https://github.com/kieranwv/)

package/dist/es/components.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from 'vue';
+export * from './say-hello';
+export declare const components: Plugin[];
+export default components;

package/dist/es/components.js

@@ -0,0 +1,9 @@
+import { StSayHello as o } from "./say-hello/index.js";
+const e = [
+  o
+];
+export {
+  o as StSayHello,
+  e as components,
+  e as default
+};

package/dist/es/index.d.ts

@@ -0,0 +1,9 @@
+export * from './components';
+export * from './resolver';
+declare const installer: {
+    install: (app: import('vue').App) => void;
+    version: string;
+};
+export declare const install: (app: import('vue').App) => void;
+export declare const version: string;
+export default installer;

package/dist/es/index.js

@@ -0,0 +1,13 @@
+import { components as t } from "./components.js";
+import { createInstaller as r } from "./utils/installer.js";
+import { StarterLibVue3Resolver as m } from "./resolver.js";
+import { StSayHello as c } from "./say-hello/index.js";
+const o = r(t), s = o.install, n = o.version;
+export {
+  c as StSayHello,
+  m as StarterLibVue3Resolver,
+  t as components,
+  o as default,
+  s as install,
+  n as version
+};

package/dist/es/node_modules/@kieranwv/utils/dist/index.js

@@ -0,0 +1,6 @@
+function r(e) {
+  return e.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase().replace(/\s+/g, "-");
+}
+export {
+  r as toLowerCase
+};

package/dist/es/package.json.js

@@ -0,0 +1,4 @@
+const o = "0.0.6";
+export {
+  o as version
+};

package/dist/es/resolver.d.ts

@@ -0,0 +1,2 @@
+import { ComponentResolver } from 'unplugin-vue-components';
+export declare function StarterLibVue3Resolver(): ComponentResolver;

package/dist/es/resolver.js

@@ -0,0 +1,19 @@
+import { toLowerCase as t } from "./node_modules/@kieranwv/utils/dist/index.js";
+function r() {
+  return {
+    type: "component",
+    resolve: (e) => {
+      if (e.match(/^St[A-Z]/))
+        return {
+          name: e,
+          from: "jky-component-lib",
+          sideEffects: [
+            `jky-component-lib/dist/es/${t(e.replace("St", ""))}/style.css`
+          ]
+        };
+    }
+  };
+}
+export {
+  r as StarterLibVue3Resolver
+};

package/dist/es/say-hello/SayHello.vue.js

@@ -0,0 +1,20 @@
+import { defineComponent as l, createElementBlock as t, openBlock as a } from "vue";
+const c = /* @__PURE__ */ l({
+  name: "StSayHello",
+  __name: "SayHello",
+  props: {
+    name: {}
+  },
+  setup(n) {
+    function o() {
+      alert(`Hello, ${n.name}!`);
+    }
+    return (m, e) => (a(), t("button", {
+      class: "jky-component-lib-say-hello",
+      onClick: e[0] || (e[0] = (r) => o())
+    }, " Say, hi! "));
+  }
+});
+export {
+  c as default
+};

package/dist/es/say-hello/SayHello.vue3.js

@@ -0,0 +1,5 @@
+import o from "./SayHello.vue.js";
+/* empty css              */
+export {
+  o as default
+};

package/dist/es/say-hello/index.d.ts

@@ -0,0 +1,4 @@
+import { InstallWithSFC } from '../utils';
+import { default as SayHello } from './SayHello.vue';
+export declare const StSayHello: InstallWithSFC<typeof SayHello>;
+export default StSayHello;

package/dist/es/say-hello/index.js

@@ -0,0 +1,8 @@
+import t from "./SayHello.vue.js";
+/* empty css              */
+import { installWithSFC as o } from "../utils/with-install.js";
+const a = o(t);
+export {
+  a as StSayHello,
+  a as default
+};

package/dist/es/say-hello/style.css

@@ -0,0 +1 @@
+.jky-component-lib-say-hello{background:#42b883;color:#fff;padding:8px 20px;text-align:center;text-decoration:none;display:inline-block;font-size:16px;margin:4px 2px;cursor:pointer;border-radius:6px}

package/dist/es/styles.css

@@ -0,0 +1 @@
+.jky-component-lib-say-hello{background:#42b883;border-radius:6px;color:#fff;cursor:pointer;display:inline-block;font-size:16px;margin:4px 2px;padding:8px 20px;text-align:center;text-decoration:none}

package/dist/es/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './installer';
+export * from './types';
+export * from './with-install';

package/dist/es/utils/installer.d.ts

@@ -0,0 +1,11 @@
+import { App, Plugin } from 'vue';
+export declare const INSTALLED_KEY: unique symbol;
+declare module 'vue' {
+    interface App {
+        [INSTALLED_KEY]?: boolean;
+    }
+}
+export declare function createInstaller(components?: Plugin[]): {
+    install: (app: App) => void;
+    version: string;
+};

package/dist/es/utils/installer.js

@@ -0,0 +1,14 @@
+import { version as o } from "../package.json.js";
+const t = Symbol("INSTALLED_KEY");
+function i(n = []) {
+  return {
+    install: (r) => {
+      r[t] || (r[t] = !0, n.forEach((e) => r.use(e)));
+    },
+    version: o
+  };
+}
+export {
+  t as INSTALLED_KEY,
+  i as createInstaller
+};

package/dist/es/utils/types.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from 'vue';
+export type InstallWithSFC<T> = T & Plugin;

package/dist/es/utils/with-install.d.ts

@@ -0,0 +1,2 @@
+import { InstallWithSFC } from './types';
+export declare function installWithSFC<T, E extends Record<string, any>>(main: T, extra?: E): InstallWithSFC<T> & E;

package/dist/es/utils/with-install.js

@@ -0,0 +1,9 @@
+function c(t, n) {
+  return t.install = (e) => {
+    for (const o of [t, ...Object.values({})])
+      e.component(o.name, o);
+  }, t;
+}
+export {
+  c as installWithSFC
+};

package/dist/lib/components.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from 'vue';
+export * from './say-hello';
+export declare const components: Plugin[];
+export default components;

package/dist/lib/components.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./say-hello/index.js"),t=[e.StSayHello];exports.StSayHello=e.StSayHello;exports.components=t;exports.default=t;

package/dist/lib/index.d.ts

@@ -0,0 +1,9 @@
+export * from './components';
+export * from './resolver';
+declare const installer: {
+    install: (app: import('vue').App) => void;
+    version: string;
+};
+export declare const install: (app: import('vue').App) => void;
+export declare const version: string;
+export default installer;

package/dist/lib/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const t=require("./components.js"),o=require("./utils/installer.js"),r=require("./resolver.js"),n=require("./say-hello/index.js"),e=o.createInstaller(t.components),s=e.install,l=e.version;exports.components=t.components;exports.StarterLibVue3Resolver=r.StarterLibVue3Resolver;exports.StSayHello=n.StSayHello;exports.default=e;exports.install=s;exports.version=l;

package/dist/lib/node_modules/@kieranwv/utils/dist/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function r(e){return e.replace(/([a-z])([A-Z])/g,"$1-$2").toLowerCase().replace(/\s+/g,"-")}exports.toLowerCase=r;

package/dist/lib/package.json.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="0.0.6";exports.version=e;

package/dist/lib/resolver.d.ts

@@ -0,0 +1,2 @@
+import { ComponentResolver } from 'unplugin-vue-components';
+export declare function StarterLibVue3Resolver(): ComponentResolver;

package/dist/lib/resolver.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./node_modules/@kieranwv/utils/dist/index.js");function r(){return{type:"component",resolve:e=>{if(e.match(/^St[A-Z]/))return{name:e,from:"jky-component-lib",sideEffects:[`jky-component-lib/dist/es/${t.toLowerCase(e.replace("St",""))}/style.css`]}}}}exports.StarterLibVue3Resolver=r;

package/dist/lib/say-hello/SayHello.vue.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("vue"),o=e.defineComponent({name:"StSayHello",__name:"SayHello",props:{name:{}},setup(l){function n(){alert(`Hello, ${l.name}!`)}return(a,t)=>(e.openBlock(),e.createElementBlock("button",{class:"jky-component-lib-say-hello",onClick:t[0]||(t[0]=r=>n())}," Say, hi! "))}});exports.default=o;

package/dist/lib/say-hello/SayHello.vue3.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./SayHello.vue.js");;/* empty css               */exports.default=e.default;

package/dist/lib/say-hello/index.d.ts

@@ -0,0 +1,4 @@
+import { InstallWithSFC } from '../utils';
+import { default as SayHello } from './SayHello.vue';
+export declare const StSayHello: InstallWithSFC<typeof SayHello>;
+export default StSayHello;

package/dist/lib/say-hello/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const t=require("./SayHello.vue.js");;/* empty css               */const l=require("../utils/with-install.js"),e=l.installWithSFC(t.default);exports.StSayHello=e;exports.default=e;

package/dist/lib/say-hello/style.css

@@ -0,0 +1 @@
+.jky-component-lib-say-hello{background:#42b883;color:#fff;padding:8px 20px;text-align:center;text-decoration:none;display:inline-block;font-size:16px;margin:4px 2px;cursor:pointer;border-radius:6px}

package/dist/lib/styles.css

@@ -0,0 +1 @@
+.jky-component-lib-say-hello{background:#42b883;border-radius:6px;color:#fff;cursor:pointer;display:inline-block;font-size:16px;margin:4px 2px;padding:8px 20px;text-align:center;text-decoration:none}

package/dist/lib/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './installer';
+export * from './types';
+export * from './with-install';

package/dist/lib/utils/installer.d.ts

@@ -0,0 +1,11 @@
+import { App, Plugin } from 'vue';
+export declare const INSTALLED_KEY: unique symbol;
+declare module 'vue' {
+    interface App {
+        [INSTALLED_KEY]?: boolean;
+    }
+}
+export declare function createInstaller(components?: Plugin[]): {
+    install: (app: App) => void;
+    version: string;
+};

package/dist/lib/utils/installer.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("../package.json.js"),t=Symbol("INSTALLED_KEY");function o(r=[]){return{install:e=>{e[t]||(e[t]=!0,r.forEach(n=>e.use(n)))},version:l.version}}exports.INSTALLED_KEY=t;exports.createInstaller=o;

package/dist/lib/utils/types.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from 'vue';
+export type InstallWithSFC<T> = T & Plugin;

package/dist/lib/utils/with-install.d.ts

@@ -0,0 +1,2 @@
+import { InstallWithSFC } from './types';
+export declare function installWithSFC<T, E extends Record<string, any>>(main: T, extra?: E): InstallWithSFC<T> & E;

package/dist/lib/utils/with-install.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function l(t,n){return t.install=o=>{for(const e of[t,...Object.values({})])o.component(e.name,e)},t}exports.installWithSFC=l;

package/dist/umd/index.js

@@ -0,0 +1,2 @@
+(function(n,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("vue")):typeof define=="function"&&define.amd?define(["exports","vue"],t):(n=typeof globalThis<"u"?globalThis:n||self,t(n.StarterLibVue3={},n.Vue))})(this,function(n,t){"use strict";var s=document.createElement("style");s.textContent=`.jky-component-lib-say-hello{background:#42b883;color:#fff;padding:8px 20px;text-align:center;text-decoration:none;display:inline-block;font-size:16px;margin:4px 2px;cursor:pointer;border-radius:6px}
+/*$vite$:1*/`,document.head.appendChild(s);const f="0.0.6",c=Symbol("INSTALLED_KEY");function d(e=[]){return{install:l=>{l[c]||(l[c]=!0,e.forEach(o=>l.use(o)))},version:f}}function p(e,r){return e.install=l=>{for(const o of[e,...Object.values({})])l.component(o.name,o)},e}const a=p(t.defineComponent({name:"StSayHello",__name:"SayHello",props:{name:{}},setup(e){function r(){alert(`Hello, ${e.name}!`)}return(l,o)=>(t.openBlock(),t.createElementBlock("button",{class:"jky-component-lib-say-hello",onClick:o[0]||(o[0]=_=>r())}," Say, hi! "))}})),u=[a];function m(e){return e.replace(/([a-z])([A-Z])/g,"$1-$2").toLowerCase().replace(/\s+/g,"-")}function y(){return{type:"component",resolve:e=>{if(e.match(/^St[A-Z]/))return{name:e,from:"jky-component-lib",sideEffects:[`jky-component-lib/dist/es/${m(e.replace("St",""))}/style.css`]}}}}const i=d(u),S=i.install,b=i.version;n.StSayHello=a,n.StarterLibVue3Resolver=y,n.components=u,n.default=i,n.install=S,n.version=b,Object.defineProperties(n,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/umd/styles.css

@@ -0,0 +1 @@
+.jky-component-lib-say-hello{background:#42b883;border-radius:6px;color:#fff;cursor:pointer;display:inline-block;font-size:16px;margin:4px 2px;padding:8px 20px;text-align:center;text-decoration:none}

package/dist/volar.d.ts

@@ -0,0 +1,7 @@
+declare module 'vue' {
+  export interface GlobalComponents {
+    StSayHello: typeof import('jky-component-lib')['StSayHello']
+  }
+}
+
+export { }

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "jky-component-lib",
+  "type": "module",
+  "version": "0.0.6",
+  "packageManager": "bun@1.3.5",
+  "description": "Vue 3 component library starter template, provides VitePress documentation, supports building ESM, CJS and UMD formats. ",
+  "author": "Kieran Wang <kieranwme@gmail.com> (https://github.com/kieranwv/)",
+  "license": "MIT",
+  "homepage": "https://github.com/aiftt/jky-component-lib#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aiftt/jky-component-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/aiftt/jky-component-lib/issues"
+  },
+  "keywords": [
+    "vue3",
+    "component",
+    "library",
+    "starter"
+  ],
+  "sideEffects": [
+    "dist/**/*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/es/index.d.ts",
+      "import": "./dist/es/index.js",
+      "require": "./dist/lib/index.js"
+    },
+    "./*": "./*",
+    "./volar": "./dist/volar.d.ts",
+    "./style": "./dist/es/styles.css"
+  },
+  "main": "dist/lib/index.js",
+  "module": "dist/es/index.js",
+  "unpkg": "dist/umd/index.js",
+  "jsdelivr": "dist/umd/index.js",
+  "types": "dist/es/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18 || >=20 || >=22",
+    "bun": ">=1.3.5"
+  },
+  "scripts": {
+    "preinstall": "npx only-allow bun",
+    "prepare": "simple-git-hooks",
+    "dev": "vite build --watch",
+    "build": "bun run clean && vite build",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "bun run build && vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "test": "vitest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "vue-tsc --noEmit",
+    "clean": "rimraf dist",
+    "release": "bumpp && bun run build && bun publish"
+  },
+  "peerDependencies": {
+    "vue": "^3.2.0"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^4.13.0",
+    "@kieranwv/utils": "^0.3.0",
+    "@types/jsdom": "^21.1.7",
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "^22.15.14",
+    "@vitejs/plugin-vue": "^5.2.3",
+    "@vitejs/plugin-vue-jsx": "^4.1.2",
+    "@vue/test-utils": "^2.4.6",
+    "@vueuse/core": "^13.1.0",
+    "bumpp": "^10.1.0",
+    "cssnano": "^7.0.7",
+    "eslint": "^9.26.0",
+    "jsdom": "^26.1.0",
+    "lint-staged": "^15.5.2",
+    "markdown-it": "^14.1.0",
+    "markdown-it-container": "^4.0.0",
+    "postcss": "^8.5.3",
+    "rimraf": "^6.0.1",
+    "shiki": "^3.4.0",
+    "simple-git-hooks": "^2.13.0",
+    "typescript": "^5.8.3",
+    "unplugin-vue-components": "^28.5.0",
+    "vite": "^6.3.5",
+    "vite-plugin-bundle-styles": "^0.1.0",
+    "vite-plugin-dts": "^4.5.3",
+    "vite-plugin-static-copy": "^2.3.1",
+    "vitepress": "^1.6.3",
+    "vitest": "^3.1.3",
+    "vue": "^3.5.13",
+    "vue-tsc": "^2.2.10"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "bun run lint-staged"
+  },
+  "lint-staged": {
+    "*": "bun run lint:fix"
+  }
+}