instruction-requests/codemcp.toml at 8.0 · PCCLibrary/instruction-requests · 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
133
# codemcp.toml - Configuration for Library Instruction System

[project]
name = "library-instruction-system"
description = "A Laravel-based system for managing library instruction requests between faculty and librarians"
language = "php"
framework = "laravel"

[paths]
# Core Laravel directories
models = "app/Models"
controllers = "app/Http/Controllers"
services = "app/Services"
repositories = "app/Repositories"
views = "resources/views"
routes = "routes"
config = "config"
js = "resources/js"
css = "resources/css"
migrations = "database/migrations"
tests = "tests"

[ignore]
# Directories and files to ignore
patterns = [
    "vendor/**",
    "node_modules/**",
    "public/storage/**",
    "storage/**",
    "bootstrap/cache/**",
    ".git/**",
    "*.log",
    ".env*"
]

[conventions]
# Coding conventions specific to the project
indentation = "spaces"
indent_size = 4
line_ending = "LF"
php_version = "8.2"
laravel_version = "11.0"

[commands]
# Useful commands for development
serve = "php artisan serve"
migrate = "php artisan migrate"
rollback = "php artisan migrate:rollback"
test = "php artisan test"
seed = "php artisan db:seed"
cache_clear = "php artisan cache:clear"
route_list = "php artisan route:list"
tinker = "php artisan tinker"
make_controller = "php artisan make:controller"
make_model = "php artisan make:model"
make_migration = "php artisan make:migration"
make_seeder = "php artisan make:seeder"
make_test = "php artisan make:test"
composer_update = "composer update"
npm_install = "npm install"
npm_run_dev = "npm run dev"
npm_run_build = "npm run build"
git_status = "git status"
git_pull = "git pull"
git_push = "git push"

[features]
# Key features of the project
request_lifecycle = [
    "received",
    "assigned",
    "accepted",
    "completed",
    "copied"
]
file_types = [
    "pdf",
    "doc",
    "docx",
    "txt",
    "rtf",
    "ppt",
    "pptx"
]

[dependencies]
# Key project dependencies
php = [
    "laravel/framework",
    "spatie/laravel-medialibrary",
    "livewire/livewire",
    "power-components/livewire-powergrid"
]
js = [
    "alpine.js",
    "tailwindcss",
    "choices.js",
    "flatpickr"
]

[structure]
# Important project-specific patterns and structures
models = [
    "InstructionRequests",
    "InstructionRequestDetails",
    "Instructor",
    "Classes",
    "Campus",
    "User"
]
controllers = [
    "InstructionRequestController",
    "PublicInstructionRequestController",
    "InstructorController",
    "CampusController",
    "UserController",
    "ClassesController"
]
services = [
    "InstructionRequestService",
    "InstructionRequestDetailsService",
    "DepartmentService",
    "MediaLibrary"
]
repositories = [
    "BaseRepository",
    "InstructionRequestRepository",
    "InstructionRequestDetailsRepository"
]

[hooks]
# Git hooks configuration (if needed)
pre_commit = "php artisan test"