🚐

テストコード内のコメントに絵文字を使うとちょっと見やすい✅️

に公開

小ネタです。

ちょっと複雑なテストの挙動を説明するために、コメントをつけることがあると思います。そのコメント内に絵文字をつけるとちょっと見やすい、という話です。

こちらが絵文字なし。

import { UserService } from 'path/to/service'
import { createMockUser } from 'path/to/testUtils'

describe("UserService", () => {
    it("getSomeone", () => {
        // 論理削除されているので無視される
        createMockUser({ id: 1, is_deleted: true })

        // 管理者なので無視される
        createMockUser({ id: 2, is_admin: true })

        // 後に作られた ID:4 の方が優先される
        createMockUser({ id: 3 })

        // 最新の一般ユーザーであり、このユーザーが選択される
        createMockUser({ id: 4 })

        const user = UserService.getSomeone()
        expect(user.id).toBe(4)
    })
})

こちらが絵文字あり。

import { UserService } from 'path/to/service'
import { createMockUser } from 'path/to/testUtils'

describe("UserService", () => {
    it("getSomeone", () => {
        // ❌️論理削除されているので無視される
        createMockUser({ id: 1, is_deleted: true })

        // ❌️管理者なので無視される
        createMockUser({ id: 2, is_admin: true })

        // ❌️後に作られた ID:4 の方が優先される
        createMockUser({ id: 3 })

        // ✅️最新の一般ユーザーであり、このユーザーが選択される
        createMockUser({ id: 4 })

        const user = UserService.getSomeone()
        expect(user.id).toBe(4)
    })
})

ちょっと見やすい✅️

Discussion