hd-attribute-set 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# hd-attribute-set
+
+基于 **React + TypeScript + antd** 的属性集组件库，使用 Vite 库模式构建，通过 [CNB 云原生构建](https://docs.cnb.cool/) 自动发布到 npm。
+
+## 目录结构
+
+```
+├── .cnb.yml                # CNB 云原生构建流水线配置
+├── index.html              # 本地调试入口（playground）
+├── src
+│   ├── index.ts            # 组件库入口（构建产物入口）
+│   ├── App.tsx             # 调试页面
+│   ├── main.tsx            # 调试页面挂载入口
+│   └── components
+│       └── attribute-set   # 属性集组件（antd）
+├── vite.config.ts          # Vite 配置（lib 模式）
+└── tsconfig.json
+```
+
+## 本地开发
+
+```bash
+npm install
+npm run dev      # 启动 playground 调试组件
+npm run build    # 构建产物到 dist/（ESM + UMD + CSS + 类型声明）
+npm pack --dry-run   # 查看将要发布到 npm 的文件清单
+```
+
+## 使用示例
+
+```tsx
+import { AttributeSet } from 'hd-attribute-set';
+import 'hd-attribute-set/dist/hd-attribute-set.css';
+
+<AttributeSet
+  title="基础属性"
+  items={[
+    { key: 'cpu', label: 'CPU', value: '8 核' },
+    { key: 'memory', label: '内存', value: '16 GB' },
+  ]}
+/>
+```
+
+## 发布到 npm（云原生构建）
+
+1. 在 npmjs.com 生成 Access Token。
+2. 在 CNB 仓库设置中配置环境变量 `NPM_TOKEN`（或放入密钥仓库，并在 `.cnb.yml` 的 `tag_push` 中增加 `imports` 指向密钥仓库）。
+3. push 到 `main` 分支会自动执行安装 + 构建校验；发布正式版时推送 tag：
+
+```bash
+npm version patch        # 0.1.0 -> 0.1.1，自动提交 tag
+git push origin main --tags
+```
+
+流水线将自动构建并执行 `npm publish`（`prepublishOnly` 也会兜底执行构建）。
+
+## 发布前检查清单
+
+- [ ] `package.json` 的 `version` 已升版（与 tag 一致）。
+- [ ] `npm run build` 通过，`dist` 含 `hd-attribute-set.js`、`hd-attribute-set.umd.cjs`、`hd-attribute-set.css`、`index.d.ts`。
+- [ ] `npm pack --dry-run` 中仅包含 `dist` 与 `README.md`，无源码泄露。
+- [ ] 使用方已安装 `antd`（peer 依赖，不在包内打包）。

package/dist/components/attribute-set/index.d.ts

@@ -0,0 +1,7 @@
+import { AttributeItem, AttributeSetProps } from './types';
+export type { AttributeItem, AttributeSetProps };
+/**
+ * 属性集组件：以 antd Descriptions 展示一组键值属性
+ */
+export declare function AttributeSet({ items, title, column, bordered, emptyText }: AttributeSetProps): import("react").JSX.Element;
+export default AttributeSet;

package/dist/components/attribute-set/types.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode } from 'react';
+/** 单个属性项 */
+export interface AttributeItem {
+    /** 唯一标识 */
+    key: string;
+    /** 属性名 */
+    label: ReactNode;
+    /** 属性值 */
+    value?: ReactNode;
+    /** 自定义渲染 */
+    render?: (value?: ReactNode) => ReactNode;
+    /** Descriptions 的栅格跨度 */
+    span?: number;
+}
+/** AttributeSet 组件属性 */
+export interface AttributeSetProps {
+    /** 属性集标题 */
+    title?: ReactNode;
+    /** 属性项列表 */
+    items: AttributeItem[];
+    /** 每行列数，默认 2 */
+    column?: number;
+    /** 是否显示边框，默认 true */
+    bordered?: boolean;
+    /** 空数据提示文案 */
+    emptyText?: string;
+}

package/dist/hd-attribute-set.css

@@ -0,0 +1 @@
+.hd-attribute-set__title{font-size:16px;font-weight:600}

package/dist/hd-attribute-set.js

@@ -0,0 +1,35 @@
+import { jsxs as s, Fragment as i, jsx as r } from "react/jsx-runtime";
+import { Divider as n, Empty as l, Descriptions as h } from "antd";
+function m({ items: a, title: t, column: d = 2, bordered: c = !0, emptyText: p = "暂无属性" }) {
+  return !a || a.length === 0 ? /* @__PURE__ */ s("div", { className: "hd-attribute-set", children: [
+    t && /* @__PURE__ */ s(i, { children: [
+      /* @__PURE__ */ r("div", { className: "hd-attribute-set__title", children: t }),
+      /* @__PURE__ */ r(n, { style: { margin: "8px 0 16px" } })
+    ] }),
+    /* @__PURE__ */ r(l, { image: l.PRESENTED_IMAGE_SIMPLE, description: p })
+  ] }) : /* @__PURE__ */ s("div", { className: "hd-attribute-set", children: [
+    t && /* @__PURE__ */ s(i, { children: [
+      /* @__PURE__ */ r("div", { className: "hd-attribute-set__title", children: t }),
+      /* @__PURE__ */ r(n, { style: { margin: "8px 0 16px" } })
+    ] }),
+    /* @__PURE__ */ r(
+      h,
+      {
+        size: "small",
+        column: d,
+        bordered: c,
+        items: a.map((e) => ({
+          key: e.key,
+          label: e.label,
+          children: e.render ? e.render(e.value) : e.value ?? "-",
+          span: e.span
+        }))
+      }
+    )
+  ] });
+}
+const v = "0.1.0";
+export {
+  m as AttributeSet,
+  v as version
+};

package/dist/hd-attribute-set.umd.cjs

@@ -0,0 +1 @@
+(function(r,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react/jsx-runtime"),require("antd")):typeof define=="function"&&define.amd?define(["exports","react/jsx-runtime","antd"],e):(r=typeof globalThis<"u"?globalThis:r||self,e(r.HdAttributeSet={},r.jsxRuntime,r.antd))})(this,function(r,e,s){"use strict";function n({items:d,title:i,column:l=2,bordered:c=!0,emptyText:p="暂无属性"}){return!d||d.length===0?e.jsxs("div",{className:"hd-attribute-set",children:[i&&e.jsxs(e.Fragment,{children:[e.jsx("div",{className:"hd-attribute-set__title",children:i}),e.jsx(s.Divider,{style:{margin:"8px 0 16px"}})]}),e.jsx(s.Empty,{image:s.Empty.PRESENTED_IMAGE_SIMPLE,description:p})]}):e.jsxs("div",{className:"hd-attribute-set",children:[i&&e.jsxs(e.Fragment,{children:[e.jsx("div",{className:"hd-attribute-set__title",children:i}),e.jsx(s.Divider,{style:{margin:"8px 0 16px"}})]}),e.jsx(s.Descriptions,{size:"small",column:l,bordered:c,items:d.map(t=>({key:t.key,label:t.label,children:t.render?t.render(t.value):t.value??"-",span:t.span}))})]})}const a="0.1.0";r.AttributeSet=n,r.version=a,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})});

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components/attribute-set';
+export declare const version: string;

package/package.json

@@ -1,6 +1,69 @@
-{
-  "name": "hd-attribute-set",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "hd-attribute-set",
+  "version": "0.1.0",
+  "description": "属性集组件库，基于 React + antd",
+  "keywords": [
+    "react",
+    "component",
+    "antd",
+    "attribute-set"
+  ],
+  "license": "MIT",
+  "author": "szldjd",
+  "repository": {
+    "type": "git",
+    "url": "https://cnb.cool/szldjd/fee/hd-attribute-set"
+  },
+  "bugs": {
+    "url": "https://cnb.cool/szldjd/fee/hd-attribute-set/-/issues"
+  },
+  "homepage": "https://cnb.cool/szldjd/fee/hd-attribute-set",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "type": "module",
+  "sideEffects": [
+    "**/*.css",
+    "**/*.less"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "dist/hd-attribute-set.umd.cjs",
+  "module": "dist/hd-attribute-set.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/hd-attribute-set.js",
+      "require": "./dist/hd-attribute-set.umd.cjs"
+    },
+    "./dist/*": "./dist/*",
+    "./dist/hd-attribute-set.css": "./dist/hd-attribute-set.css"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc --noEmit && vite build",
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "antd": ">=5.0.0",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.3.0",
+    "antd": "^5.21.0",
+    "less": "^4.2.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
+    "typescript": "^5.5.0",
+    "vite": "^5.4.0",
+    "vite-plugin-dts": "^4.2.0"
+  }
+}