@axboot-mcp/mcp-server 1.0.0

package/src/docs/rules.json

@@ -0,0 +1,321 @@
+{
+  "requiredImports": [
+    { "from": "@axboot/datagrid", "types": ["AXDGDataItem", "AXDGPage", "AXDGSortParam"] },
+    { "from": "@core/stores/pageStoreActions", "types": ["pageStoreActions"] },
+    { "from": "@core/stores/types", "types": ["PageStoreActions", "StoreActions"] },
+    { "from": "@core/utils/object", "types": ["deleteEmptyValue"] },
+    { "from": "@types", "types": ["ProgramFn"] },
+    { "from": "zustand", "types": ["create"] },
+    { "from": "zustand/middleware", "types": ["subscribeWithSelector"] },
+    { "from": "zustand/shallow", "types": ["shallow"] },
+    { "from": "stores", "types": ["getTabStoreListener"] }
+  ],
+  "interfaceRules": {
+    "listRequest": {
+      "mustExtend": true,
+      "description": "Repository Request 타입을 확장해야 함",
+      "validPattern": "interface ListRequest extends PostXXXListRequest { ... }",
+      "invalidPattern": "interface ListRequest { ... }"
+    },
+    "dtoItem": {
+      "mustExtend": true,
+      "description": "Repository Response 타입을 확장해야 함",
+      "validPattern": "interface DtoItem extends XXXRes {}",
+      "invalidPattern": "interface DtoItem { ... }"
+    },
+    "saveRequest": {
+      "mustExtend": true,
+      "description": "Repository Save Request 타입을 확장해야 함",
+      "validPattern": "interface SaveRequest extends PostXXXSaveRequest {}"
+    },
+    "metadata": {
+      "firstField": "programFn",
+      "description": "programFn은 항상 첫 번째 필드여야 함",
+      "fieldOrder": ["programFn", "listRequestValue", "listColWidths", "listSortParams", "listSelectedRowKey", "checkedRowKeys", "listCheckedKeys", "saveRequestValue", "detail", "selectedItem", "saveRequestValues", "formActive", "flexGrow", "expandedKeys", "activeTabKey"]
+    },
+    "states": {
+      "mustExtend": "MetaData",
+      "description": "States는 MetaData를 확장해야 함",
+      "validPattern": "interface States extends MetaData { ... }",
+      "invalidPattern": "interface States { ... }"
+    },
+    "actions": {
+      "mustExtend": "PageStoreActions<States>",
+      "description": "Actions는 PageStoreActions를 확장해야 함",
+      "validPattern": "interface Actions extends PageStoreActions<States> { ... }",
+      "invalidPattern": "interface Actions { ... }"
+    },
+    "storeExport": {
+      "mustExtend": ["States", "Actions", "PageStoreActions<States>"],
+      "validPattern": "export interface xxxStore extends States, Actions, PageStoreActions<States> {}"
+    }
+  },
+  "namingRules": {
+    "storeInterface": {
+      "pattern": "[lowerCamelCase] + 'Store'",
+      "valid": ["memberListStore", "productMasterStore", "orderClaimReturnStore", "kdhFinancialHighlightsStore"],
+      "invalid": ["MemberListStore", "member_list_store", "Memberliststore"]
+    },
+    "hook": {
+      "pattern": "'use' + [PascalCase] + 'Store'",
+      "valid": ["useMemberListStore", "useProductMasterStore", "useOrderClaimReturnStore", "useKdhFinancialHighlightsStore"],
+      "invalid": ["usememberListStore", "useMemberlistStore", "memberListStore", "MemberListStore"]
+    },
+    "actions": {
+      "setRequestValue": "set[Target]RequestValue",
+      "setData": "set[Target]",
+      "setColWidths": "setListColWidths (plural)",
+      "setSpinning": "set[Target]Spinning",
+      "setSortParams": "setListSortParams (plural)",
+      "setChecked": "setChecked[Target]s (plural)",
+      "setSelected": "set[Target]Selected",
+      "callApi": "call[Target]Api",
+      "changePage": "change[Target]Page",
+      "setFormActive": "setFormActive, cancelFormActive",
+      "setModalOpen": "setModalOpen"
+    },
+    "states": {
+      "requestValue": "[target]RequestValue (singular)",
+      "data": "[target]Data (singular)",
+      "page": "[target]Page (singular)",
+      "spinning": "[target]Spinning (singular)",
+      "loading": "[target]Loading (singular)",
+      "sortParams": "[target]SortParams (plural)",
+      "colWidths": "listColWidths (plural)",
+      "selectedRowKey": "listSelectedRowKey (singular)",
+      "checkedKeys": "checkedRowKeys (plural)",
+      "checkedIndexes": "listCheckedIndexes (plural)",
+      "expandedKeys": "expandedKeys (plural)",
+      "selectedItem": "selectedItem (singular)"
+    },
+    "constants": {
+      "initialState": "createState",
+      "actions": "createActions"
+    }
+  },
+  "fieldOrder": {
+    "metadata": {
+      "groups": [
+        { "name": "system", "fields": ["programFn"] },
+        { "name": "list", "fields": ["listRequestValue", "listColWidths", "listSortParams"] },
+        { "name": "selection", "fields": ["listSelectedRowKey", "listCheckedIndexes", "checkedRowKeys", "listCheckedKeys"] },
+        { "name": "form", "fields": ["saveRequestValue", "detail", "selectedItem", "saveRequestValues"] },
+        { "name": "layout", "fields": ["formActive", "flexGrow"] },
+        { "name": "tree", "fields": ["expandedKeys"] },
+        { "name": "tab", "fields": ["activeTabKey"] }
+      ]
+    },
+    "states": {
+      "groups": [
+        { "name": "system", "fields": ["routePath"] },
+        { "name": "loading", "fields": ["listSpinning", "excelSpinning", "saveSpinning", "deleteSpinning", "detailSpinning", "detailLoading", "updateSpinning", "copySpinning", "treeSpinning", "summarySpinning", "list01Spinning", "list02Spinning", "spinning"] },
+        { "name": "data", "fields": ["listData", "listPage", "selectedItem", "detail", "list01Data", "list01Page", "list02Data", "list02Page", "treeData", "summaryData"] },
+        { "name": "ui", "fields": ["modalOpen", "formActive", "isDirty", "isFormDirty"] },
+        { "name": "fixed", "fields": ["bbsNo", "cntntsBbsKncd", "reprtTpcd", "langKncd"] }
+      ]
+    },
+    "actions": {
+      "groups": [
+        { "name": "setter", "fields": ["setListRequestValue", "setListColWidths", "setListSpinning", "setListSortParams", "setExcelSpinning", "setSaveRequestValue", "setSelectedItem", "setCheckedRowKeys", "setListSelectedRowKey", "setListCheckedIndexes", "setSaveSpinning", "setFlexGrow", "setTreeData", "setExpandedKeys", "setSaveRequestValues", "setCategorySearch", "setIsDirty", "setRequestValue", "setRequest01Value", "setRequest02Value", "setActiveTabKey", "setList01SortParams", "setList02SortParams", "setDetail", "setModalOpen", "setFormValues", "setActiveTabId", "setMdiaClcd", "setDspySortArray", "setSelectedSctnTpcd"] },
+        { "name": "api", "fields": ["callListApi", "callExcelDownloadApi", "callSaveApi", "callDeleteApi", "callTreeApi", "callTreeSaveApi", "callSummaryApi", "callList01Api", "callList02Api", "callChangeStatusApi", "callDataCopyApi", "callDetailApi", "callConfirmApi", "deleteSctnBanner"] },
+        { "name": "page", "fields": ["changeListPage", "changeList01Page", "changeList02Page"] },
+        { "name": "form", "fields": ["cancelFormActive", "setFormActive"] }
+      ]
+    },
+    "fileStructure": [
+      "imports",
+      "interface ListRequest",
+      "interface DtoItem",
+      "interface SaveRequest (optional)",
+      "interface RemoveRequest (optional)",
+      "interface MetaData",
+      "interface States",
+      "interface Actions",
+      "const createState",
+      "const createActions",
+      "export interface xxxStore",
+      "export const useXXXStore",
+      "useXXXStore.subscribe"
+    ],
+    "createActions": [
+      "...pageStoreActions(set, get, { createState })",
+      "syncMetadata",
+      "onMountApp",
+      "setters (alphabetical or grouped)",
+      "api calls",
+      "page changes",
+      "other actions"
+    ]
+  },
+  "implementationRules": {
+    "callListApi": {
+      "mustHave": [
+        "duplicateCallPrevention: if (get().listSpinning) return;",
+        "spinningSet: set({ listSpinning: true });",
+        "tryBlock: try { ... }",
+        "paramMerge: const apiParam = { ...get().listRequestValue, ...request };",
+        "deleteEmptyValue: await XXXService.postXXXList(deleteEmptyValue({ ...apiParam }));",
+        "stateUpdate: set({ listRequestValue: apiParam, listData: ..., listPage: ... });",
+        "finallyBlock: finally { set({ listSpinning: false }); }"
+      ],
+      "template": "callListApi: async (request) => {\n  if (get().listSpinning) return;\n  set({ listSpinning: true });\n\n  try {\n    const apiParam: ListRequest = { ...get().listRequestValue, ...request };\n    const response = await XXXService.postXXXList(\n      deleteEmptyValue({ ...apiParam })\n    );\n\n    set({\n      listRequestValue: apiParam,\n      listData: response.ds.map((values) => ({ values })),\n      listPage: {\n        currentPage: response.page.pageNumber ?? 1,\n        pageSize: response.page.pageSize ?? 0,\n        totalPages: response.page.pageCount ?? 0,\n        totalElements: response.page?.totalCount,\n      },\n    });\n\n    return response;\n  } finally {\n    set({ listSpinning: false });\n  }\n},"
+    },
+    "pageStoreActions": {
+      "position": "last",
+      "description": "pageStoreActions는 항상 마지막에 위치해야 함",
+      "valid": "const createActions = (set, get) => ({ ...otherActions, ...pageStoreActions(set, get, { createState }) });",
+      "invalid": "const createActions = (set, get) => ({ ...pageStoreActions(set, get, { createState }), ...otherActions });"
+    },
+    "subscribe": {
+      "position": "afterStoreCreation",
+      "description": "subscribe는 항상 Store 생성 후에 위치해야 함",
+      "selectorPattern": "MetaData의 모든 필드를 포함해야 함",
+      "equalityFn": "shallow",
+      "valid": "useXXXStore.subscribe(\n  (s): Record<keyof MetaData, any> => ({ ...allMetadataFields... }),\n  getTabStoreListener<MetaData>(createState.routePath),\n  { equalityFn: shallow },\n);"
+    }
+  },
+  "forbiddenPatterns": [
+    {
+      "name": "StatesDoesNotExtendMetaData",
+      "description": "States가 MetaData를 확장하지 않음",
+      "invalid": "interface States { routePath?: string; listSpinning: boolean; }",
+      "fix": "interface States extends MetaData { routePath?: string; listSpinning: boolean; }"
+    },
+    {
+      "name": "PageStoreActionsWrongPosition",
+      "description": "pageStoreActions가 잘못된 위치에 배치됨",
+      "invalid": "const createActions = (set, get) => ({ ...pageStoreActions(set, get, { createState }), syncMetadata: ... });",
+      "fix": "const createActions = (set, get) => ({ syncMetadata: ..., ...pageStoreActions(set, get, { createState }) });"
+    },
+    {
+      "name": "MissingListRequestValueUpdate",
+      "description": "callListApi에서 listRequestValue를 업데이트하지 않음",
+      "invalid": "set({ listData: response.ds.map((values) => ({ values })), listPage: { ... } });",
+      "fix": "set({ listRequestValue: apiParam, listData: response.ds.map((values) => ({ values })), listPage: { ... } });"
+    },
+    {
+      "name": "MissingDeleteEmptyValue",
+      "description": "deleteEmptyValue 미사용",
+      "invalid": "await XXXService.postXXXList(apiParam);",
+      "fix": "await XXXService.postXXXList(deleteEmptyValue(apiParam));"
+    },
+    {
+      "name": "UsingUndefinedStateField",
+      "description": "States에 없는 필드를 Actions에서 사용",
+      "invalid": "interface States { listSpinning: boolean; } // setSelectedItem uses selectedItem which is not defined",
+      "fix": "interface States { listSpinning: boolean; selectedItem?: DtoItem; }"
+    },
+    {
+      "name": "MissingShallowEqualityFn",
+      "description": "shallow equalityFn 누락",
+      "invalid": "useXXXStore.subscribe((s) => ({ ... }), getTabStoreListener<MetaData>(createState.routePath));",
+      "fix": "useXXXStore.subscribe((s) => ({ ... }), getTabStoreListener<MetaData>(createState.routePath), { equalityFn: shallow });"
+    },
+    {
+      "name": "SubscribeSelectorMetaDataMismatch",
+      "description": "Subscribe selector와 MetaData 불일치",
+      "invalid": "// MetaData has 4 fields but subscribe only has 2",
+      "fix": "subscribe selector must include all MetaData fields"
+    },
+    {
+      "name": "MissingSpinningRelease",
+      "description": "Spinning 해제 누락",
+      "invalid": "callListApi: async (request) => { set({ listSpinning: true }); const response = await ...; set({ listData: ... }); }",
+      "fix": "callListApi: async (request) => { set({ listSpinning: true }); try { const response = await ...; set({ listData: ... }); } finally { set({ listSpinning: false }); } }"
+    },
+    {
+      "name": "MissingDuplicateCallPrevention",
+      "description": "중복 호출 방지 누락",
+      "invalid": "callListApi: async (request) => { set({ listSpinning: true }); ... }",
+      "fix": "callListApi: async (request) => { if (get().listSpinning) return; set({ listSpinning: true }); ... }"
+    },
+    {
+      "name": "ActionsNotExtendingPageStoreActions",
+      "description": "Actions가 PageStoreActions를 확장하지 않음",
+      "invalid": "interface Actions { setListRequestValue: ...; }",
+      "fix": "interface Actions extends PageStoreActions<States> { setListRequestValue: ...; }"
+    }
+  ],
+  "dependencies": {
+    "fieldGroups": {
+      "basicList": ["listRequestValue", "listColWidths", "listSortParams", "listSpinning", "listData", "listPage", "callListApi", "changeListPage"],
+      "excel": ["excelSpinning", "setExcelSpinning", "callExcelDownloadApi"],
+      "detailForm": ["saveRequestValue", "selectedItem", "setSelectedItem", "setSaveRequestValue"],
+      "singleSelection": ["listSelectedRowKey", "setListSelectedRowKey"],
+      "multiSelectionCheckbox": ["checkedRowKeys", "setCheckedRowKeys"],
+      "multiSelectionIndex": ["listCheckedIndexes", "setListCheckedIndexes"],
+      "crudSave": ["saveSpinning", "setSaveSpinning", "saveRequestValue", "callSaveApi"],
+      "crudDelete": ["deleteSpinning", "callDeleteApi"],
+      "crudForm": ["formActive", "setFormActive", "cancelFormActive"],
+      "modal": ["modalOpen", "setModalOpen"],
+      "tree": ["treeSpinning", "treeData", "expandedKeys", "callTreeApi"],
+      "dashboard": ["summaryRequestValue", "summaryData", "callSummaryApi"]
+    },
+    "actionDependencies": {
+      "callExcelDownloadApi": ["excelSpinning", "setExcelSpinning"],
+      "setSelectedItem": ["selectedItem", "detailLoading"],
+      "callSaveApi": ["saveSpinning", "saveRequestValue"],
+      "callDeleteApi": ["deleteSpinning"],
+      "setListSelectedRowKey": ["listSelectedRowKey"],
+      "setCheckedRowKeys": ["checkedRowKeys"],
+      "setExpandedKeys": ["expandedKeys"],
+      "changeListPage": ["callListApi"],
+      "setFormActive": ["formActive"]
+    },
+    "mutuallyExclusive": [
+      {
+        "group": "dataSource",
+        "fields": ["listData", "treeData"],
+        "description": "listData와 treeData는 함께 사용할 수 없음"
+      },
+      {
+        "group": "spinning",
+        "fields": ["listSpinning", "treeSpinning"],
+        "description": "listSpinning과 treeSpinning은 함께 사용할 수 없음"
+      }
+    ]
+  },
+  "checklist": {
+    "interface": [
+      "ListRequest가 Repository Request를 확장함",
+      "DtoItem가 Repository Response를 확장함",
+      "SaveRequest가 Repository Save Request를 확장함 (필요시)",
+      "MetaData에 필요한 필드가 모두 포함됨",
+      "States가 MetaData를 확장함",
+      "Actions가 PageStoreActions<States>를 확장함"
+    ],
+    "createState": [
+      "listRequestValue에 pageNumber, pageSize 초기값 포함",
+      "listColWidths가 빈 배열로 초기화됨",
+      "listSortParams가 빈 배열로 초기화됨",
+      "listSpinning이 false로 초기화됨",
+      "listData가 빈 배열로 초기화됨",
+      "listPage가 빈 페이지 상태로 초기화됨",
+      "고정값이 필요한 경우 상수로 선언되고 포함됨"
+    ],
+    "createActions": [
+      "syncMetadata가 구현됨",
+      "onMountApp가 구현됨",
+      "setListRequestValue가 구현됨",
+      "setListColWidths가 구현됨",
+      "setListSpinning가 구현됨",
+      "setListSortParams가 구현됨",
+      "callListApi가 구현됨 (중복 호출 방지, try-finally 포함)",
+      "changeListPage가 구현됨",
+      "callListApi에서 deleteEmptyValue 사용됨",
+      "callListApi에서 listRequestValue 업데이트됨",
+      "추가 기능의 액션들이 모두 구현됨",
+      "...pageStoreActions(set, get, { createState })가 마지막에 있음"
+    ],
+    "storeExport": [
+      "xxxStore 인터페이스가 States, Actions, PageStoreActions<States>를 모두 확장함",
+      "useXXXStore가 subscribeWithSelector로 생성됨"
+    ],
+    "subscribe": [
+      "subscribe가 Store 생성 후에 위치함",
+      "Selector가 MetaData의 모든 필드를 포함함",
+      "getTabStoreListener<MetaData>가 사용됨",
+      "{ equalityFn: shallow }가 포함됨"
+    ]
+  }
+}