npm - sales-frontend-gemini-cli - Versions diffs - 0.4.2 → 0.4.4 - Mend

sales-frontend-gemini-cli 0.4.2 → 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

package/dist/common/helper.cjs +581 -53
package/dist/common/helper.cjs.map +1 -1
package/dist/common/helper.d.cts +114 -3
package/dist/common/helper.d.ts +114 -3
package/dist/common/helper.js +570 -54
package/dist/common/helper.js.map +1 -1
package/dist/common/types.d.cts +24 -1
package/dist/common/types.d.ts +24 -1
package/dist/pr-review/claude/claude-commander.cjs +60 -12
package/dist/pr-review/claude/claude-commander.cjs.map +1 -1
package/dist/pr-review/claude/claude-commander.js +60 -12
package/dist/pr-review/claude/claude-commander.js.map +1 -1
package/dist/pr-review/claude/installation-claude.cjs +42 -6
package/dist/pr-review/claude/installation-claude.cjs.map +1 -1
package/dist/pr-review/claude/installation-claude.js +42 -6
package/dist/pr-review/claude/installation-claude.js.map +1 -1
package/dist/pr-review/codex/codex-commander.cjs +63 -12
package/dist/pr-review/codex/codex-commander.cjs.map +1 -1
package/dist/pr-review/codex/codex-commander.d.cts +1 -1
package/dist/pr-review/codex/codex-commander.d.ts +1 -1
package/dist/pr-review/codex/codex-commander.js +63 -12
package/dist/pr-review/codex/codex-commander.js.map +1 -1
package/dist/pr-review/codex/installation-codex.cjs +42 -6
package/dist/pr-review/codex/installation-codex.cjs.map +1 -1
package/dist/pr-review/codex/installation-codex.js +42 -6
package/dist/pr-review/codex/installation-codex.js.map +1 -1
package/dist/pr-review/gemini/gemini-commander.cjs +76 -16
package/dist/pr-review/gemini/gemini-commander.cjs.map +1 -1
package/dist/pr-review/gemini/gemini-commander.js +76 -16
package/dist/pr-review/gemini/gemini-commander.js.map +1 -1
package/dist/pr-review/gemini/installation-gemini.cjs +42 -6
package/dist/pr-review/gemini/installation-gemini.cjs.map +1 -1
package/dist/pr-review/gemini/installation-gemini.js +42 -6
package/dist/pr-review/gemini/installation-gemini.js.map +1 -1
package/dist/pr-review/review-one-by-one.cjs +699 -106
package/dist/pr-review/review-one-by-one.cjs.map +1 -1
package/dist/pr-review/review-one-by-one.js +700 -107
package/dist/pr-review/review-one-by-one.js.map +1 -1
package/dist/pr-review/review.cjs +722 -105
package/dist/pr-review/review.cjs.map +1 -1
package/dist/pr-review/review.js +722 -105
package/dist/pr-review/review.js.map +1 -1
package/package.json +4 -7
package/src/common/rules/coding-convention.md +393 -0
package/src/common/rules/coding-convention.pdf +0 -0
package/src/common/rules/naming-rule.md +347 -0
package/src/common/rules/naming-rule.pdf +0 -0

package/src/common/rules/coding-convention.md ADDED Viewed

@@ -0,0 +1,393 @@
+# 03-2. 코딩컨벤션
+영업플랫폼 프론트엔드 코딩컨벤션입니다.
+## HTML 컨벤션
+- html doctype + html lang 사용
+```html
+<!DOCTYPE html>
+<html lang="ko"></html>
+```
+- 모든 페이지에 title 정의
+```html
+<head>
+  <title>타이틀명</title>
+</head>
+```
+- header, nav, main, footer 등 시멘틱 요소 사용
+```html
+<!-- ✅ -->
+<header>
+  <div>...</div>
+</header>
+```
+- 모든 인터렉트 요소는 키보드로 접근이 되어야 한다.
+- 모든 이미지에는 alt 속성 사용, 장식용 이미지는 빈 alt='' 사용
+## CSS 컨벤션
+- 글로벌 css가 아니면 module.scss를 사용한다.
+- 영업지원 프론트엔드 StlyeLint에서 권장하는 rule set을 적용한다. (stylelint-config-dsp-frontend)
+```javascript
+// .stylelint.js
+module.exports = {
+  extends: ['stylelint-config-dsp-frontend']
+};
+```
+- 기본적으로 class 명 위주로 스타일링한다.
+```css
+/* ✅ */
+.something {
+}
+/* ⚠️ */
+#something {
+}
+/* ⚠️ */
+div {
+}
+```
+- variant가 필요한 부분은 -{varient or modifier}를 붙여서 스타일링한다.
+- 공통에서는 엄격하게. 나머지는 자유롭게 사용
+```css
+.{컴포넌트명}-{varient or modifier} {
+}
+/* 예 */
+.somehting-large {
+}
+.somehting-outline {
+}
+.somehting-warning {
+}
+```
+- 피그마 상 변수로 참조되고 있는 부분은 design-system-context.scss를 import 하여 사용한다. (하드코딩 지양)
+```scss
+@use '@dsp-frontend/design-system-context' as *;
+.something {
+  color: colors(surface-primary);
+}
+```
+- 인라인 스타일은 가급적 사용하지 않는다.
+```javascript
+<button style={{ color: 'red' }}>...</button>
+```
+- !important 사용은 의미 그대로 정말 필요한 곳이 아니면 사용하지 않는다. (CSS의 순수한 철학 무시 개념이므로)
+```css
+.something {
+  /* ⚠️ 반드시 필요한 상황인가? 확인할 것. */
+  color: blue !important;
+}
+```
+- 기본 단위는 rem, 무조건 고정이여야하는 px
+```css
+.something {
+  /* ✅ root font-size에 따라 가변 */
+  width: 2rem;
+  /* ❌ root font-size에 따라 가변 */
+  width: 32px;
+  /* ✅ root font-size와 별개로 고정 */
+  border-radius: 8px;
+}
+```
+## Typescript 컨벤션
+- 영업지원 프론트엔드 ESLint에서 권장하는 rule set을 적용한다. (dsp-frontend-eslint-config-v8)
+```javascript
+// .eslintrc.js
+module.exports = {
+  extends: ['dsp-frontend-eslint-config-v8']
+};
+```
+- 주석은 Typesciprt와 관련된 것들은 /\*\* \*/ 로 작성한다. (상세하면 좋음)
+- \*\* 특히 타입의 경우 필드가 많아지는 경우 주석이 없으면 난해해짐
+```typescript
+// ✅ 주석사용
+/**
+ * 사용자정보
+ */
+interface IUserInfo {
+  /** 사용자 이름 */
+  name: string;
+}
+// ❌ 주석 미사용
+interface IUserInfo {
+  name: string;
+}
+/** http 상태 */
+type HttpStatus = 'success' | 'error';
+```
+- export
+- 기본 named export 사용 (사유: 자동완성 / 트리세이킹 최적화 / 명확한 구조)
+- Framework에서 export default 강제화하는 부분만 사용
+- 이슈가 발생시 "import/de-default-export" 린트 룰을 적용할 수 있음
+```typescript
+// ✅ 함수
+export getUserName = () => {...}
+// ✅ 컴포넌트
+export UserName = () => {...}
+// ⚡️ Page 컴포넌트 (framework에서 강제하는 부분)
+export default function Page(){...}
+```
+- import
+- import/order ESLint의 권장사항에 따른다.
+- 디스트럭처링
+- 특별한 조건이 없는 경우 객체와 배열의 디스트럭처링을 사용한다.
+```javascript
+const user = { name: '김한화', age: 30 };
+const numbers = [1, 2, 3, 4, 5];
+// ✅
+const { name, age } = user;
+// ❌
+const name = user.name;
+const age = user.age;
+// ✅
+const [first, second] = numbers;
+// ❌
+const first = numbers[0];
+const second = numbers[1];
+```
+## React Component 컨벤션
+- 기본 컨셉/방향
+- 단일 책임을 완수하는 컴포넌트를 만들 것(특히, 공통컴포넌트)
+- YAGNI 원칙(지금 필요한 것만 구현) & 점진적 개선
+- 책임이 여려개면 책임 개수 만큼 생성
+- props가 거대해지는 것 지양
+```javascript
+// ✅
+<Alert.Root>
+<Alert.Indicator />
+<Alert.Content>
+<Alert.Title />
+<Alert.Description />
+</Alert.Content>
+</Alert.Root>
+// ⚠️
+<Alert />
+```
+- 공통 컴포넌트가 아닌 것들은 페이지 단위(큰 덩어리로) 개발 진행 (계속 사용되는 부분이 생기면 그 때 공통화 진행)
+```javascript
+<article>
+  <section className="storybook-page">
+    <h2>Pages in Storybook</h2>
+    ...
+  </section>
+</article>
+```
+- 컴포넌트/함수 모두 화살표 함수를 기본으로 함(framework에서 강제하는 부분 제외)
+```javascript
+// ✅ 순수 함수
+const getUserName = () => {...}
+// ⚠️ function (가급적 arrow)
+function handleSubmit() { ... }
+// ✅ 컴포넌트
+const UserName = () => { return <>...</> }
+// ☑️ Page 컴포넌트(framework에서 강제하는 부분은 framework룰대로 따름)
+export default function Page() {...}
+```
+- 함수형 컴포넌트
+- 기본 함수형 컴포넌트를 사용하며, 클래스형 컴포넌트는 사용하지 않는다.
+- 클래스 형 컴포넌트는 내장 컴포넌트를 상속 받는 용도로만 사용한다.
+- Props
+- 타입을 정의하여 사용한다.
+- 외부 사용이 필요한 타입은 별도의 파일(.types.ts)에서 export 한다.
+- 컴포넌트명 + Props 접미사 사용
+```typescript
+// ✅ Props Type(주석 필수)
+/**
+* Props 설명
+*/
+interface UserNameProps {
+/** 아이템 설명 */
+onUserNameSubmit:() => void;
+}
+// ✅ 컴포넌트
+const UserName = ({ onUserNameSubmit }: UserNameProps) => { return <>...</>}
+```
+- 핸들러 네이밍은 on 접두사 사용
+```typescript
+// ✅ Props Type(주석 필수)
+interface UserNameProps {
+onUserNameSubmit:() => void;
+}
+// ✅ 컴포넌트
+const UserName = ({ onUserNameSubmit }: UserNameProps) => { return <>...</>}
+```
+- page 컴포넌트: 모두 조립된 하나의 컴포넌트를 리턴(Page 파일 자체가 복잡해지는 것을 지양)
+```javascript
+import { SomePage } from '@/components/pages/tablet/some-page';
+export default function Page() {
+  return <SomePage />;
+}
+```
+## 상태관리
+| 종류        | 사용 case                                                                                                                                                                                                                                                                                                                  |
+| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| useState    | **기본으로 사용**<br>• 컴포넌트 내부 스코프에서 종료 되므로 깔끔                                                                                                                                                                                                                                                           |
+| Context API | **컴포넌트간(부모, 자식), Page 스탭이 존재하는 경우**<br>• 스코프가 기능 단위로 제한되고 사용 종료와 함께 자동 해제 되므로 상태가 기능 단위로 생성되고 종료됨                                                                                                                                                              |
+| Zustand     | **정말 전역적으로 사용이 필요할 때 사용. 어떤 곳에서든 접근이 필요한 기능**<br>• 적절한 사용처: 로그인 정보(이름, AT), 클라이언트 상태(브라우저 버전, 종류 등)<br>• 특정 기능이 전역적인 사용이 필요 없게되는 경우, 수동 cleanup 필요<br>• cleanup을 보장하지 않으면 전역적으로 데이터가 남아 있음으로 인한 버그 발생 우려 |
+## API 관련
+- 기본 규격
+```
+# template
+api
+└── domains
+    └── {domain} # backend 업무 도메인
+        └──{domain}.mock.data.ts # mock data(fe 전용)
+        └──{domain}.mock.handler.ts # mock function
+        └──{domain}.dto.ts # Request/Response type(Swagger Naming)
+        └──{domain}.service.ts # BackEnd API Aync Method
+        └──use{domain}Query.tsx # React Query
+```
+- 예제
+```
+# example
+api
+└── domains
+    └── user
+        └──user.mock.data.ts
+        └──user.mock.handler.ts
+        └──user.dto.ts
+        └──user.service.ts
+        └──useUserQuery.tsx
+```
+- 비동기 함수 + React Query 관련
+```typescript
+// ✅ 비동기 함수
+const getTestUser = async (params: IUserRequest): Promise<IUserResponse> => {...}
+// ✅ React-Query
+const useTestUserQuery = () => {...}
+// ✅ 비동기 함수(Mutation)
+const updateTestUser = async (params: IUserRequest): Promise<IUserResponse> => {...}
+// ✅ React-Query(mutation)
+const useUpdateTestUserQuery = () => {... useMutation()...}
+```
+## Commit
+- 컨벤셔널커밋을 기본으로 따른다.
+- 명확한 히스토리를 생성하기 위한 가벼운 규칙
+- 기본 포맷
+```
+<타입>[적용 범위(선택 사항)]: <설명: (SR 선택사항)>
+[본문(선택 사항)]
+[꼬리말(선택 사항)]
+```
+- 타입
+  a. fix: 코드베이스에서 버그를 패치하는 fix 타입의 커밋(PATCH와 관련)
+  b. feat: 코드베이스에서 새 기능이 추가되는 feat 타입의 커밋(MINOR와 관련)
+  c. BREAKING CHANGE: 꼬리말을 가지거나 타입/스코프 뒤에 !문자열을 붙인 커밋은 단절적 변경이 있다는 의미(MAJOR와 관련)
+  d. 이외 chore:, docs:, style:, refactor, perf: test: 등의 타입을 사용할 것을 권고
+- 본문이 없는 커밋 메시지
+```
+git commit -m "feat: 영업플랫폼 전자청약 대면동의서 기능 추가"
+```
+- 적용 범위를 가지는 커밋 메시지
+```
+git commit -m "feat(태블릿): 영업플랫폼 전자청약 대면동의서 기능 추가"
+```
+- SR 번호가 있는 커밋 메시지
+```
+git commit -m "feat(태블릿): (SR-12345)영업플랫폼 전자청약 대면동의서 기능 추가"
+```
+- 설명과 BREAKING CHANGE 꼬리말을 가지는 커밋 메시지
+```
+git commit -m feat: 기능추가
+BREAKING CHANGE: 대격변이 일어납니다.
+```
+- 단절적 변경(breaking change)에 주의를 주기 위해 !를 포함한 커밋 메시지
+```
+git commit -m "feat!: 대격변이 일어나요"
+git commit -m "feat(api)!: API쪽 대격변입니다."
+```

package/src/common/rules/coding-convention.pdf ADDED Viewed

Binary file