wemake-vue-template
Search…
Vue
We use a lot of non-standard things in our
Vue components. Here we would like to go through some most important parts.Nuxt
We use
Nuxt because it gives no overhead, but gives tons of features, including:- 1.server side rendering
- 2.single page applications
- 3.static assets generation
- 4.zero-configuration build tool
- 5.routing
- 6.middlewares
- 7.much more
We do not recommend to switch to raw
Vue, unless you 100% sure.nuxt-property-decorator
First of all, we use
classes to define components. We do it with the help of several libraries:- 1.
nuxt-property-decorator- pretty much the same asvue-class-component, but withnuxtspecific callbacks defined & allows defining some useful properties using decorators - 2.
This way we can achieve some level of type safety. It is not 100% safe. But it is something.
Make sure to mark your components as
// @vue/component to have at least some linting from eslint-plugin-vue.Fallback to good-old simple components
However, you can fallback to
export default {} at any time you want. This way you will have almost none type support, but you will have full linting support from eslint-plugin-vue which is a good thing. But, we will lose some of the typing features.Regular components would be also easier for newcomers. You can even mix styles for different components. So, the choice is yours.
vuex
vuex-simple
That's how it is defined:
1
import { Action, Mutation, State, Getter } from 'vuex-simple'
2
3
export default class TypedStore {
4
@State()
5
public comments: CommentType[] = []
6
7
@Getter()
8
public get hasComments (): boolean {
9
// ...
10
}
11
12
@Mutation()
13
public updateRating ({ commentId, delta }: CommentPayloadType): void {
14
// ...
15
}
16
17
@Action()
18
public async fetchComments (): Promise<RawCommentType[]> {
19
// ...
20
}
21
}
Copied!
And used:
1
import Vue from 'vue'
2
import { Component } from 'nuxt-property-decorator'
3
import { useStore } from 'vuex-simple'
4
5
// Import your store:
6
import TypedStore from '~/logic/store'
7
8
@Component({})
9
export default class ComponentName extends Vue {
10
// Later it can be used to perform typed actions, mutations, etc.
11
public typedStore: TypedStore = useStore(this.$store)
12
13
someButtonClicked (commentId: number): void {
14
// This call is fully typed: parameters and return value are known:
15
this.typedStore.updateRating({ commentId, 'delta': 1 })
16
}
17
}
Copied!
We actually provide a utility mixin to inject
typedStore into all components.vue-typedi
We also use dependency injection (DI) and inversion of control (IoC) principles to uncouple different layers of our app.
This allows to write simpler code, abstract things, and reuse code easier.
That's how it works:
1
// module.ts
2
3
import { Action } from 'vuex-simple'
4
import { Inject, Injectable } from 'vue-typedi'
5
6
import tokens from '~/logic/tokens'
7
import CommentService from '~/logic/comments/services/api'
8
9
@Injectable() // required to make class injectable (to have injections)
10
class CommentsModule {
11
@Inject(tokens.COMMENT_SERVICE) // tokens.COMMENT_SERVICE is a unique name
12
public service!: CommentService // we can also type the injected service
13
14
@Action()
15
public async fetchComments () {
16
// Here we use injected service, without explicitly passing it:
17
const commentsList = await this.service.fetchComments()
18
// ...
19
}
20
}
21
22
// services/api.ts
23
24
import { Service } from 'vue-typedi'
25
26
import tokens from '~/logic/tokens'
27
28
// Here we register our service under a unique name,
29
// it will be used to inject it later:
30
@Service(tokens.COMMENT_SERVICE)
31
class CommentService {
32
// ...
33
}
Copied!
You can easily mock things in your tests and provide different implementation by using this 100% valid way:
1
import { Container } from 'vue-typedi'
2
3
import tokens from '~/logic/tokens'
Copied!
Last modified 7mo ago