docc2json/example-group-config.yaml at main · AppGram/docc2json · 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
# Example group configuration for docc2json
# This file demonstrates how to organize your types, protocols, and enums into custom groups

groups:
  # Survey-related types
  Survey:
    description: "Survey and mapping functionality"
    types:
      - SurveyMap
      - SurveyData
      - SurveyPoint
    protocols:
      - SurveyProtocol
    # You can also use wildcard patterns
    patterns:
      - "Survey*"  # Matches any type starting with "Survey"

  # Form-related types
  Form:
    description: "Form handling and validation"
    patterns:
      - "Form*"      # Matches FormManager, FormBuilder, etc.
      - "*Form"      # Matches CustomForm, UserForm, etc.
    enums:
      - FormFieldType
      - FormValidationRule

  # Authentication and user management
  Authentication:
    description: "User authentication and session management"
    types:
      - UserSession
      - AuthToken
      - AuthManager
    protocols:
      - Authenticatable
    patterns:
      - "Auth*"
      - "*Session"

  # Network and API
  Networking:
    description: "Network communication and API clients"
    patterns:
      - "*Client"
      - "*Service"
      - "*API"
    types:
      - NetworkConfiguration
      - RequestBuilder

  # UI Components
  UI:
    description: "User interface components and views"
    patterns:
      - "*View"
      - "*ViewController"
      - "*Cell"
    protocols:
      - ViewConfigurable
      - Presentable

# Notes:
# - Items not matching any group will automatically go to an "Other" group
# - Patterns support: "prefix*", "*suffix", "*infix*"
# - You can mix explicit type names and patterns in the same group
# - The order of groups in this file determines their order in the output