"If a worker wants to do his job well, he must first sharpen his tools." - Confucius, "The Analects of Confucius. Lu Linggong"
Front page > Programming > General Coding Standards for Vue js.

General Coding Standards for Vue js.

Published on 2024-08-16
Browse:718

General Coding Standards for Vue js.

Here are additional good and bad practices for Vue.js:

General Coding Standards

  1. Avoid Magic Numbers and Strings:
    • Use constants for values that are used repeatedly or have special meaning.
   // Good
   const MAX_ITEMS = 10;

   function addItem(item) {
     if (items.length 



  1. Use v-for Efficiently:
    • When using v-for, always provide a unique key to optimize rendering.
   
   
{{ item.name }}
{{ item.name }}
  1. Avoid Inline Styles:
    • Prefer using CSS classes over inline styles for better maintainability.
   
   
{{ item.name }}
{{ item.name }}

Component Practices

  1. Component Reusability:
    • Design components to be reusable and configurable through props.
   // Good
   

   // Bad
   
  1. Prop Validation:
    • Always validate props using type and required attributes.
   // Good
   props: {
     title: {
       type: String,
       required: true
     },
     age: {
       type: Number,
       default: 0
     }
   }

   // Bad
   props: {
     title: String,
     age: Number
   }
  1. Avoid Long Methods:
    • Break down long methods into smaller, more manageable methods.
   // Good
   methods: {
     fetchData() {
       this.fetchUserData();
       this.fetchPostsData();
     },
     async fetchUserData() { ... },
     async fetchPostsData() { ... }
   }

   // Bad
   methods: {
     async fetchData() {
       const userResponse = await fetch('api/user');
       this.user = await userResponse.json();
       const postsResponse = await fetch('api/posts');
       this.posts = await postsResponse.json();
     }
   }
  1. Avoid Computed Properties with Side Effects:
    • Computed properties should be used for pure computations and not for side effects.
   // Good
   computed: {
     fullName() {
       return `${this.firstName} ${this.lastName}`;
     }
   }

   // Bad
   computed: {
     fetchData() {
       // Side effect: fetch data inside a computed property
       this.fetchUserData();
       return this.user;
     }
   }

Template Practices

  1. Use v-show vs v-if:
    • Use v-show for toggling visibility without adding/removing elements from the DOM, and v-if when conditionally rendering elements.
   
   
Content
Content
Content
  1. Avoid Large Templates:
    • Keep templates clean and small; break them into smaller components if they become too large.
   
   

State Management Practices

  1. Use Vuex for State Management:
    • Use Vuex for managing complex state across multiple components.
   // Good
   // store.js
   export default new Vuex.Store({
     state: { user: {} },
     mutations: {
       setUser(state, user) {
         state.user = user;
       }
     },
     actions: {
       async fetchUser({ commit }) {
         const user = await fetchUserData();
         commit('setUser', user);
       }
     }
   });
  1. Avoid Direct State Mutation in Components:
    • Use mutations to modify Vuex state rather than directly mutating state in components.
   // Good
   methods: {
     updateUser() {
       this.$store.commit('setUser', newUser);
     }
   }

   // Bad
   methods: {
     updateUser() {
       this.$store.state.user = newUser; // Direct mutation
     }
   }

Error Handling and Debugging

  1. Global Error Handling:
    • Use Vue’s global error handler for catching and handling errors.
   Vue.config.errorHandler = function (err, vm, info) {
     console.error('Vue error:', err);
   };
  1. Provide User Feedback:
    • Provide clear feedback to users when an error occurs.
   // Good
   methods: {
     async fetchData() {
       try {
         const data = await fetchData();
         this.data = data;
       } catch (error) {
         this.errorMessage = 'Failed to load data. Please try again.';
       }
     }
   }

   // Bad
   methods: {
     async fetchData() {
       try {
         this.data = await fetchData();
       } catch (error) {
         console.error('Error fetching data:', error);
       }
     }
   }

By adhering to these additional practices, you can further enhance the quality, maintainability, and efficiency of your Vue.js applications.

Release Statement This article is reproduced at: https://dev.to/dharamgfx/general-coding-standards-for-vue-js-1e0n?1 If there is any infringement, please contact [email protected] to delete it
Latest tutorial More>

Disclaimer: All resources provided are partly from the Internet. If there is any infringement of your copyright or other rights and interests, please explain the detailed reasons and provide proof of copyright or rights and interests and then send it to the email: [email protected] We will handle it for you as soon as possible.

Copyright© 2022 湘ICP备2022001581号-3