structlint/.structlint.yaml at main · AxeForging/structlint · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# structlint configuration for this project
# This file defines the standards for our own project structure

dir_structure:
  allowedPaths:
    - "."                    # Root directory
    - "cmd/**"              # Command entry points
    - "internal/**"         # Internal packages
    - "test/**"             # Test files
    - "doc/**"              # Documentation
    - "docs/**"             # Documentation
    - "scripts/**"          # Build and utility scripts
    - "bin/**"              # Built binaries
    - "dist/**"             # Distribution files
    - ".claude/**"          # Claude Code configuration
    - ".github/**"          # GitHub configuration
  disallowedPaths:
    - "vendor/**"           # Vendor dependencies
    - "node_modules/**"     # Node.js dependencies
    - "tmp/**"              # Temporary directories
    - "temp/**"             # Temporary directories
    - ".git/**"             # Git internal files
    - "*.log"               # Log files
  requiredPaths:
    - "cmd"                 # Must have cmd directory
    - "internal"            # Must have internal directory
    - "test"                # Must have test directory

file_naming_pattern:
  allowed:
    # Go files
    - "*.go"
    - "*.mod"
    - "*.sum"

    # Configuration files
    - "*.yaml"
    - "*.yml"
    - "*.json"
    - "*.toml"

    # Documentation
    - "*.md"
    - "*.txt"
    - "*.png"
    - "*.jpg"
    - "*.svg"
    - "README*"
    - "LICENSE*"
    - "CHANGELOG*"
    - "CONTRIBUTING*"

    # Build and deployment
    - "Makefile"
    - "Dockerfile*"
    - "*.sh"
    - "*.bat"

    # IDE and tooling
    - ".gitignore"
    - ".editorconfig"
    - ".golangci.yml"
    - ".goreleaser.yaml"
    - ".github/**"

    # Other common files
    - "go.work"
    - "go.work.sum"
  disallowed:
    # Environment and secrets
    - "*.env*"
    - ".env*"
    - "*.key"
    - "*.pem"
    - "*.p12"

    # Temporary and cache files
    - "*.log"
    - "*.tmp"
    - "*.temp"
    - "*~"
    - "*.swp"
    - "*.swo"
    - "*.bak"
    - "*.backup"

    # OS-specific files
    - ".DS_Store"
    - "Thumbs.db"
    - "desktop.ini"

    # IDE-specific files
    - "*.idea/**"
    - "*.vscode/**"
    - "*.sublime-*"
  required:
    # Essential Go project files
    - "go.mod"              # Go module file
    - "README.md"           # Project documentation
    - ".gitignore"          # Git ignore file
    - "*.go"                # At least one Go source file

ignore:
  # Version control
  - ".git"
  - ".svn"
  - ".hg"

  # Dependencies
  - "vendor"
  - "node_modules"
  - "bower_components"

  # Build outputs
  - "bin"
  - "dist"
  - "build"
  - "target"

  # IDE and editor files
  - ".idea"
  - ".vscode"
  - "*.sublime-*"

  # OS files
  - ".DS_Store"
  - "Thumbs.db"

  # Temporary files
  - "*.log"
  - "*.tmp"
  - "*.temp"