From cdd317b300760c75e2881941d05a51a28e3113eb Mon Sep 17 00:00:00 2001 From: hechang27-sprt Date: Fri, 26 Dec 2025 21:15:21 +0800 Subject: [PATCH] fix: more build configs --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++- package.json | 89 ++++++++++++++++++++++++++-------------------------- 2 files changed, 115 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 4f0ad49..bb4d2ae 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,72 @@ # noob-components -基于vue3.0和element-plus的组件库 \ No newline at end of file +基于vue3.0和element-plus的组件库 + +## Installation + +```bash +npm install noob-mengyxu +# or +yarn add noob-mengyxu +# or +pnpm add noob-mengyxu +``` + +## Usage + +### Import from main entry (all exports) + +```typescript +import { NoobButton, useListTable, pageEmpty } from 'noob-mengyxu' +``` + +### Import from specific subpaths (recommended for better tree-shaking) + +```typescript +// Components +import { NoobButton, NoobInput, ListTable } from 'noob-mengyxu/components' + +// Composables +import { useListTable, useModifyForm, useSysDict } from 'noob-mengyxu/composables' + +// HTTP utilities +import { pageEmpty, PageResponse } from 'noob-mengyxu/http' + +// API modules +import { dictionary, role, user } from 'noob-mengyxu/api' + +// Other utilities +import { asyncMap } from 'noob-mengyxu/utils' +import { ElMessage } from 'noob-mengyxu/element' +import { i18n } from 'noob-mengyxu/i18n' +``` + +## Available Subpaths + +- `noob-mengyxu/components` - Base UI components +- `noob-mengyxu/tools` - Tool components (Terminal, Color picker, etc.) +- `noob-mengyxu/manage` - Management components +- `noob-mengyxu/composables` - Vue composables +- `noob-mengyxu/api` - API modules +- `noob-mengyxu/http` - HTTP utilities +- `noob-mengyxu/i18n` - Internationalization +- `noob-mengyxu/config` - Configuration +- `noob-mengyxu/element` - Element Plus utilities +- `noob-mengyxu/store` - Vuex store utilities +- `noob-mengyxu/utils` - General utilities + +## Development + +```bash +# Install dependencies +npm install + +# Run dev server +npm run dev + +# Build library +npm run build:lib + +# Lint +npm run lint +``` diff --git a/package.json b/package.json index 2cea7fc..5cabc75 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,9 @@ { "name": "noob-mengyxu", "version": "0.4.9", - "main": "index.ts", - "module": "index.ts", + "main": "./dist/index.js", + "module": "./dist/index.js", + "types": "./dist/index.d.ts", "keywords": [ "noob-mengyxu", "noob", @@ -12,77 +13,77 @@ "ui", "vue" ], - "file": [ - "packages/", - "plugs/" + "files": [ + "dist/" ], "exports": { ".": { - "types": "./index.ts", - "require": "./index.ts", - "import": "./index.ts" + "types": "./dist/index.d.ts", + "require": "./dist/index.js", + "import": "./dist/index.js" }, "./components": { - "types": "./packages/base/index.ts", - "require": "./packages/base/index.ts", - "import": "./packages/base/index.ts" + "types": "./dist/packages/base/index.d.ts", + "require": "./dist/packages/base/index.js", + "import": "./dist/packages/base/index.js" }, "./tools": { - "types": "./packages/tool/index.ts", - "require": "./packages/tool/index.ts", - "import": "./packages/tool/index.ts" + "types": "./dist/packages/tool/index.d.ts", + "require": "./dist/packages/tool/index.js", + "import": "./dist/packages/tool/index.js" }, "./manage": { - "types": "./packages/manage/index.ts", - "require": "./packages/manage/index.ts", - "import": "./packages/manage/index.ts" + "types": "./dist/packages/manage/index.d.ts", + "require": "./dist/packages/manage/index.js", + "import": "./dist/packages/manage/index.js" }, "./composables": { - "types": "./plugs/composables/index.ts", - "require": "./plugs/composables/index.ts", - "import": "./plugs/composables/index.ts" + "types": "./dist/plugs/composables/index.d.ts", + "require": "./dist/plugs/composables/index.js", + "import": "./dist/plugs/composables/index.js" }, "./api": { - "types": "./plugs/api/index.ts", - "require": "./plugs/api/index.ts", - "import": "./plugs/api/index.ts" + "types": "./dist/plugs/api/index.d.ts", + "require": "./dist/plugs/api/index.js", + "import": "./dist/plugs/api/index.js" }, "./http": { - "types": "./plugs/http/index.ts", - "require": "./plugs/http/index.ts", - "import": "./plugs/http/index.ts" + "types": "./dist/plugs/http/index.d.ts", + "require": "./dist/plugs/http/index.js", + "import": "./dist/plugs/http/index.js" }, "./i18n": { - "types": "./plugs/i18n/index.ts", - "require": "./plugs/i18n/index.ts", - "import": "./plugs/i18n/index.ts" + "types": "./dist/plugs/i18n/index.d.ts", + "require": "./dist/plugs/i18n/index.js", + "import": "./dist/plugs/i18n/index.js" }, "./config": { - "types": "./plugs/config/index.ts", - "require": "./plugs/config/index.ts", - "import": "./plugs/config/index.ts" + "types": "./dist/plugs/config/index.d.ts", + "require": "./dist/plugs/config/index.js", + "import": "./dist/plugs/config/index.js" }, "./element": { - "types": "./plugs/element/index.ts", - "require": "./plugs/element/index.ts", - "import": "./plugs/element/index.ts" + "types": "./dist/plugs/element/index.d.ts", + "require": "./dist/plugs/element/index.js", + "import": "./dist/plugs/element/index.js" }, "./store": { - "types": "./plugs/store/index.ts", - "require": "./plugs/store/index.ts", - "import": "./plugs/store/index.ts" + "types": "./dist/plugs/store/index.d.ts", + "require": "./dist/plugs/store/index.js", + "import": "./dist/plugs/store/index.js" }, "./utils": { - "types": "./plugs/util/index.ts", - "require": "./plugs/util/index.ts", - "import": "./plugs/util/index.ts" - }, - "./packages": "./packages/index.ts", - "./plugs": "./plugs/index.ts" + "types": "./dist/plugs/util/index.d.ts", + "require": "./dist/plugs/util/index.js", + "import": "./dist/plugs/util/index.js" + } }, "scripts": { "dev": "vue-cli-service serve", "build": "vue-cli-service build", + "build:lib": "tsc -p tsconfig.build.json", + "prepare": "npm run build:lib", + "prepublishOnly": "npm run build:lib", "lint": "vue-cli-service lint" }, "dependencies": {