As Vue.js applications scale, code organization becomes just as important as functionality. What starts as a couple of Vue components can easily evolve into a hundred interconnected files, each with their own state logic, side effects, and styling concerns. To prevent tech debt and burnout, let’s talk about how to design Vue.js projects for maintainability.
Modular Structure From Day One
A well-organized src/ directory can make or break a large Vue application. The common pitfall is stuffing everything into a components/ folder. Instead, group files by domain or feature:
src/
├── modules/
│ ├── auth/
│ │ ├── components/
│ │ ├── views/
│ │ └── store.js
│ └── dashboard/
│ ├── components/
│ ├── views/
│ └── store.js
├── shared/
│ ├── components/
│ └── utils/
This approach aligns with Vue’s “feature-first” mindset and keeps related logic together.
Use Composition API for Reusability
The Composition API encourages you to extract logic into composables. Instead of repeating fetch logic in multiple components:
// useUsers.js
import { ref, onMounted } from 'vue';
import api from '@/services/api';
export function useUsers() {
const users = ref([]);
const loading = ref(true);
onMounted(async () => {
users.value = await api.get('/users');
loading.value = false;
});
return { users, loading };
}
Now any component can import and reuse this hook, keeping code DRY.
State Management: Pinia over Vuex (for new projects)
Vuex has long been the go-to, but Pinia is now the recommended alternative. It’s more modular, has better TypeScript support, and integrates beautifully with Vue 3.
// stores/userStore.js
import { defineStore } from 'pinia';
export const useUserStore = defineStore('user', {
state: () => ({ user: null }),
actions: {
async fetchUser() {
this.user = await api.get('/me');
},
},
});
Auto-Register Components & Icons
Large codebases benefit from component auto-registration. It reduces import noise and keeps templates clean. Vue CLI supports global registration with Webpack’s require.context, or you can use Vite’s import.meta.glob.
const components = import.meta.glob('./components/**/*.vue', { eager: true });
Define Prop Contracts Clearly
In big teams, props often become ambiguous. Use JSDoc or TypeScript to document what each component expects:
props: {
userId: {
type: String,
required: true,
},
},
Or if using script setup with TypeScript:
<script setup lang=\"ts\">
defineProps<{ userId: string }>();
</script>
Use ESLint and Prettier from Day One
As contributors increase, so does inconsistency. ESLint ensures code quality, while Prettier standardizes formatting. Use both with a pre-commit hook via lint-staged and husky.
{
\"lint-staged\": {
\"*.{js,vue,ts}\": [\"eslint --fix\", \"prettier --write\"]
}
}
Write Tests Like You’ll Thank Yourself Later
Vue Test Utils and Vitest (or Jest) should be in your arsenal. Aim for component-level tests, mocking dependencies and testing state interactions. Example:
import { mount } from '@vue/test-utils';
import UserCard from '@/components/UserCard.vue';
describe('UserCard', () => {
it('displays user name', () => {
const wrapper = mount(UserCard, {
props: { name: 'Alice' },
});
expect(wrapper.text()).toContain('Alice');
});
});
Conclusion
Scaling Vue.js doesn’t have to mean sacrificing developer sanity. With modular structure, Composition API, Pinia, and solid tooling, your app can remain robust and joyful to work in — even years into development.
Top comments (1)
Awesome , thanks for this