@blueking/bkui-knowledge 0.0.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +316 -0
- package/bin/bkui-knowledge.js +321 -0
- package/knowledge/component-apis/affix.json +41 -0
- package/knowledge/component-apis/alert.json +63 -0
- package/knowledge/component-apis/animate-number.json +24 -0
- package/knowledge/component-apis/backtop.json +39 -0
- package/knowledge/component-apis/badge.json +70 -0
- package/knowledge/component-apis/breadcrumb.json +41 -0
- package/knowledge/component-apis/button.json +87 -0
- package/knowledge/component-apis/card.json +62 -0
- package/knowledge/component-apis/cascader.json +92 -0
- package/knowledge/component-apis/checkbox.json +103 -0
- package/knowledge/component-apis/code-diff.json +43 -0
- package/knowledge/component-apis/collapse.json +96 -0
- package/knowledge/component-apis/color-picker.json +60 -0
- package/knowledge/component-apis/config-provider.json +29 -0
- package/knowledge/component-apis/container.json +59 -0
- package/knowledge/component-apis/date-picker.json +84 -0
- package/knowledge/component-apis/dialog.json +124 -0
- package/knowledge/component-apis/divider.json +39 -0
- package/knowledge/component-apis/dropdown.json +60 -0
- package/knowledge/component-apis/exception.json +43 -0
- package/knowledge/component-apis/fixed-navbar.json +43 -0
- package/knowledge/component-apis/form.json +56 -0
- package/knowledge/component-apis/image.json +73 -0
- package/knowledge/component-apis/info-box.json +75 -0
- package/knowledge/component-apis/input.json +146 -0
- package/knowledge/component-apis/link.json +46 -0
- package/knowledge/component-apis/loading.json +48 -0
- package/knowledge/component-apis/menu.json +108 -0
- package/knowledge/component-apis/message.json +47 -0
- package/knowledge/component-apis/navigation.json +143 -0
- package/knowledge/component-apis/notify.json +57 -0
- package/knowledge/component-apis/overflow-title.json +38 -0
- package/knowledge/component-apis/pagination.json +98 -0
- package/knowledge/component-apis/pop-confirm.json +79 -0
- package/knowledge/component-apis/popover.json +73 -0
- package/knowledge/component-apis/process.json +55 -0
- package/knowledge/component-apis/progress.json +74 -0
- package/knowledge/component-apis/radio.json +79 -0
- package/knowledge/component-apis/rate.json +38 -0
- package/knowledge/component-apis/resize-layout.json +72 -0
- package/knowledge/component-apis/scrollbar.json +73 -0
- package/knowledge/component-apis/search-select.json +74 -0
- package/knowledge/component-apis/select.json +146 -0
- package/knowledge/component-apis/sideslider.json +80 -0
- package/knowledge/component-apis/slider.json +93 -0
- package/knowledge/component-apis/steps.json +51 -0
- package/knowledge/component-apis/swiper.json +51 -0
- package/knowledge/component-apis/switcher.json +93 -0
- package/knowledge/component-apis/tab.json +116 -0
- package/knowledge/component-apis/table.json +215 -0
- package/knowledge/component-apis/tag-input.json +110 -0
- package/knowledge/component-apis/tag.json +89 -0
- package/knowledge/component-apis/time-picker.json +63 -0
- package/knowledge/component-apis/timeline.json +42 -0
- package/knowledge/component-apis/transfer.json +78 -0
- package/knowledge/component-apis/tree.json +98 -0
- package/knowledge/component-apis/upload.json +103 -0
- package/knowledge/component-apis/virtual-render.json +71 -0
- package/knowledge/examples/404.tsx +33 -0
- package/knowledge/examples/affix/demo/affix-bottom.vue +6 -0
- package/knowledge/examples/affix/demo/affix-callback.vue +17 -0
- package/knowledge/examples/affix/demo/affix-container.vue +26 -0
- package/knowledge/examples/affix/demo/affix-top.vue +6 -0
- package/knowledge/examples/affix/demo/affix-z-index.vue +9 -0
- package/knowledge/examples/affix/demo/affix.vue +6 -0
- package/knowledge/examples/affix/index.tsx +165 -0
- package/knowledge/examples/alert/demo/alert-close-text.vue +38 -0
- package/knowledge/examples/alert/demo/alert-close.vue +30 -0
- package/knowledge/examples/alert/demo/alert-show-icon.vue +30 -0
- package/knowledge/examples/alert/demo/alert.vue +26 -0
- package/knowledge/examples/alert/index.tsx +171 -0
- package/knowledge/examples/animate-number/base-demo.vue +17 -0
- package/knowledge/examples/animate-number/index.tsx +80 -0
- package/knowledge/examples/backtop/base-demo.vue +4 -0
- package/knowledge/examples/backtop/index.tsx +102 -0
- package/knowledge/examples/badge/badge-demo.vue +63 -0
- package/knowledge/examples/badge/badge-dot.vue +27 -0
- package/knowledge/examples/badge/badge.vue +34 -0
- package/knowledge/examples/badge/index.tsx +191 -0
- package/knowledge/examples/blueking/crontab/demo/base.vue +7 -0
- package/knowledge/examples/blueking/crontab/index.tsx +82 -0
- package/knowledge/examples/blueking/date-picker/base-demo.vue +11 -0
- package/knowledge/examples/blueking/date-picker/baseline-time-demo.vue +39 -0
- package/knowledge/examples/blueking/date-picker/index.tsx +272 -0
- package/knowledge/examples/blueking/date-picker/simple-demo.vue +14 -0
- package/knowledge/examples/blueking/date-picker/time-demo.vue +39 -0
- package/knowledge/examples/blueking/date-picker/timezone-demo.vue +15 -0
- package/knowledge/examples/blueking/date-picker/validate-demo.vue +67 -0
- package/knowledge/examples/blueking/ediatable/base-config-demo.vue +97 -0
- package/knowledge/examples/blueking/ediatable/base-demo.vue +106 -0
- package/knowledge/examples/blueking/ediatable/components/cluster-name.vue +62 -0
- package/knowledge/examples/blueking/ediatable/components/regex-keys.vue +71 -0
- package/knowledge/examples/blueking/ediatable/components/render-row.vue +152 -0
- package/knowledge/examples/blueking/ediatable/components/switch-mode.vue +68 -0
- package/knowledge/examples/blueking/ediatable/components/target-datetime.vue +74 -0
- package/knowledge/examples/blueking/ediatable/components/target-number.vue +59 -0
- package/knowledge/examples/blueking/ediatable/datetime-picker-column-demo.vue +63 -0
- package/knowledge/examples/blueking/ediatable/index.tsx +400 -0
- package/knowledge/examples/blueking/ediatable/input-column-demo.vue +54 -0
- package/knowledge/examples/blueking/ediatable/select-column-demo.vue +67 -0
- package/knowledge/examples/blueking/ediatable/tag-input-column.vue +54 -0
- package/knowledge/examples/blueking/ediatable/text-plain-column-demo.vue +64 -0
- package/knowledge/examples/blueking/functional-deps/base-demo.vue +19 -0
- package/knowledge/examples/blueking/functional-deps/dialog-demo.vue +29 -0
- package/knowledge/examples/blueking/functional-deps/index.tsx +146 -0
- package/knowledge/examples/blueking/functional-deps/partial-demo.vue +19 -0
- package/knowledge/examples/blueking/log-search/base-demo.vue +36 -0
- package/knowledge/examples/blueking/log-search/index.tsx +102 -0
- package/knowledge/examples/blueking/log-search/module-combina-demo.vue +39 -0
- package/knowledge/examples/blueking/release-note/async-loading-demo.vue +40 -0
- package/knowledge/examples/blueking/release-note/base-demo.vue +23 -0
- package/knowledge/examples/blueking/release-note/index.tsx +208 -0
- package/knowledge/examples/blueking/release-note/release-note.vue +497 -0
- package/knowledge/examples/blueking/release-note/slot-demo.vue +21 -0
- package/knowledge/examples/blueking/status-tag/base-demo.vue +91 -0
- package/knowledge/examples/blueking/status-tag/custom-color-demo.vue +109 -0
- package/knowledge/examples/blueking/status-tag/i18n-demo.vue +148 -0
- package/knowledge/examples/blueking/status-tag/index.tsx +180 -0
- package/knowledge/examples/blueking/status-tag/installation-demo.vue +94 -0
- package/knowledge/examples/blueking/status-tag/type-demo.vue +132 -0
- package/knowledge/examples/breadcrumb/base-demo.vue +37 -0
- package/knowledge/examples/breadcrumb/index.tsx +215 -0
- package/knowledge/examples/breadcrumb/prefix-demo.vue +59 -0
- package/knowledge/examples/breadcrumb/separator-demo.vue +63 -0
- package/knowledge/examples/button/demo/basic.vue +21 -0
- package/knowledge/examples/button/demo/disabled.vue +17 -0
- package/knowledge/examples/button/demo/group.vue +141 -0
- package/knowledge/examples/button/demo/icon.vue +73 -0
- package/knowledge/examples/button/demo/loading-button.vue +31 -0
- package/knowledge/examples/button/demo/mouse-hover.vue +29 -0
- package/knowledge/examples/button/demo/outline.vue +18 -0
- package/knowledge/examples/button/demo/size.vue +139 -0
- package/knowledge/examples/button/demo/text.vue +36 -0
- package/knowledge/examples/button/index.tsx +210 -0
- package/knowledge/examples/card/card-demo.vue +89 -0
- package/knowledge/examples/card/card-edit.vue +68 -0
- package/knowledge/examples/card/index.tsx +197 -0
- package/knowledge/examples/cascader/base-demo.vue +87 -0
- package/knowledge/examples/cascader/check-any-level-demo.vue +87 -0
- package/knowledge/examples/cascader/checkbox-demo.vue +97 -0
- package/knowledge/examples/cascader/custom-fillback.vue +53 -0
- package/knowledge/examples/cascader/custom-trigger-demo.vue +83 -0
- package/knowledge/examples/cascader/extension-demo.vue +284 -0
- package/knowledge/examples/cascader/id-key.vue +166 -0
- package/knowledge/examples/cascader/index.tsx +424 -0
- package/knowledge/examples/cascader/multiple-toggle-demo.vue +81 -0
- package/knowledge/examples/cascader/panel-slot-demo.vue +81 -0
- package/knowledge/examples/cascader/remote-demo.vue +44 -0
- package/knowledge/examples/cascader/separator-demo.vue +66 -0
- package/knowledge/examples/cascader/show-complete-name.vue +69 -0
- package/knowledge/examples/cascader/slots-demo.vue +117 -0
- package/knowledge/examples/cascader.tsx +102 -0
- package/knowledge/examples/checkbox/demo/checkbox-checked.vue +18 -0
- package/knowledge/examples/checkbox/demo/checkbox-disabled.vue +18 -0
- package/knowledge/examples/checkbox/demo/checkbox-group.vue +15 -0
- package/knowledge/examples/checkbox/demo/checkbox-indeterminate.vue +10 -0
- package/knowledge/examples/checkbox/demo/checkbox-prechecked.vue +26 -0
- package/knowledge/examples/checkbox/demo/checkbox.vue +10 -0
- package/knowledge/examples/checkbox/index.tsx +239 -0
- package/knowledge/examples/code-diff/demo/basic.vue +87 -0
- package/knowledge/examples/code-diff/demo/demo.ts +111 -0
- package/knowledge/examples/code-diff/demo/diff-context.vue +93 -0
- package/knowledge/examples/code-diff/demo/format.vue +94 -0
- package/knowledge/examples/code-diff/demo/theme.vue +96 -0
- package/knowledge/examples/code-diff/index.tsx +171 -0
- package/knowledge/examples/collapse/demo/collapse-accordion.vue +32 -0
- package/knowledge/examples/collapse/demo/collapse-block.vue +30 -0
- package/knowledge/examples/collapse/demo/collapse-card.vue +30 -0
- package/knowledge/examples/collapse/demo/collapse-click.vue +38 -0
- package/knowledge/examples/collapse/demo/collapse-disabled.vue +34 -0
- package/knowledge/examples/collapse/demo/collapse-enter-leave.vue +38 -0
- package/knowledge/examples/collapse/demo/collapse-icon-align.vue +32 -0
- package/knowledge/examples/collapse/demo/collapse-icon.vue +31 -0
- package/knowledge/examples/collapse/demo/collapse-jsx.tsx +77 -0
- package/knowledge/examples/collapse/demo/collapse-line.vue +31 -0
- package/knowledge/examples/collapse/demo/collapse-panel.vue +43 -0
- package/knowledge/examples/collapse/demo/collapse-single.vue +13 -0
- package/knowledge/examples/collapse/demo/collapse-slot.vue +33 -0
- package/knowledge/examples/collapse/demo/collapse-title.vue +33 -0
- package/knowledge/examples/collapse/demo/collapse.vue +30 -0
- package/knowledge/examples/collapse/index.tsx +473 -0
- package/knowledge/examples/collapse.tsx +68 -0
- package/knowledge/examples/color-picker/base-demo.vue +34 -0
- package/knowledge/examples/color-picker/color-picker.tsx +200 -0
- package/knowledge/examples/color-picker/preset-demo.vue +25 -0
- package/knowledge/examples/color-picker/size-demo.vue +29 -0
- package/knowledge/examples/color-picker/slot-demo.vue +34 -0
- package/knowledge/examples/container/demo/all.vue +152 -0
- package/knowledge/examples/container/demo/base.vue +111 -0
- package/knowledge/examples/container/demo/custom-col.vue +78 -0
- package/knowledge/examples/container/demo/custom-gutter.vue +86 -0
- package/knowledge/examples/container/demo/custom-push-pull.vue +90 -0
- package/knowledge/examples/container/demo/flex.vue +63 -0
- package/knowledge/examples/container/index.tsx +209 -0
- package/knowledge/examples/date-picker/base-demo.vue +19 -0
- package/knowledge/examples/date-picker/demo-tsx.tsx +49 -0
- package/knowledge/examples/date-picker/footer-slot-demo.vue +26 -0
- package/knowledge/examples/date-picker/header-slot-demo.vue +26 -0
- package/knowledge/examples/date-picker/index.tsx +436 -0
- package/knowledge/examples/date-picker/month-range-demo.vue +33 -0
- package/knowledge/examples/date-picker/range-demo.vue +50 -0
- package/knowledge/examples/date-picker/shortcuts-slot-demo.vue +157 -0
- package/knowledge/examples/date-picker/trigger-slot-demo.vue +149 -0
- package/knowledge/examples/date-picker/with-time-demo.vue +44 -0
- package/knowledge/examples/date-picker/year-month-demo.vue +33 -0
- package/knowledge/examples/date-picker/year-range-demo.vue +33 -0
- package/knowledge/examples/dialog/base-demo.vue +52 -0
- package/knowledge/examples/dialog/before-close-demo.vue +47 -0
- package/knowledge/examples/dialog/fullscreen-demo.vue +66 -0
- package/knowledge/examples/dialog/index.tsx +338 -0
- package/knowledge/examples/dialog/mask-demo.vue +27 -0
- package/knowledge/examples/dialog/nested-demo.vue +76 -0
- package/knowledge/examples/divider/base-demo.vue +14 -0
- package/knowledge/examples/divider/divider.tsx +117 -0
- package/knowledge/examples/dropdown/align-demo.vue +46 -0
- package/knowledge/examples/dropdown/base-demo.vue +36 -0
- package/knowledge/examples/dropdown/boundary-body-demo.vue +34 -0
- package/knowledge/examples/dropdown/disabled-demo.vue +45 -0
- package/knowledge/examples/dropdown/dropdown-methods-demo.vue +35 -0
- package/knowledge/examples/dropdown/dropdown.tsx +246 -0
- package/knowledge/examples/dropdown/hide-ignore-reference.vue +37 -0
- package/knowledge/examples/dropdown/is-show-demo.vue +39 -0
- package/knowledge/examples/dropdown/trigger-demo.vue +30 -0
- package/knowledge/examples/dropdown.tsx +164 -0
- package/knowledge/examples/exception/base-demo.vue +63 -0
- package/knowledge/examples/exception/exception.tsx +98 -0
- package/knowledge/examples/exception/part-demo.vue +80 -0
- package/knowledge/examples/exception.tsx +147 -0
- package/knowledge/examples/fixed-navbar/base-demo.vue +29 -0
- package/knowledge/examples/fixed-navbar/index.tsx +151 -0
- package/knowledge/examples/form/demo/compose-form-item.vue +46 -0
- package/knowledge/examples/form/demo/form-description.vue +63 -0
- package/knowledge/examples/form/demo/form-validator.vue +115 -0
- package/knowledge/examples/form/demo/form-vertical.vue +60 -0
- package/knowledge/examples/form/demo/form.vue +94 -0
- package/knowledge/examples/form/index.tsx +383 -0
- package/knowledge/examples/home.tsx +36 -0
- package/knowledge/examples/icon/base-demo.vue +93 -0
- package/knowledge/examples/icon/import-demo.vue +12 -0
- package/knowledge/examples/icon/index.tsx +90 -0
- package/knowledge/examples/info-box/align-demo.vue +30 -0
- package/knowledge/examples/info-box/base-demo.vue +35 -0
- package/knowledge/examples/info-box/button-text-demo.vue +25 -0
- package/knowledge/examples/info-box/callback-demo.vue +27 -0
- package/knowledge/examples/info-box/index.tsx +272 -0
- package/knowledge/examples/info-box/status-demo.vue +81 -0
- package/knowledge/examples/input/demo/autosize.vue +68 -0
- package/knowledge/examples/input/demo/basic.vue +19 -0
- package/knowledge/examples/input/demo/clearable.vue +15 -0
- package/knowledge/examples/input/demo/combine.vue +86 -0
- package/knowledge/examples/input/demo/event-callback.vue +19 -0
- package/knowledge/examples/input/demo/hover-clear.vue +13 -0
- package/knowledge/examples/input/demo/icon.vue +41 -0
- package/knowledge/examples/input/demo/max-length.vue +38 -0
- package/knowledge/examples/input/demo/native-attrs.vue +27 -0
- package/knowledge/examples/input/demo/number.vue +54 -0
- package/knowledge/examples/input/demo/password.vue +13 -0
- package/knowledge/examples/input/demo/simple.vue +13 -0
- package/knowledge/examples/input/demo/size.vue +52 -0
- package/knowledge/examples/input/demo/status.vue +23 -0
- package/knowledge/examples/input/demo/textarea.vue +31 -0
- package/knowledge/examples/input/index.tsx +587 -0
- package/knowledge/examples/link/base-demo.vue +31 -0
- package/knowledge/examples/link/disable-demo.vue +35 -0
- package/knowledge/examples/link/icon-demo.vue +23 -0
- package/knowledge/examples/link/index.tsx +120 -0
- package/knowledge/examples/loading/demo/basic.vue +15 -0
- package/knowledge/examples/loading/demo/directive.vue +52 -0
- package/knowledge/examples/loading/demo/mask.vue +26 -0
- package/knowledge/examples/loading/demo/mode.vue +31 -0
- package/knowledge/examples/loading/demo/size.vue +28 -0
- package/knowledge/examples/loading/demo/theme.vue +30 -0
- package/knowledge/examples/loading/demo/title.vue +22 -0
- package/knowledge/examples/loading/index.tsx +187 -0
- package/knowledge/examples/menu/base-demo.vue +62 -0
- package/knowledge/examples/menu/index.tsx +224 -0
- package/knowledge/examples/message/base-demo.vue +16 -0
- package/knowledge/examples/message/close-demo.vue +34 -0
- package/knowledge/examples/message/message.tsx +337 -0
- package/knowledge/examples/message/multi-demo.vue +135 -0
- package/knowledge/examples/message/theme-demo.vue +59 -0
- package/knowledge/examples/navigation/base-demo.vue +117 -0
- package/knowledge/examples/navigation/index.tsx +175 -0
- package/knowledge/examples/navigation/theme-demo.vue +124 -0
- package/knowledge/examples/notify/demo/base.vue +37 -0
- package/knowledge/examples/notify/demo/close.vue +42 -0
- package/knowledge/examples/notify/demo/position.vue +55 -0
- package/knowledge/examples/notify/demo/theme.vue +45 -0
- package/knowledge/examples/notify/index.tsx +177 -0
- package/knowledge/examples/overflow-title/base-demo.vue +15 -0
- package/knowledge/examples/overflow-title/directive.vue +21 -0
- package/knowledge/examples/overflow-title/index.tsx +153 -0
- package/knowledge/examples/pagination/demo/pagination-small.vue +16 -0
- package/knowledge/examples/pagination/demo/pagination.vue +16 -0
- package/knowledge/examples/pagination/index.tsx +193 -0
- package/knowledge/examples/pop-components.tsx +151 -0
- package/knowledge/examples/pop-confirm/demo-base.vue +42 -0
- package/knowledge/examples/pop-confirm/demo-icon.vue +27 -0
- package/knowledge/examples/pop-confirm/demo-select.vue +44 -0
- package/knowledge/examples/pop-confirm/demo-simple.vue +27 -0
- package/knowledge/examples/pop-confirm/demo-slot.vue +27 -0
- package/knowledge/examples/pop-confirm/hide-ignore-reference.vue +45 -0
- package/knowledge/examples/pop-confirm/index.tsx +266 -0
- package/knowledge/examples/popover/demo/always.vue +12 -0
- package/knowledge/examples/popover/demo/base.vue +34 -0
- package/knowledge/examples/popover/demo/callback.vue +28 -0
- package/knowledge/examples/popover/demo/hide-ignore-reference.vue +9 -0
- package/knowledge/examples/popover/demo/manual-trigger.vue +43 -0
- package/knowledge/examples/popover/demo/mouse-event.vue +48 -0
- package/knowledge/examples/popover/demo/position.vue +165 -0
- package/knowledge/examples/popover/demo/slot.vue +20 -0
- package/knowledge/examples/popover/index.tsx +425 -0
- package/knowledge/examples/process/base-demo.vue +32 -0
- package/knowledge/examples/process/index.tsx +141 -0
- package/knowledge/examples/process/loading-demo.vue +30 -0
- package/knowledge/examples/process/status-demo.vue +42 -0
- package/knowledge/examples/process.tsx +65 -0
- package/knowledge/examples/progress/base-demo.vue +52 -0
- package/knowledge/examples/progress/change-demo.vue +43 -0
- package/knowledge/examples/progress/index.tsx +253 -0
- package/knowledge/examples/progress/size-demo.vue +100 -0
- package/knowledge/examples/progress/text-demo.vue +51 -0
- package/knowledge/examples/progress/type-demo.vue +44 -0
- package/knowledge/examples/progress/type-size-demo.vue +69 -0
- package/knowledge/examples/radio/demo/radio-button.vue +12 -0
- package/knowledge/examples/radio/demo/radio-card.vue +15 -0
- package/knowledge/examples/radio/demo/radio-checked.vue +11 -0
- package/knowledge/examples/radio/demo/radio-disabled.vue +16 -0
- package/knowledge/examples/radio/demo/radio-group-capsule.vue +17 -0
- package/knowledge/examples/radio/demo/radio-group.vue +41 -0
- package/knowledge/examples/radio/demo/radio.vue +45 -0
- package/knowledge/examples/radio/index.tsx +300 -0
- package/knowledge/examples/rate/base-demo.vue +11 -0
- package/knowledge/examples/rate/edit-demo.vue +16 -0
- package/knowledge/examples/rate/index.tsx +140 -0
- package/knowledge/examples/rate/size-demo.vue +19 -0
- package/knowledge/examples/resize-layout/advance-demo.vue +52 -0
- package/knowledge/examples/resize-layout/auto-minimize-demo.vue +16 -0
- package/knowledge/examples/resize-layout/base-demo.vue +28 -0
- package/knowledge/examples/resize-layout/collapsible-demo.vue +16 -0
- package/knowledge/examples/resize-layout/immediate-demo.vue +18 -0
- package/knowledge/examples/resize-layout/resize-layout.tsx +251 -0
- package/knowledge/examples/search-select/base-demo.vue +152 -0
- package/knowledge/examples/search-select/comprehensive-use.vue +133 -0
- package/knowledge/examples/search-select/index.tsx +352 -0
- package/knowledge/examples/search-select/menu-demo.vue +134 -0
- package/knowledge/examples/search-select/placeholder-demo.vue +75 -0
- package/knowledge/examples/search-select/remote-demo.vue +82 -0
- package/knowledge/examples/search-select/validate-demo.vue +99 -0
- package/knowledge/examples/search-select/value-behavior.vue +56 -0
- package/knowledge/examples/select/select-allow-create.vue +95 -0
- package/knowledge/examples/select/select-base-demo.vue +116 -0
- package/knowledge/examples/select/select-group-demo.vue +88 -0
- package/knowledge/examples/select/select-multi-demo.vue +140 -0
- package/knowledge/examples/select/select-scrollloading-demo.vue +68 -0
- package/knowledge/examples/select/select-search-demo.vue +151 -0
- package/knowledge/examples/select/select-slot-demo.vue +226 -0
- package/knowledge/examples/select/select-style-demo.vue +119 -0
- package/knowledge/examples/select/select-tree-demo.vue +130 -0
- package/knowledge/examples/select/select-trigger-demo.vue +74 -0
- package/knowledge/examples/select/select-virtual-render.vue +51 -0
- package/knowledge/examples/select/select.tsx +697 -0
- package/knowledge/examples/sideslider/base-demo.vue +28 -0
- package/knowledge/examples/sideslider/before-close-demo.vue +40 -0
- package/knowledge/examples/sideslider/direction-demo.vue +52 -0
- package/knowledge/examples/sideslider/footer-demo.vue +45 -0
- package/knowledge/examples/sideslider/index.tsx +248 -0
- package/knowledge/examples/sideslider/sideslider.tsx +104 -0
- package/knowledge/examples/sideslider/title-demo.vue +29 -0
- package/knowledge/examples/slider/base-demo.vue +49 -0
- package/knowledge/examples/slider/custom-demo.vue +57 -0
- package/knowledge/examples/slider/input-demo.vue +45 -0
- package/knowledge/examples/slider/slider.tsx +295 -0
- package/knowledge/examples/slider/step-demo.vue +70 -0
- package/knowledge/examples/slider/vertical-demo.vue +33 -0
- package/knowledge/examples/slider.tsx +143 -0
- package/knowledge/examples/start/index.tsx +42 -0
- package/knowledge/examples/start/start.md +86 -0
- package/knowledge/examples/steps/base-demo.vue +8 -0
- package/knowledge/examples/steps/controllable-demo.vue +32 -0
- package/knowledge/examples/steps/custom-demo.vue +45 -0
- package/knowledge/examples/steps/direction-demo.vue +28 -0
- package/knowledge/examples/steps/index.tsx +206 -0
- package/knowledge/examples/steps/size-demo.vue +5 -0
- package/knowledge/examples/steps/status-demo.vue +20 -0
- package/knowledge/examples/steps/theme-demo.vue +25 -0
- package/knowledge/examples/steps.tsx +107 -0
- package/knowledge/examples/swiper/base-demo.vue +24 -0
- package/knowledge/examples/swiper/index.tsx +135 -0
- package/knowledge/examples/swiper/slot-demo.vue +18 -0
- package/knowledge/examples/switcher/base-demo.vue +33 -0
- package/knowledge/examples/switcher/before-change-demo.vue +35 -0
- package/knowledge/examples/switcher/disabled-demo.vue +67 -0
- package/knowledge/examples/switcher/index.tsx +261 -0
- package/knowledge/examples/switcher/size-demo.vue +43 -0
- package/knowledge/examples/switcher/text-demo.vue +46 -0
- package/knowledge/examples/switcher/theme-demo.vue +36 -0
- package/knowledge/examples/switcher/type-demo.vue +173 -0
- package/knowledge/examples/tab/demo-add.vue +48 -0
- package/knowledge/examples/tab/demo-base.vue +36 -0
- package/knowledge/examples/tab/demo-border-card.vue +29 -0
- package/knowledge/examples/tab/demo-card-grid.vue +29 -0
- package/knowledge/examples/tab/demo-card-tab.vue +29 -0
- package/knowledge/examples/tab/demo-card.vue +41 -0
- package/knowledge/examples/tab/demo-drag.vue +30 -0
- package/knowledge/examples/tab/demo-extend.vue +58 -0
- package/knowledge/examples/tab/demo-jsx.tsx +196 -0
- package/knowledge/examples/tab/demo-number.vue +95 -0
- package/knowledge/examples/tab/demo-position.vue +46 -0
- package/knowledge/examples/tab/index.tsx +334 -0
- package/knowledge/examples/table/basic-filter.vue +130 -0
- package/knowledge/examples/table/basic-sort-behavior.vue +62 -0
- package/knowledge/examples/table/basic-sort.vue +64 -0
- package/knowledge/examples/table/basic-span.vue +70 -0
- package/knowledge/examples/table/basic.tsx +323 -0
- package/knowledge/examples/table/basic.vue +229 -0
- package/knowledge/examples/table/bordered.vue +34 -0
- package/knowledge/examples/table/btn-demo.vue +20 -0
- package/knowledge/examples/table/cell-render.tsx +68 -0
- package/knowledge/examples/table/col-wrapper.vue +10 -0
- package/knowledge/examples/table/column-template-index.vue +66 -0
- package/knowledge/examples/table/column-template.tsx +63 -0
- package/knowledge/examples/table/column-template.vue +129 -0
- package/knowledge/examples/table/config.ts +831 -0
- package/knowledge/examples/table/custom-head.vue +63 -0
- package/knowledge/examples/table/data-empty-cell.vue +130 -0
- package/knowledge/examples/table/data-empty.vue +53 -0
- package/knowledge/examples/table/event.vue +40 -0
- package/knowledge/examples/table/expand.vue +67 -0
- package/knowledge/examples/table/filter-scope.vue +59 -0
- package/knowledge/examples/table/fixed.vue +24 -0
- package/knowledge/examples/table/flex-layout.vue +46 -0
- package/knowledge/examples/table/index.tsx +495 -0
- package/knowledge/examples/table/multi-header.vue +218 -0
- package/knowledge/examples/table/options.tsx +385 -0
- package/knowledge/examples/table/pagination.vue +31 -0
- package/knowledge/examples/table/remotePagination.vue +54 -0
- package/knowledge/examples/table/scroll-horizontal.vue +45 -0
- package/knowledge/examples/table/scroll-loading-slot.vue +56 -0
- package/knowledge/examples/table/scroll-loading.vue +65 -0
- package/knowledge/examples/table/selection.vue +48 -0
- package/knowledge/examples/table/virtual-render.vue +59 -0
- package/knowledge/examples/tag/base-demo.vue +21 -0
- package/knowledge/examples/tag/check-demo.vue +28 -0
- package/knowledge/examples/tag/closable-demo.vue +21 -0
- package/knowledge/examples/tag/icon-demo.vue +26 -0
- package/knowledge/examples/tag/index.tsx +213 -0
- package/knowledge/examples/tag/radius-demo.vue +29 -0
- package/knowledge/examples/tag/size-demo.vue +42 -0
- package/knowledge/examples/tag/type-demo.vue +71 -0
- package/knowledge/examples/tag-input/base-demo.vue +34 -0
- package/knowledge/examples/tag-input/clear-demo.vue +36 -0
- package/knowledge/examples/tag-input/copy-demo.vue +48 -0
- package/knowledge/examples/tag-input/create-demo.vue +29 -0
- package/knowledge/examples/tag-input/disabled-demo.vue +27 -0
- package/knowledge/examples/tag-input/example-demo.vue +47 -0
- package/knowledge/examples/tag-input/group-demo.vue +45 -0
- package/knowledge/examples/tag-input/index.tsx +438 -0
- package/knowledge/examples/tag-input/list-disabled-demo.vue +27 -0
- package/knowledge/examples/tag-input/match-demo.vue +38 -0
- package/knowledge/examples/tag-input/more-demo.vue +38 -0
- package/knowledge/examples/tag-input/paste-demo.vue +31 -0
- package/knowledge/examples/tag-input/single-demo.vue +62 -0
- package/knowledge/examples/tag-input/tooltips-demo.vue +47 -0
- package/knowledge/examples/tag-input/trigger-demo.vue +28 -0
- package/knowledge/examples/test.tsx +60 -0
- package/knowledge/examples/time-picker/base-demo.vue +8 -0
- package/knowledge/examples/time-picker/index.tsx +296 -0
- package/knowledge/examples/time-picker/range-demo.vue +18 -0
- package/knowledge/examples/timeline/base-demo.vue +50 -0
- package/knowledge/examples/timeline/custom-demo.vue +57 -0
- package/knowledge/examples/timeline/html-demo.vue +41 -0
- package/knowledge/examples/timeline/index.tsx +212 -0
- package/knowledge/examples/timeline/node-demo.vue +45 -0
- package/knowledge/examples/timeline/status-demo.vue +131 -0
- package/knowledge/examples/timeline/vnode-demo.vue +84 -0
- package/knowledge/examples/timeline.tsx +101 -0
- package/knowledge/examples/tooltips/demo/base.tsx +54 -0
- package/knowledge/examples/tooltips/demo/base.vue +42 -0
- package/knowledge/examples/tooltips/demo/boundary.vue +50 -0
- package/knowledge/examples/tooltips/demo/callback.vue +52 -0
- package/knowledge/examples/tooltips/demo/click.vue +42 -0
- package/knowledge/examples/tooltips/demo/position.vue +111 -0
- package/knowledge/examples/tooltips/index.tsx +218 -0
- package/knowledge/examples/transfer/base-demo.vue +47 -0
- package/knowledge/examples/transfer/custom-header-demo.vue +147 -0
- package/knowledge/examples/transfer/custom-option-demo.vue +47 -0
- package/knowledge/examples/transfer/index.tsx +288 -0
- package/knowledge/examples/transfer/multiple-demo.vue +41 -0
- package/knowledge/examples/transfer/normal-list-demo.vue +30 -0
- package/knowledge/examples/transfer/search-demo.vue +152 -0
- package/knowledge/examples/transfer/target-list-demo.vue +46 -0
- package/knowledge/examples/tree/async.vue +119 -0
- package/knowledge/examples/tree/auto-config.vue +65 -0
- package/knowledge/examples/tree/basic.vue +53 -0
- package/knowledge/examples/tree/config.ts +342 -0
- package/knowledge/examples/tree/custom-node.vue +101 -0
- package/knowledge/examples/tree/draggable-function.vue +43 -0
- package/knowledge/examples/tree/draggable.vue +47 -0
- package/knowledge/examples/tree/expand-all.vue +26 -0
- package/knowledge/examples/tree/index.tsx +262 -0
- package/knowledge/examples/tree/level-line.vue +45 -0
- package/knowledge/examples/tree/node-content-action.vue +78 -0
- package/knowledge/examples/tree/options.ts +463 -0
- package/knowledge/examples/tree/prefix-icon-jsx.tsx +76 -0
- package/knowledge/examples/tree/prefix-icon.vue +128 -0
- package/knowledge/examples/tree/search.vue +108 -0
- package/knowledge/examples/tree/selected.vue +98 -0
- package/knowledge/examples/tree/tree.less +14 -0
- package/knowledge/examples/tree/virtual-render.vue +111 -0
- package/knowledge/examples/upload/demo/accept-image.vue +22 -0
- package/knowledge/examples/upload/demo/accept-zip.vue +22 -0
- package/knowledge/examples/upload/demo/base.vue +70 -0
- package/knowledge/examples/upload/demo/limit.vue +34 -0
- package/knowledge/examples/upload/demo/max-size.vue +27 -0
- package/knowledge/examples/upload/demo/preview-image.vue +90 -0
- package/knowledge/examples/upload/demo/single-picture.vue +36 -0
- package/knowledge/examples/upload/demo/slots-file.vue +68 -0
- package/knowledge/examples/upload/demo/theme-button.vue +30 -0
- package/knowledge/examples/upload/demo/theme-picture.vue +36 -0
- package/knowledge/examples/upload/index.tsx +407 -0
- package/knowledge/examples/utils/index.ts +81 -0
- package/knowledge/examples/virtual-render/basic.vue +127 -0
- package/knowledge/examples/virtual-render/custom-line-height.vue +122 -0
- package/knowledge/examples/virtual-render/index.tsx +79 -0
- package/knowledge/examples/virtual-render/scrollbar.vue +130 -0
- package/knowledge/manifest.json +667 -0
- package/knowledge/skills/.template/README.md +38 -0
- package/knowledge/skills/.template/SKILL.md +48 -0
- package/knowledge/skills/.template/assets/.gitkeep +3 -0
- package/knowledge/skills/.template/references/advanced.md +23 -0
- package/knowledge/skills/.template/references/examples.md +19 -0
- package/knowledge/skills/.template/references/troubleshooting.md +27 -0
- package/knowledge/skills/api-standard/SKILL.md +64 -0
- package/knowledge/skills/api-standard/assets/http.ts +121 -0
- package/knowledge/skills/api-standard/references/full-implementation.md +249 -0
- package/knowledge/skills/api-standard/references/protocol-migration.md +51 -0
- package/knowledge/skills/bkui-builder/SKILL.md +57 -0
- package/knowledge/skills/bkui-builder/assets/layouts/admin-layout-dark.vue +371 -0
- package/knowledge/skills/bkui-builder/assets/layouts/admin-layout-left.vue +134 -0
- package/knowledge/skills/bkui-builder/assets/layouts/admin-layout-top.vue +129 -0
- package/knowledge/skills/bkui-builder/assets/pages/dashboard-page.vue +69 -0
- package/knowledge/skills/bkui-builder/assets/pages/detail-page.vue +93 -0
- package/knowledge/skills/bkui-builder/assets/pages/table-page.vue +293 -0
- package/knowledge/skills/bkui-builder/assets/pages/wizard-form.vue +84 -0
- package/knowledge/skills/bkui-builder/references/checklist.md +72 -0
- package/knowledge/skills/bkui-builder/references/code-snippets.md +145 -0
- package/knowledge/skills/bkui-builder/references/visual-mapping.md +190 -0
- package/knowledge/skills/bkui-cheatsheet/SKILL.md +62 -0
- package/knowledge/skills/bkui-cheatsheet/references/complex-components.md +242 -0
- package/knowledge/skills/bundle-optimization/SKILL.md +44 -0
- package/knowledge/skills/bundle-optimization/assets/vite.config.optimization.ts +53 -0
- package/knowledge/skills/code-review/SKILL.md +54 -0
- package/knowledge/skills/code-review/assets/pre-commit-review.sh +69 -0
- package/knowledge/skills/code-review/references/checklist.md +329 -0
- package/knowledge/skills/code-review/references/git-scenarios.md +242 -0
- package/knowledge/skills/code-review/references/report-examples.md +120 -0
- package/knowledge/skills/code-review/references/report-format.md +75 -0
- package/knowledge/skills/code-review/references/scoring-standard.md +69 -0
- package/knowledge/skills/code-review/references/writing-guidelines.md +44 -0
- package/knowledge/skills/js-security-check/SKILL.md +52 -0
- package/knowledge/skills/js-security-check/references/checklist.md +144 -0
- package/knowledge/skills/js-security-check/references/fix-examples.md +289 -0
- package/knowledge/skills/js-security-check/references/report-format.md +140 -0
- package/knowledge/skills/js-security-check/references/scoring-standard.md +67 -0
- package/knowledge/skills/js-security-check/references/security-toolkit.md +354 -0
- package/knowledge/skills/nodejs-security-check/SKILL.md +52 -0
- package/knowledge/skills/nodejs-security-check/references/checklist.md +177 -0
- package/knowledge/skills/nodejs-security-check/references/fix-examples.md +384 -0
- package/knowledge/skills/nodejs-security-check/references/report-format.md +165 -0
- package/knowledge/skills/nodejs-security-check/references/scoring-standard.md +88 -0
- package/knowledge/skills/nodejs-security-check/references/security-toolkit.md +426 -0
- package/knowledge/skills/permission-directive/SKILL.md +51 -0
- package/knowledge/skills/permission-directive/assets/authority-directive.ts +104 -0
- package/knowledge/skills/pinia-setup/SKILL.md +65 -0
- package/knowledge/skills/pinia-setup/assets/store-template.ts +122 -0
- package/knowledge/skills/unit-testing/SKILL.md +71 -0
- package/knowledge/skills/unit-testing/assets/component.spec.ts +153 -0
- package/knowledge/skills/virtual-list/SKILL.md +63 -0
- package/knowledge/skills/virtual-list/assets/VirtualList.vue +123 -0
- package/knowledge/skills/vite-migration/SKILL.md +12 -0
- package/knowledge/skills/vite-migration/scripts/check-migration.js +165 -0
- package/knowledge/skills/vue-composables/SKILL.md +37 -0
- package/knowledge/skills/vue-composables/assets/useTable.ts +138 -0
- package/package.json +26 -0
- package/server/mcp-core.js +636 -0
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
# Git 场景评审指南
|
|
2
|
+
|
|
3
|
+
针对不同的 Git 场景,使用对应的命令和流程进行代码评审。
|
|
4
|
+
|
|
5
|
+
## 分支合并评审 (merge)
|
|
6
|
+
|
|
7
|
+
**使用场景**:在将 feature 分支合并到 main/develop 分支之前,评审所有待合并的代码变更。
|
|
8
|
+
|
|
9
|
+
**命令格式**:
|
|
10
|
+
```bash
|
|
11
|
+
/code-review merge <source-branch> <target-branch>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
**执行流程**:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# 1. 获取待合并的 commits 列表
|
|
18
|
+
git log <target>..<source> --oneline
|
|
19
|
+
|
|
20
|
+
# 2. 获取完整的代码变更差异
|
|
21
|
+
git diff <target>...<source>
|
|
22
|
+
|
|
23
|
+
# 3. 获取变更的文件列表
|
|
24
|
+
git diff <target>...<source> --name-only
|
|
25
|
+
|
|
26
|
+
# 4. 获取变更统计信息
|
|
27
|
+
git diff <target>...<source> --stat
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**检查要点**:
|
|
31
|
+
- 检查所有待合入的 commits 是否符合规范
|
|
32
|
+
- 评估变更范围是否合理(建议单次 PR < 400 行变更)
|
|
33
|
+
- 识别可能的合并冲突风险
|
|
34
|
+
- 确保功能完整性和代码质量
|
|
35
|
+
|
|
36
|
+
## 指定 Commit 评审 (commit)
|
|
37
|
+
|
|
38
|
+
**使用场景**:评审特定 commit 的代码变更,用于检查历史提交或特定修改。
|
|
39
|
+
|
|
40
|
+
**命令格式**:
|
|
41
|
+
```bash
|
|
42
|
+
/code-review commit <commit-id>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**执行流程**:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# 1. 获取 commit 的详细信息和变更内容
|
|
49
|
+
git show <commit-id>
|
|
50
|
+
|
|
51
|
+
# 2. 获取 commit message
|
|
52
|
+
git log -1 --format="%s%n%n%b" <commit-id>
|
|
53
|
+
|
|
54
|
+
# 3. 获取变更的文件列表
|
|
55
|
+
git show <commit-id> --name-only --pretty=format:""
|
|
56
|
+
|
|
57
|
+
# 4. 获取变更统计
|
|
58
|
+
git show <commit-id> --stat
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**检查要点**:
|
|
62
|
+
- Commit message 是否清晰描述了变更内容
|
|
63
|
+
- 变更是否符合单一职责原则
|
|
64
|
+
- 代码质量是否符合规范
|
|
65
|
+
|
|
66
|
+
## 最近提交评审 (last-commit)
|
|
67
|
+
|
|
68
|
+
**使用场景**:快速评审刚刚提交的代码,用于提交后的自查或 review。
|
|
69
|
+
|
|
70
|
+
**命令格式**:
|
|
71
|
+
```bash
|
|
72
|
+
/code-review last-commit
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**执行流程**:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# 1. 获取最近一次 commit 的 ID
|
|
79
|
+
git log -1 --format="%H"
|
|
80
|
+
|
|
81
|
+
# 2. 获取最近 commit 的完整信息
|
|
82
|
+
git show HEAD
|
|
83
|
+
|
|
84
|
+
# 3. 获取变更文件列表
|
|
85
|
+
git show HEAD --name-only --pretty=format:""
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**检查要点**:
|
|
89
|
+
- 与 commit 评审相同
|
|
90
|
+
- 特别关注是否有遗漏的文件或调试代码
|
|
91
|
+
|
|
92
|
+
## 暂存区评审 (staged)
|
|
93
|
+
|
|
94
|
+
**使用场景**:在执行 `git commit` 之前,评审已经 `git add` 的代码变更。适合作为提交前的最后检查。
|
|
95
|
+
|
|
96
|
+
**命令格式**:
|
|
97
|
+
```bash
|
|
98
|
+
/code-review staged
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
**执行流程**:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# 1. 获取暂存区的代码变更
|
|
105
|
+
git diff --cached
|
|
106
|
+
|
|
107
|
+
# 2. 获取暂存区变更的文件列表
|
|
108
|
+
git diff --cached --name-only
|
|
109
|
+
|
|
110
|
+
# 3. 获取暂存区变更统计
|
|
111
|
+
git diff --cached --stat
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**检查要点**:
|
|
115
|
+
- 是否有不应该提交的文件(如 .env、node_modules)
|
|
116
|
+
- 是否有调试代码(console.log、debugger)
|
|
117
|
+
- 代码是否符合规范和最佳实践
|
|
118
|
+
|
|
119
|
+
## 工作区评审 (unstaged)
|
|
120
|
+
|
|
121
|
+
**使用场景**:评审当前工作目录中尚未暂存的代码变更,用于开发过程中的自查。
|
|
122
|
+
|
|
123
|
+
**命令格式**:
|
|
124
|
+
```bash
|
|
125
|
+
/code-review unstaged
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**执行流程**:
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# 1. 获取工作区的代码变更
|
|
132
|
+
git diff
|
|
133
|
+
|
|
134
|
+
# 2. 获取工作区变更的文件列表
|
|
135
|
+
git diff --name-only
|
|
136
|
+
|
|
137
|
+
# 3. 获取工作区变更统计
|
|
138
|
+
git diff --stat
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
**检查要点**:
|
|
142
|
+
- 开发中的代码是否走在正确的方向
|
|
143
|
+
- 是否有明显的设计问题需要调整
|
|
144
|
+
- 及时发现潜在问题,避免返工
|
|
145
|
+
|
|
146
|
+
## 全部变更评审 (changes)
|
|
147
|
+
|
|
148
|
+
**使用场景**:评审所有未提交的代码变更,包括暂存区和工作区的变更。
|
|
149
|
+
|
|
150
|
+
**命令格式**:
|
|
151
|
+
```bash
|
|
152
|
+
/code-review changes
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**执行流程**:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
# 1. 获取 Git 状态
|
|
159
|
+
git status --porcelain
|
|
160
|
+
|
|
161
|
+
# 2. 获取所有变更(staged + unstaged)
|
|
162
|
+
git diff HEAD
|
|
163
|
+
|
|
164
|
+
# 3. 获取所有变更的文件列表
|
|
165
|
+
git diff HEAD --name-only
|
|
166
|
+
|
|
167
|
+
# 4. 获取变更统计
|
|
168
|
+
git diff HEAD --stat
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
**检查要点**:
|
|
172
|
+
- 综合 staged 和 unstaged 的检查要点
|
|
173
|
+
- 确保所有变更都是有意义的
|
|
174
|
+
- 检查是否有遗漏的相关文件
|
|
175
|
+
|
|
176
|
+
## Git 场景通用检查项
|
|
177
|
+
|
|
178
|
+
所有 Git 场景评审都应包含以下通用检查:
|
|
179
|
+
|
|
180
|
+
### 1. 变更范围检查
|
|
181
|
+
- 变更是否聚焦于单一目标
|
|
182
|
+
- 是否存在不相关的修改混入
|
|
183
|
+
|
|
184
|
+
### 2. 文件类型检查
|
|
185
|
+
- 是否有敏感文件(.env, credentials, keys)
|
|
186
|
+
- 是否有应该忽略的文件(node_modules, dist, build)
|
|
187
|
+
|
|
188
|
+
### 3. 代码质量检查
|
|
189
|
+
- 是否有调试代码残留
|
|
190
|
+
- 是否有注释掉的代码块
|
|
191
|
+
- 是否有 TODO/FIXME 需要处理
|
|
192
|
+
|
|
193
|
+
### 4. Commit 规范检查(适用于 merge、commit、last-commit)
|
|
194
|
+
- Commit message 格式是否正确
|
|
195
|
+
- 是否遵循 Conventional Commits 规范
|
|
196
|
+
|
|
197
|
+
## 工作流最佳实践
|
|
198
|
+
|
|
199
|
+
推荐的代码提交工作流:
|
|
200
|
+
|
|
201
|
+
```
|
|
202
|
+
1. 开发完成后,暂存变更
|
|
203
|
+
$ git add <files>
|
|
204
|
+
|
|
205
|
+
2. 运行静态检查
|
|
206
|
+
$ npm run lint
|
|
207
|
+
|
|
208
|
+
3. 在 Cursor 中进行 AI 代码评审
|
|
209
|
+
/code-review staged
|
|
210
|
+
|
|
211
|
+
4. 根据评审意见修复问题
|
|
212
|
+
(修复后重复步骤 1-3)
|
|
213
|
+
|
|
214
|
+
5. 确认无问题后提交
|
|
215
|
+
$ git commit -m "feat: your feature description"
|
|
216
|
+
|
|
217
|
+
6. 推送前进行分支评审(可选)
|
|
218
|
+
/code-review merge feature/xxx main
|
|
219
|
+
$ git push
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## 紧急情况处理
|
|
223
|
+
|
|
224
|
+
### 什么是紧急情况
|
|
225
|
+
|
|
226
|
+
- 允许一个重要的发布继续,而不是回滚
|
|
227
|
+
- 修复一个严重影响生产中用户的 bug
|
|
228
|
+
- 处理一个紧迫的法律问题
|
|
229
|
+
- 关闭一个主要的安全漏洞
|
|
230
|
+
|
|
231
|
+
### 紧急情况下的处理
|
|
232
|
+
|
|
233
|
+
- 审查者应更关心审查的速度和代码的正确性
|
|
234
|
+
- 这些评审应该优先于所有其他代码评审
|
|
235
|
+
- 紧急情况解决后,应再次查看紧急 CL,进行更彻底的检查
|
|
236
|
+
|
|
237
|
+
### 什么不是紧急情况
|
|
238
|
+
|
|
239
|
+
- 想要在本周而不是下周发布(除非确实有严格的发布截止日期)
|
|
240
|
+
- 开发人员花了很长时间开发一个特性
|
|
241
|
+
- 审查人员不在或在另一个时区
|
|
242
|
+
- 今天是周五,想在周末前完成
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# 评审报告示例
|
|
2
|
+
|
|
3
|
+
## Git 场景评审报告 (merge)
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
7
|
+
代码评审报告 - Git 场景
|
|
8
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
9
|
+
|
|
10
|
+
项目: my-frontend
|
|
11
|
+
评审类型: merge review
|
|
12
|
+
评审时间: 2026-01-20 10:30:00
|
|
13
|
+
|
|
14
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
15
|
+
Git 变更信息
|
|
16
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
17
|
+
|
|
18
|
+
评审类型: 分支合并评审 (merge)
|
|
19
|
+
源分支: feature/user-profile
|
|
20
|
+
目标分支: main
|
|
21
|
+
变更文件: 15 个
|
|
22
|
+
新增行数: +342
|
|
23
|
+
删除行数: -128
|
|
24
|
+
涉及 Commits: 5 个
|
|
25
|
+
|
|
26
|
+
Commits 列表:
|
|
27
|
+
- a1b2c3d feat: add user profile component
|
|
28
|
+
- e4f5g6h fix: fix profile image loading
|
|
29
|
+
- i7j8k9l style: update profile styles
|
|
30
|
+
- m0n1o2p test: add profile unit tests
|
|
31
|
+
- q3r4s5t docs: update profile documentation
|
|
32
|
+
|
|
33
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
34
|
+
变更文件列表
|
|
35
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
36
|
+
|
|
37
|
+
📁 src/components/
|
|
38
|
+
├── UserProfile.vue (+120, -30)
|
|
39
|
+
├── ProfileImage.vue (+45, -10)
|
|
40
|
+
└── ProfileSettings.vue (+80, -25)
|
|
41
|
+
|
|
42
|
+
📁 src/utils/
|
|
43
|
+
└── profile-helper.ts (+35, -8)
|
|
44
|
+
|
|
45
|
+
📁 src/tests/
|
|
46
|
+
└── UserProfile.spec.ts (+62, -55)
|
|
47
|
+
|
|
48
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
49
|
+
Git 规范检查
|
|
50
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
51
|
+
|
|
52
|
+
✅ GIT-001: Commit message 格式正确
|
|
53
|
+
✅ GIT-002: 变更范围合理 (342 行 < 400 行)
|
|
54
|
+
✅ GIT-003: 未发现潜在合并冲突
|
|
55
|
+
✅ GIT-004: 未发现敏感信息
|
|
56
|
+
⚠️ GIT-005: 发现 1 处调试代码
|
|
57
|
+
文件: src/components/UserProfile.vue:85
|
|
58
|
+
代码: console.log('debug:', userData);
|
|
59
|
+
✅ GIT-006: Commits 遵循单一职责原则
|
|
60
|
+
|
|
61
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
62
|
+
评审结论
|
|
63
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
64
|
+
|
|
65
|
+
📋 结论: 需要小修改
|
|
66
|
+
|
|
67
|
+
🔴 必须修改: 0 个问题
|
|
68
|
+
🟡 建议修改: 2 个问题
|
|
69
|
+
⚪ 可选优化: 3 个 Nit
|
|
70
|
+
⚠️ Git 规范: 1 个警告
|
|
71
|
+
|
|
72
|
+
📊 代码质量评分: 82/100
|
|
73
|
+
|
|
74
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
75
|
+
下一步行动
|
|
76
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
77
|
+
|
|
78
|
+
1. 移除调试代码 (console.log)
|
|
79
|
+
2. 处理 2 个建议修改的问题
|
|
80
|
+
3. 可选:处理 3 个 Nit 优化建议
|
|
81
|
+
4. 修复完成后可安全合并到 main 分支
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## 暂存区评审报告 (staged)
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
88
|
+
Pre-commit 代码评审报告
|
|
89
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
90
|
+
|
|
91
|
+
项目: my-frontend
|
|
92
|
+
评审类型: staged (暂存区)
|
|
93
|
+
评审时间: 2026-01-20 15:45:00
|
|
94
|
+
|
|
95
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
96
|
+
暂存区变更
|
|
97
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
98
|
+
|
|
99
|
+
变更文件: 3 个
|
|
100
|
+
新增行数: +45
|
|
101
|
+
删除行数: -12
|
|
102
|
+
|
|
103
|
+
变更文件列表:
|
|
104
|
+
M src/components/Header.vue (+25, -8)
|
|
105
|
+
M src/utils/format.ts (+15, -4)
|
|
106
|
+
A src/components/NewFeature.vue (+5, -0)
|
|
107
|
+
|
|
108
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
109
|
+
提交前检查
|
|
110
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
111
|
+
|
|
112
|
+
✅ 无敏感文件
|
|
113
|
+
✅ 无调试代码
|
|
114
|
+
✅ 变更范围合理
|
|
115
|
+
✅ 代码规范检查通过
|
|
116
|
+
|
|
117
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
118
|
+
评审结论: ✅ LGTM - 可以提交
|
|
119
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
120
|
+
```
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# 评审报告格式说明
|
|
2
|
+
|
|
3
|
+
评审报告采用结构化格式,便于快速理解和处理。
|
|
4
|
+
|
|
5
|
+
## 报告结构
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
9
|
+
代码评审报告
|
|
10
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
11
|
+
|
|
12
|
+
项目: {项目名}
|
|
13
|
+
评审范围: {文件/分支}
|
|
14
|
+
评审时间: {时间}
|
|
15
|
+
|
|
16
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
17
|
+
评审结论
|
|
18
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
19
|
+
|
|
20
|
+
📋 结论: {LGTM/需要修改/...}
|
|
21
|
+
|
|
22
|
+
🔴 必须修改: N 个问题
|
|
23
|
+
🟡 建议修改: N 个问题
|
|
24
|
+
⚪ 可选优化: N 个 Nit
|
|
25
|
+
|
|
26
|
+
📊 代码质量评分: XX/100
|
|
27
|
+
|
|
28
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
29
|
+
问题详情
|
|
30
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
31
|
+
|
|
32
|
+
🔴 {规则ID}: {问题标题}
|
|
33
|
+
文件: {文件路径}:{行号}
|
|
34
|
+
问题: {问题描述}
|
|
35
|
+
建议: {修复建议}
|
|
36
|
+
|
|
37
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
38
|
+
亮点 & 下一步行动
|
|
39
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 结论类型
|
|
43
|
+
|
|
44
|
+
| 结论 | 含义 | 行动 |
|
|
45
|
+
|------|------|------|
|
|
46
|
+
| `LGTM` | Looks Good To Me | 可以合入 |
|
|
47
|
+
| `需要小修改` | 有小问题需要处理 | 修复后可合入 |
|
|
48
|
+
| `需要修改` | 有明显问题需要修复 | 修复后重新评审 |
|
|
49
|
+
| `需要重大修改` | 有设计级别问题 | 需要讨论方案 |
|
|
50
|
+
|
|
51
|
+
## JSON 报告格式
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"summary": {
|
|
56
|
+
"verdict": "需要修改",
|
|
57
|
+
"issuesCount": { "critical": 2, "major": 3, "minor": 5 },
|
|
58
|
+
"score": 75
|
|
59
|
+
},
|
|
60
|
+
"issues": [{
|
|
61
|
+
"ruleId": "FUNC-002",
|
|
62
|
+
"severity": "critical",
|
|
63
|
+
"file": "src/utils/helper.js",
|
|
64
|
+
"line": 42,
|
|
65
|
+
"issue": "未处理边缘情况",
|
|
66
|
+
"suggestion": "添加空值检查"
|
|
67
|
+
}],
|
|
68
|
+
"positives": ["代码结构清晰"],
|
|
69
|
+
"recommendations": ["建议添加单元测试"]
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
> 更多示例:`skill://code-review/references/report-examples.md`
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# 代码质量评分标准
|
|
2
|
+
|
|
3
|
+
评审时可参考此评分标准对代码质量进行量化评估。
|
|
4
|
+
|
|
5
|
+
## 基本要求(80分)
|
|
6
|
+
|
|
7
|
+
### 代码可读性(30分)
|
|
8
|
+
|
|
9
|
+
| 检查项 | 分值 | 说明 |
|
|
10
|
+
|--------|------|------|
|
|
11
|
+
| 符合代码规范 | 8 | 遵循团队/公司代码规范 |
|
|
12
|
+
| 变量命名清晰 | 8 | 变量名、方法名、类名有较高可读性 |
|
|
13
|
+
| 逻辑一致性 | 5 | 函数命名、注释和逻辑的一致性 |
|
|
14
|
+
| 目录结构 | 4 | 目录命名、结构的一致性 |
|
|
15
|
+
| 有意义的注释 | 5 | 关键逻辑有注释说明 |
|
|
16
|
+
|
|
17
|
+
### 代码简单高效(25分)
|
|
18
|
+
|
|
19
|
+
| 检查项 | 分值 | 说明 |
|
|
20
|
+
|--------|------|------|
|
|
21
|
+
| 优先使用标准库 | 10 | 使用标准库提供的能力 |
|
|
22
|
+
| TypeScript 类型 | 8 | 避免大量使用 any 类型 |
|
|
23
|
+
| 避免冗余 | 4 | 避免无效冗余的写法 |
|
|
24
|
+
| 实现方案一致 | 3 | 同类问题使用一致的解决方案 |
|
|
25
|
+
|
|
26
|
+
### 安全规范(15分)
|
|
27
|
+
|
|
28
|
+
| 检查项 | 分值 | 说明 |
|
|
29
|
+
|--------|------|------|
|
|
30
|
+
| XSS 防护 | 5 | 避免 innerHTML/v-html 渲染用户输入 |
|
|
31
|
+
| 敏感数据处理 | 4 | 敏感信息不存储在 localStorage,不硬编码密钥 |
|
|
32
|
+
| 输入校验 | 3 | 用户输入经过校验和转义 |
|
|
33
|
+
| 权限校验 | 3 | 不仅依赖前端进行权限控制 |
|
|
34
|
+
|
|
35
|
+
### 性能规范(10分)
|
|
36
|
+
|
|
37
|
+
| 检查项 | 分值 | 说明 |
|
|
38
|
+
|--------|------|------|
|
|
39
|
+
| 资源清理 | 4 | 及时清理定时器/监听器/订阅 |
|
|
40
|
+
| 渲染优化 | 3 | 大列表虚拟滚动、避免不必要渲染 |
|
|
41
|
+
| 依赖体积 | 3 | 避免引入过大的依赖包 |
|
|
42
|
+
|
|
43
|
+
## 加分项(每项最高10分)
|
|
44
|
+
|
|
45
|
+
- **高级安全**:CSP 配置、SRI 校验、依赖漏洞扫描
|
|
46
|
+
- **性能优化**:代码分割、图片优化、请求缓存、虚拟滚动
|
|
47
|
+
- **代码架构**:模块划分合理、接口设计良好、设计模式使用合理
|
|
48
|
+
- **功能难度**:巧妙的算法或思路解决复杂问题
|
|
49
|
+
- **稳定性**:异常保护、网络请求优化、兜底策略
|
|
50
|
+
|
|
51
|
+
## 评分等级
|
|
52
|
+
|
|
53
|
+
| 分数区间 | 等级 | 结论 |
|
|
54
|
+
|---------|------|------|
|
|
55
|
+
| 90+ | 优秀 | LGTM |
|
|
56
|
+
| 80-89 | 良好 | 需要小修改 |
|
|
57
|
+
| 70-79 | 合格 | 需要修改 |
|
|
58
|
+
| < 70 | 不合格 | 需要重大修改 |
|
|
59
|
+
|
|
60
|
+
## 一票否决项
|
|
61
|
+
|
|
62
|
+
以下问题无论评分多高,都需要修复后才能合入:
|
|
63
|
+
|
|
64
|
+
| 问题 | 规则 ID | 说明 |
|
|
65
|
+
|------|---------|------|
|
|
66
|
+
| XSS 漏洞 | SEC-001 | 存在明确的跨站脚本攻击风险 |
|
|
67
|
+
| 敏感信息泄露 | SEC-010 | 代码中硬编码密钥、凭证等敏感信息 |
|
|
68
|
+
| 严重内存泄漏 | PERF-001 | 存在明确的内存泄漏且影响用户体验 |
|
|
69
|
+
| 依赖严重漏洞 | SEC-008 | 使用了存在高危漏洞的依赖版本 |
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# 评审意见撰写规范
|
|
2
|
+
|
|
3
|
+
好的评审意见应该帮助开发者成长,而不是打击积极性。
|
|
4
|
+
|
|
5
|
+
## 核心原则
|
|
6
|
+
|
|
7
|
+
1. **对事不对人** - 评论代码,而不是评论开发者
|
|
8
|
+
2. **解释为什么** - 帮助开发者理解原因,传递知识
|
|
9
|
+
3. **提供建议** - 给出具体的改进方案
|
|
10
|
+
4. **保持礼貌** - 使用建设性的语言
|
|
11
|
+
|
|
12
|
+
## 礼貌原则
|
|
13
|
+
|
|
14
|
+
**示例对比:**
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
❌ 糟糕:
|
|
18
|
+
"为什么这里你使用了线程,显然并发并没有带来什么好处?"
|
|
19
|
+
|
|
20
|
+
✅ 好的:
|
|
21
|
+
"这里的并发模型增加了系统的复杂性,但没有任何实际的性能优势。
|
|
22
|
+
因为没有性能优势,最好是将这些代码作为单线程处理而不是使用多线程。"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## 解释为什么
|
|
26
|
+
|
|
27
|
+
**示例:**
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
这里建议使用 `const` 代替 `let`,因为 `total` 在后续代码中没有被重新赋值。
|
|
31
|
+
使用 `const` 可以让其他开发者明确知道这个变量不会被修改,提高代码可读性。
|
|
32
|
+
参考:JavaScript 编码规范 2.1 节
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 评论格式模板
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
[必须/建议/Nit] 规则ID: 问题简述
|
|
39
|
+
|
|
40
|
+
问题: 具体描述问题所在
|
|
41
|
+
原因: 解释为什么这是一个问题
|
|
42
|
+
建议: 提供具体的修复方案
|
|
43
|
+
参考: 相关规范或文档链接(可选)
|
|
44
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: sec-js-check
|
|
3
|
+
name: JavaScript 安全审查
|
|
4
|
+
category: security
|
|
5
|
+
description: 检查 XSS、CSRF、原型污染等安全问题,支持 React/Vue/Angular
|
|
6
|
+
tags: [security, javascript, xss, csrf, frontend]
|
|
7
|
+
updated_at: 2026-01-20
|
|
8
|
+
allowed-tools: [Read, Grep, Glob, Shell]
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# JavaScript 安全审查
|
|
12
|
+
|
|
13
|
+
## ⚠️ 核心规则
|
|
14
|
+
|
|
15
|
+
1. **永不信任用户输入** - 所有用户数据需校验和转义
|
|
16
|
+
2. **默认安全** - 使用安全 API(textContent 而非 innerHTML)
|
|
17
|
+
3. **纵深防御** - 多层安全措施,不依赖单一防护
|
|
18
|
+
|
|
19
|
+
## 快速开始
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
/js-security-check # 智能扫描 src 目录
|
|
23
|
+
/js-security-check file src/xxx.vue # 扫描指定文件
|
|
24
|
+
/js-security-check report # 生成详细报告
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 问题分级
|
|
28
|
+
|
|
29
|
+
| 前缀 | 含义 | 处理方式 |
|
|
30
|
+
|------|------|----------|
|
|
31
|
+
| `🔴 严重` | 可被直接利用 | 阻止发布 |
|
|
32
|
+
| `🟡 中等` | 需特定条件 | 尽快修复 |
|
|
33
|
+
| `⚪ 建议` | 最佳实践 | 可选优化 |
|
|
34
|
+
|
|
35
|
+
## 检查维度
|
|
36
|
+
|
|
37
|
+
| 维度 | 检查项 |
|
|
38
|
+
|------|--------|
|
|
39
|
+
| DOM 安全 | innerHTML、document.write、insertAdjacentHTML |
|
|
40
|
+
| URL 安全 | Open Redirect、javascript: scheme |
|
|
41
|
+
| 代码执行 | eval、new Function、setTimeout(string) |
|
|
42
|
+
| 原型污染 | __proto__、constructor、Object.assign |
|
|
43
|
+
| 存储安全 | localStorage 敏感信息、Cookie 属性 |
|
|
44
|
+
| 框架安全 | v-html、dangerouslySetInnerHTML |
|
|
45
|
+
|
|
46
|
+
## 📦 按需加载资源
|
|
47
|
+
|
|
48
|
+
| 资源 | URI |
|
|
49
|
+
|-----|-----|
|
|
50
|
+
| 完整检查清单 | `skill://js-security-check/references/checklist.md` |
|
|
51
|
+
| 修复示例 | `skill://js-security-check/references/fix-examples.md` |
|
|
52
|
+
| 评分标准 | `skill://js-security-check/references/scoring-standard.md` |
|