-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feat/#14 JS SDK mvp1을 제작한다 #35
Changes from all commits
415ccfd
7ee6059
8edd20f
4510d87
c09a3bb
b7de6f3
d2dbd11
12b799f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Dependency directories | ||
node_modules/ | ||
|
||
# Build output | ||
dist/ | ||
|
||
# Editor directories and files | ||
.idea | ||
.vscode | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? | ||
|
||
# OS generated files | ||
.DS_Store | ||
.DS_Store? | ||
._* | ||
.Spotlight-V100 | ||
.Trashes | ||
ehthumbs.db | ||
Thumbs.db | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# LogBat SDK | ||
|
||
LogBat SDK는 웹 애플리케이션에서 로그를 쉽게 수집하고 중앙 서버로 전송할 수 있게 해주는 JavaScript 라이브러리입니다. | ||
|
||
## 특징 | ||
|
||
- 간편한 초기화 및 설정 | ||
- `console.log`와 `console.error`의 자동 캡처 | ||
- 비동기 로그 전송으로 애플리케이션 성능 영향 최소화 | ||
- TypeScript 지원 | ||
|
||
## 설치 | ||
|
||
CDN을 통해 직접 스크립트를 포함할 수 있습니다: | ||
|
||
```html | ||
<script src="https://sdk.logbat.info/sdk.js"></script> | ||
``` | ||
|
||
## 사용법 | ||
|
||
### 초기화 | ||
|
||
LogBat SDK를 사용하기 전에 먼저 초기화해야 합니다: | ||
|
||
```html | ||
<script src="https://sdk.logbat.info/sdk.js"></script> | ||
<script> | ||
LogBat.init({ appId: 'YOUR_APP_ID' }); | ||
</script> | ||
``` | ||
|
||
### 로그 전송 | ||
|
||
초기화 후에는 `console.log`와 `console.error`가 자동으로 캡처되어 LogBat 서버로 전송됩니다: | ||
|
||
```javascript | ||
console.log('This is a log message'); | ||
console.error('This is an error message'); | ||
``` | ||
|
||
LogBat SDK의 메서드를 직접 사용할 수도 있습니다: | ||
|
||
```javascript | ||
LogBat.log('This is a direct log message'); | ||
LogBat.error('This is a direct error message'); | ||
``` | ||
|
||
## 주의사항 | ||
|
||
- SDK를 사용하기 전에 반드시 `init` 메서드를 호출해야 합니다. | ||
- `init` 메서드를 여러 번 호출해도 안전합니다. 중복 호출은 무시됩니다. | ||
- 로그 전송 실패는 애플리케이션의 정상적인 실행을 방해하지 않습니다. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 코드 패치에 대한 간단한 코드 리뷰입니다. 잠재적 버그 위험
개선 제안
이러한 점들을 고려하여 개선한다면 SDK의 안정성과 사용성을 높일 수 있을 것입니다. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
module.exports = { | ||
preset: 'ts-jest', | ||
testEnvironment: 'node', | ||
testMatch: ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'], | ||
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'], | ||
}; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 코드 패치를 검토해보겠습니다.
이 외에 특별한 버그 리스크는 없어 보이며, 전체적으로 문제 없는 설정입니다. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
코드 패치에 대한 간단한 리뷰입니다.
문법 및 형식: 패치는
.gitignore
파일을 추가하고 있는 것으로 보입니다. 전반적으로 형식이 잘 되어 있습니다.버그 위험: 현재로서는 명백한 버그는 없습니다. 하지만,
Thumbs.db
와 같은 특정 파일은 Windows에서만 생성되므로, 다른 운영 체제를 사용하는 경우에는 필요하지 않을 수 있습니다. 각 팀원의 OS에 맞춰 추가/제거할 필요가 있을 수 있습니다.개선 사항:
새 줄: 파일 끝에 새 줄이 없으므로, 이 점도 수정하는 것이 좋습니다. 대다수의 코드 스타일 가이드에서는 파일 끝에 빈 줄을 권장합니다.
전반적으로 잘 작성된 패치이며, 몇 가지 개선 포인트를 반영하면 더 좋을 듯합니다.