Repository navigation
π Coding Convention
λ³μ λ° ν¨μλ μΉ΄λ© μΌμ΄μ€λ₯Ό μ¬μ©νλ€.
const count = 1
const totalCount = 1
function onClick(){}μ»΄ν¬λνΈ λ° class λ νμ€μΉΌ μΌμ΄μ€λ₯Ό μ¬μ©νλ€.
export default function MainComponent() {}
class ChannelService {}μ μ μΌλ‘ μ μΈλλ μμλ μλ¬Έ λλ¬Έμ μ€λ€μ΄ν¬ μΌμ΄μ€λ₯Ό μ¬μ©νλ€.
const MAX_COUNT = 100enum μ μλ¬Έ λλ¬Έμ μ€λ€μ΄ν¬ μΌμ΄μ€λ₯Ό μ¬μ©νλ€.
enum ERROR_CODESλ¨μ΄λ₯Ό μΆμ½νμ§ μκ³ μ΅λν μμΈν λͺ λͺ νλ€.
// Bad
let totalCnt
let selectedIdx
// Good
let totalCount
let selectedIndex
// μ΄λ° κ²½μ° νμ©
let addressInfoμ μΆνκΈ° μ΄λ €μ΄ μ΄λ¦μ μ¬μ©νμ§ μλλ€.
// Bad
let a
let ls
let qs볡μλ₯Ό λνλ΄λ λ³μλͺ
μ λ¨μ+Listλ₯Ό μ¬μ©νλ€
// Bad
const categories
const users
// Good
const categoryList
const userListμ μλ³μ μ¬μ©μ μ΅λν μ§μνλ€.
// Bad
myGlobalVariable = true
window.myGlobalVariable = truevarλ₯Ό μ¬μ©νμ§ μλλ€.
// Bad
var index
// Good
let indexboolean λ³μμ ννλ μλμ κ°λ€. μ»΄ν¬λνΈμμλ HTML Attribute νμμ μ΅λν μ¬μ©νλ€.
// Good
let isOpen
let hasContent
let shouldRenderIcon
let needPassword
// μ»΄ν¬λνΈμμ νμ©
let disabled
let opened
let showButtonν¨μμ μ μΈμ νμ΄ν ν¨μλ₯Ό κΆμ₯νλ€.
const getData = () => {}ν¨μμ νν΄ TSDoc νμ©νλλ‘ λ Έλ ₯νλ€.
/**
* Returns data
*
* @param key - data key
* @returns data
*/
function getData(key) {}λ§€κ°λ³μλ 3κ°κΉμ§λ§ μ¬μ©νκ³ κ·Έ μ΄μμ object νμμ νμ©νλ€.
// Good
function getResult(a, b, c)
function getResult(dataObject)
function getResult({ a, b, c, d})μ΄λ²€νΈ ν¨μλ handle + [λμ/λλ©μΈ] + [λμ(μ ν)]
`handleSearch`, `handleLogin`
`handleUserDelete`, `handleModalOpen`μ»΄ν¬λνΈμ μ μΈμ νμ΄ν ν¨μλ₯Ό κΆμ₯νλ€.
const App = () => {}
export default Appμ΄λ²€νΈ νΈλ€λ¬μ μ΄λ¦μ handle λ‘ μμνλ€.
const handleClick = () => {}if-else λ‘ μ΄λ£¨μ΄μ§ 쑰건μμ early return μ νμ©νλ€.
// Bad
if(value !== null) {
...logic
}
// Good
if(value === null) return
... logicλ³μλ₯Ό νμ©νμ¬ λ¬Έμμ΄μ μ‘°ν©ν κ²½μ° ν νλ¦Ώ λ¬Έμμ΄μ μ¬μ©νλ€.
// Bad
return "i am" + name
// Good
return `i am ${name}` λ±νΈλ μΌμ€ λ±νΈ(===, !==) λ§ μ¬μ©νλλ‘ νλ€.
// Bad
if(value1 == value2)
// Good
if(value1 === value2) νμ
μΈ κ²½μ° import type μΌλ‘ μ¬μ©νλ€.
// Bad
import { Data, DataType } from './Data'
import { DocumentType } from './Document'
// Good
import { Data } from './Data'
import type { DataType } from './Data'
import type { DocumentType } from './Document'import λ¬ΈμΌλ‘λΆν° μ§μ export νμ§ μλλ€.
// Bad
export * from './data'
// Good
import { data } from './data'
export { data }-
ν΄λ μλͺ
- μ€λ€μ΄ν¬ μΌμ΄μ€
user_auth
- μ€λ€μ΄ν¬ μΌμ΄μ€
-
νμΌ
- μ»΄ν¬λνΈ : νμ€μΉΌμΌμ΄μ€ :
UserItem.tsx,UserList.tsx - ν¨μ : μΉ΄λ©μΌμ΄μ€.ts
- ν : useμΉ΄λ©μΌμ΄μ€.ts
- μ»΄ν¬λνΈ : νμ€μΉΌμΌμ΄μ€ :