diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..2bf6741 --- /dev/null +++ b/.prettierignore @@ -0,0 +1 @@ +**/*.html diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..5d4a7d6 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,7 @@ +{ + "printWidth": 1000, + "tabWidth": 2, + "useTabs": false, + "singleQuote": false, + "htmlWhitespaceSensitivity": "css" +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..27aea9f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,13 @@ +{ + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true, + "[html]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[scss]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[javascript]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + } +} diff --git a/doc/개발환경.md b/doc/개발환경.md new file mode 100644 index 0000000..a670ef9 --- /dev/null +++ b/doc/개발환경.md @@ -0,0 +1,5 @@ +# 개발환경 + +- Node, Vite 최신버전 +- SCSS, JS, IMAGE 압축 빌드 +- Prettier \ No newline at end of file diff --git a/doc/코딩규칙.md b/doc/코딩규칙.md new file mode 100644 index 0000000..3712f01 --- /dev/null +++ b/doc/코딩규칙.md @@ -0,0 +1,20 @@ +# 코딩규칙 + +- 클래스명은 카멜케이스 키워드에 + BEM 방식 +- BEM 의 depth 는 2depth 까지만, 이후 단계에서는 BEM 생략 +- BEM 클래스만 병렬선언, 나머지는 BEM 클래스 안에 중첩 +- 태그에 스타일을 주지 않음. 클래스를 선언해서 매핑, reset 은 제외 + +ex) someThing, someThing__card, someThing__card__blockArea +ex) +.someThing { + img { + } +} + +.someThing__card { + .thumb { } +} + +(x) section--about +(x) section-about diff --git a/package.json b/package.json index a167f5f..354dcc5 100644 --- a/package.json +++ b/package.json @@ -6,12 +6,14 @@ "scripts": { "dev": "vite", "build": "vite build", - "preview": "vite preview" + "preview": "vite preview", + "format": "prettier --write src/**/*.scss src/**/*.js" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { + "prettier": "^3.8.4", "sass": "^1.101.0", "vite": "^8.0.16", "vite-plugin-imagemin": "^0.6.1"