
vilt-coding-standards
by richardhowes
SKILL.md
name: vilt-coding-standards description: Apply VILT stack coding standards when writing Vue, Laravel, or TypeScript code. Automatically enforces patterns for Composition API, Form Requests, Inertia navigation, and component hierarchy. Activates when creating or modifying Vue components, Laravel controllers, services, or models.
VILT Coding Standards
Apply these standards when writing code in ResRequest projects.
Vue Components
Script Setup Syntax
Always use <script setup lang="ts">:
<script setup lang="ts">
import { ref, computed } from 'vue'
import { useForm } from '@inertiajs/vue3'
import { Button } from '@/components/ui/button'
interface Props {
items: Item[]
}
const props = defineProps<Props>()
</script>
TypeScript Interfaces
Define interfaces for all props and emits:
interface Props {
user: User
isEditing?: boolean
}
interface Emits {
(e: 'saved', user: User): void
(e: 'cancelled'): void
}
const props = defineProps<Props>()
const emit = defineEmits<Emits>()
Composition API Only
Never use Options API. Always use Composition API:
// CORRECT: Composition API
const count = ref(0)
const doubleCount = computed(() => count.value * 2)
function increment() {
count.value++
}
// WRONG: Options API
export default {
data() {
return { count: 0 }
},
computed: {
doubleCount() { return this.count * 2 }
}
}
Form Handling
Always use useForm() from Inertia for forms:
import { useForm } from '@inertiajs/vue3'
const form = useForm({
name: '',
email: '',
})
function submit() {
form.post(route('users.store'), {
preserveScroll: true,
onSuccess: () => form.reset(),
})
}
Laravel Controllers
Form Request Validation
Always use Form Request classes:
// CORRECT: Form Request
public function store(CreateUserRequest $request): RedirectResponse
{
User::create($request->validated());
return redirect()->back();
}
// WRONG: Inline validation
public function store(Request $request): RedirectResponse
{
$validated = $request->validate([...]);
}
Resource Transformation
Use Resources for API/Inertia responses:
public function index(): Response
{
return Inertia::render('Users/Index', [
'users' => UserResource::collection(User::all()),
]);
}
Happy Path Last
Handle errors first, success case last:
public function store(CreateUserRequest $request): RedirectResponse
{
if (! $request->user()->canCreateUsers()) {
abort(403);
}
if (User::where('email', $request->email)->exists()) {
return redirect()->back()->withErrors(['email' => 'Email already exists']);
}
// Happy path last
User::create($request->validated());
return redirect()->route('users.index');
}
Authorization First
Always authorize before action:
public function destroy(User $user): RedirectResponse
{
$this->authorize('delete', $user);
$user->delete();
return redirect()->route('users.index');
}
Laravel Services
Typed Properties
Use typed properties, not docblocks:
class UserService
{
public function __construct(
private UserRepository $repository,
private EmailService $emailService,
) {}
}
Return Types
Always specify return types including void:
public function createUser(array $data): User
{
return User::create($data);
}
public function sendNotification(User $user): void
{
// ...
}
Laravel Models
Typed Casts
Use typed casts array:
protected $casts = [
'is_active' => 'boolean',
'metadata' => 'array',
'published_at' => 'datetime',
];
Relationship Return Types
Type hint relationships:
public function posts(): HasMany
{
return $this->hasMany(Post::class);
}
public function profile(): HasOne
{
return $this->hasOne(Profile::class);
}
TypeScript Conventions
No any Type
Never use any. Use proper types or unknown:
// WRONG
function process(data: any) { }
// CORRECT
function process(data: unknown) { }
function process(data: Record<string, string>) { }
Interface Over Type
Prefer interfaces for object shapes:
// CORRECT
interface User {
id: number
name: string
}
// Less preferred (but OK for unions/intersections)
type UserId = number | string
Code Quality
No Debugging Code
Never commit:
console.log(),console.debug()dd(),dump(),ray()debuggerstatements
No Unnecessary Comments
Write self-documenting code. Only comment WHY, not WHAT:
// WRONG: Comment explains what code does
// Get the user
$user = User::find($id);
// CORRECT: Comment explains why
// Using findOrFail would throw before we can show custom error
$user = User::find($id);
if (! $user) {
return $this->userNotFoundResponse($id);
}
Translations
All user-facing strings must use translations:
<!-- Vue -->
<Button>{{ $t('common.save') }}</Button>
// Laravel
return redirect()->back()->with('success', __('users.created'));
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon