code-sense/codesense.modern.yaml at main · atbeta/code-sense · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# CodeSense — Pure Vue 3 新项目配置
#
# 适用于: Vue 3 + pinia + vue-router + <script setup>
#
# 用法: codesense index -c codesense.modern.yaml

project:
  name: "modern-app"
  source_root: "src"

entities:
  component:
    patterns:
      - "**/*.vue"
    properties:
      - name: "name"
        extract: "export_default.name"
      - name: "api_mode"
        extract: "detect_api_mode"

  composable:
    description: "Vue 3 composable (组合式函数)"
    patterns:
      - "src/composables/**/*.ts"
    markers:
      - naming_pattern: "use[A-Z]*"

  store:
    patterns:
      - "src/stores/**/*.ts"
    variants:
      pinia:
        detector: call_expression
        pattern: "defineStore"
        internal_structure:
          state: "options.state"
          getters: "options.getters"
          actions: "options.actions"

  route:
    patterns:
      - "src/router/**/*.ts"

framework_apis:
  - name: "vue"
    sources:
      - "vue"
    api_list:
      - "ref"
      - "computed"
      - "watch"
      - "onMounted"
      - "onUnmounted"
      - "reactive"
      - "toRefs"
      - "nextTick"
      - "watchEffect"
      - "provide"
      - "inject"
    compiler_macros:
      - "defineProps"
      - "defineEmits"
      - "defineExpose"
      - "defineOptions"
      - "withDefaults"
      - "defineModel"
      - "defineSlots"

relationships:
  imports:
    description: "File-level import dependency"
    from: "component"
    to: "store"

  uses_store:
    description: "Component uses a pinia store"
    from: "component"
    to: "store"
    detect_by:
      - type: "call_expression"
        pattern: "use*Store"

  uses_composable:
    description: "Component uses a composable"
    from: "component"
    to: "composable"
    detect_by:
      - type: "call_expression"
        pattern: "use*"

  matches_route:
    description: "Route maps to component"
    from: "route"
    to: "component"
    detect_by:
      - type: "import_expression"
        pattern: "*"

custom_entities:
  server_api_composable:
    description: "Composable 封装了服务端 API 调用"
    patterns:
      - "src/composables/api/**/*.ts"
    markers:
      - import_contains: "axios"
      - import_contains: "ofetch"