feat: migrate @tianditu/web-components to @tianditu/wc

DemoMacro · Oct 19, 2023 · 5892b2a · 5892b2a
1 parent e4554f2
commit 5892b2a
Show file tree

Hide file tree

Showing 20 changed files with 58 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 - [@tianditu/api](./packages/api/README.md)
 - [@tianditu/types](./packages/types/README.md)
 - [@tianditu/vue](./packages/vue/README.md)
-- [@tianditu/web-components](./packages/web-components/README.md)
+- [@tianditu/wc](./packages/web-components/README.md)
 
 ## License
 

diff --git a/packages/vue/README.md b/packages/vue/README.md
@@ -10,13 +10,13 @@
 
 ```bash
 # npm
-$ npm install -D @tianditu/web-components @tianditu/vue
+$ npm install -D @tianditu/wc @tianditu/vue
 
 # yarn
-$ yarn add -D @tianditu/web-components @tianditu/vue
+$ yarn add -D @tianditu/wc @tianditu/vue
 
 # pnpm
-$ pnpm add -D @tianditu/web-components @tianditu/vue
+$ pnpm add -D @tianditu/wc @tianditu/vue
 ```
 
 ## License

diff --git a/packages/vue/build.config.ts b/packages/vue/build.config.ts
@@ -3,9 +3,5 @@ import { defineBuildConfig } from "unbuild";
 export default defineBuildConfig({
   declaration: true,
   entries: ["src/index"],
-  externals: [
-    "vue",
-    "@tianditu/web-components",
-    "@tianditu/web-components/dist/loader",
-  ],
+  externals: ["vue", "@tianditu/wc", "@tianditu/wc/dist/loader"],
 });
diff --git a/packages/vue/package.json b/packages/vue/package.json
@@ -34,7 +34,7 @@
   },
   "homepage": "https://github.com/DemoMacro/tianditu#readme",
   "devDependencies": {
-    "@tianditu/web-components": "workspace:*",
+    "@tianditu/wc": "workspace:*",
     "vue": "3.3.4"
   }
 }
diff --git a/packages/vue/src/components.ts b/packages/vue/src/components.ts
@@ -3,7 +3,7 @@
 /* auto-generated vue proxies */
 import { defineContainer } from "./vue-component-lib/utils";
 
-import type { JSX } from "@tianditu/web-components";
+import type { JSX } from "@tianditu/wc";
 
 export const TdtControl = /*@__PURE__*/ defineContainer<JSX.TdtControl>(
   "tdt-control",

diff --git a/packages/vue/src/plugin.ts b/packages/vue/src/plugin.ts
@@ -1,7 +1,4 @@
-import {
-  applyPolyfills,
-  defineCustomElements,
-} from "@tianditu/web-components/dist/loader";
+import { applyPolyfills, defineCustomElements } from "@tianditu/wc/dist/loader";
 import { Plugin } from "vue";
 
 export const ComponentLibrary: Plugin = {

diff --git a/packages/wc/README.md b/packages/wc/README.md
@@ -0,0 +1,42 @@
+# @tianditu/wc
+
+![npm version](https://img.shields.io/npm/v/@tianditu/wc)
+![npm downloads](https://img.shields.io/npm/dw/@tianditu/wc)
+![npm license](https://img.shields.io/npm/l/@tianditu/wc)
+
+> Web components for tianditu, powered by Demo Macro.
+
+## Getting started
+
+### CDN
+
+```html
+<html>
+  <head>
+    <script
+      type="module"
+      src="https://cdn.jsdelivr.net/npm/@tianditu/wc/dist/web-components/web-components.esm.js"
+    ></script>
+  </head>
+  <body>
+    <tdt-map tk=""></tdt-map>
+  </body>
+</html>
+```
+
+### NPM
+
+```bash
+# npm
+$ npm install -D @tianditu/wc
+
+# yarn
+$ yarn add -D @tianditu/wc
+
+# pnpm
+$ pnpm add -D @tianditu/wc
+```
+
+## License
+
+- [MIT](LICENSE) &copy; [Demo Macro](https://imst.xyz/)
diff --git a/packages/web-components/package.json → packages/wc/package.json b/packages/web-components/package.json → packages/wc/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@tianditu/web-components",
+  "name": "@tianditu/wc",
   "version": "0.0.0",
   "description": "Web components for tianditu, powered by Demo Macro.",
   "main": "dist/index.cjs.js",

diff --git a/packages/web-components/src/components.d.ts → packages/wc/src/components.d.ts b/packages/web-components/src/components.d.ts → packages/wc/src/components.d.ts
diff --git a/...s/tdt-control-scale/tdt-control-scale.tsx → ...s/tdt-control-scale/tdt-control-scale.tsx b/...s/tdt-control-scale/tdt-control-scale.tsx → ...s/tdt-control-scale/tdt-control-scale.tsx
diff --git a/...nts/tdt-control-zoom/tdt-control-zoom.tsx → ...nts/tdt-control-zoom/tdt-control-zoom.tsx b/...nts/tdt-control-zoom/tdt-control-zoom.tsx → ...nts/tdt-control-zoom/tdt-control-zoom.tsx
diff --git a/...rc/components/tdt-control/tdt-control.tsx → ...rc/components/tdt-control/tdt-control.tsx b/...rc/components/tdt-control/tdt-control.tsx → ...rc/components/tdt-control/tdt-control.tsx
diff --git a/...onents/src/components/tdt-map/tdt-map.tsx → ...ges/wc/src/components/tdt-map/tdt-map.tsx b/...onents/src/components/tdt-map/tdt-map.tsx → ...ges/wc/src/components/tdt-map/tdt-map.tsx
diff --git a/packages/web-components/src/index.ts → packages/wc/src/index.ts b/packages/web-components/src/index.ts → packages/wc/src/index.ts
diff --git a/packages/web-components/src/utils/use.ts → packages/wc/src/utils/use.ts b/packages/web-components/src/utils/use.ts → packages/wc/src/utils/use.ts
diff --git a/packages/web-components/stencil.config.ts → packages/wc/stencil.config.ts b/packages/web-components/stencil.config.ts → packages/wc/stencil.config.ts
@@ -15,7 +15,7 @@ export const config: Config = {
       dir: "dist/hydrate",
     },
     vueOutputTarget({
-      componentCorePackage: "@tianditu/web-components",
+      componentCorePackage: "@tianditu/wc",
       proxiesFile: "../vue/src/components.ts",
     }),
     {

diff --git a/packages/web-components/tsconfig.json → packages/wc/tsconfig.json b/packages/web-components/tsconfig.json → packages/wc/tsconfig.json
diff --git a/packages/web-components/README.md b/packages/web-components/README.md
diff --git a/playground/nuxt/package.json b/playground/nuxt/package.json
@@ -12,7 +12,7 @@
     "@tianditu/api": "workspace:*",
     "@tianditu/types": "workspace:*",
     "@tianditu/vue": "workspace:*",
-    "@tianditu/web-components": "workspace:*",
+    "@tianditu/wc": "workspace:*",
     "@unocss/nuxt": "0.56.1",
     "@unocss/reset": "0.56.1",
     "nuxt": "3.7.4"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml