chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 #164

manudeli · 2024-07-03T07:40:46Z

related with #121

일관된 이름 짓기 규칙를 만드는 것 뿐 아니라 eslint룰로 체크해서 방지하면 미연에 문제를 방지할 수 있을 것 같아요

Overview

PR Checklist

I read and included theses actions below

I have read the Contributing Guide
I have written documents and tests, if needed.

vercel · 2024-07-03T07:40:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
es-hangul	❌ Failed (Inspect)			Jul 4, 2024 2:47pm

changeset-bot · 2024-07-03T07:40:50Z

⚠️ No Changeset found

Latest commit: d884e34

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codecov-commenter · 2024-07-03T07:44:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8f7cc9a) to head (d884e34).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #164   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines          260       260           
  Branches        58        58           
=========================================
  Hits           260       260

manudeli

의도를 코멘트로 남겨요

manudeli · 2024-07-03T07:44:49Z

.eslintrc.js

+      {
+        cspell: {
+          // eslint-disable-next-line @cspell/spellchecker
+          flagWords: ['chosung', 'jungsung', 'jongsung'],


현재 알고 있는 잘못된 네이밍은 'chosung', 'jungsung', 'jongsung'가 있습니다. 필요한 것은 점진적으로 추가해서 금지된 네이밍을 방지하면 좋을 것 같아요

manudeli · 2024-07-03T07:46:32Z

현재 circle ci에서 eslint체크가 제대로 동작하지 않고 있는데 그것은 다음 PR애서 잘되도록 수정하는 것이면 좋겠습니다

minsoo-web

eslint 설정으로 words를 정의하면, 해당 단어들은 eslint 에서만 에러가 발생하지 않게 됩니다.
다르게 말하면, vscode extension에서는 파란색 줄로 에러표현이 계속 나타나게 되어요.

최상단 루트경로에 cspell.json 으로 words 를 정의할 수 있는데 해당 방법은 어떨까요?
https://cspell.org/docs/getting-started/#1-create-a-configuration-file

manudeli · 2024-07-04T14:50:33Z

eslint 설정으로 words를 정의하면, 해당 단어들은 eslint 에서만 에러가 발생하지 않게 됩니다. 다르게 말하면, vscode extension에서는 파란색 줄로 에러표현이 계속 나타나게 되어요.

최상단 루트경로에 cspell.json 으로 words 를 정의할 수 있는데 해당 방법은 어떨까요? https://cspell.org/docs/getting-started/#1-create-a-configuration-file

VSCode Extension 사용자의 관점에서 좋은 의견 감사합니다. 제 생각은 VSCode Extension은 사용하지 않는 사람도 많기도 하고 eslint 에러로 규정하고 싶은 이유는 이 단어들을 PR단에서 애초에 걸러낼 수 있으면 좋겠다는 생각이에요. 그래서 eslint로 잡아내면 좋겠다는 생각이긴 합니다

okinawaa

감사합니당!!

minsoo-web · 2024-07-05T09:43:15Z

@manudeli
cspell.json 으로 words 를 정의하면 eslint 설정도 같이 되는데 (vscode extension과 함께), eslint 설정으로만 유지할 필요가 있나요? 🤔

* chore(eslint): add cspell to check bad naming * chore: update

* fix. 겹모음과 관련된 이상 현상들 수정 * fix. fix index * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 업데이트 로직 반영 * test: internal 테스트 코드를 작성합니다 (#137) * test: internal 테스트 코드를 작성합니다 * test: vitest에서 제공해주는 toThrowError로 변경 --------- Co-authored-by: 박찬혁 <[email protected]> * docs: josa에 관련된 문서에 잘못된 부분을 수정합니다 - '이에/에' 삭제 Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#143) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 한글 문자열에 대한 검증, assert, parsing 함수를 구현합니다. (#136) * feat: 한글 문자열인지 boolean 반환 함수 * feat: 한글 문자열인지 assert 함수 * feat: stringify * test: isHangulString, assertHangulString 테스트 코드 * feat: parse 함수 * test: parse 함수 테스트 * refactor: naming 통일 * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) (#133) * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 * test 및 함수 추가 * add : 한글 문장인지 여부 판별 함수 추가 * fix : 한글 문장인지 여부 판별 기저 및 오류 추가 / arg 이름 변경 test 추가 * fix: src/_internal/hangul.ts Co-authored-by: 박찬혁 <[email protected]> * fix : rename function getFirstHangulLetters -> getHangulAcronym * fix : rename function export function isHangulOnly로 변경 * fix : lint error * fix : index에 추가 * chore : doc 추가 * fix : 문서화 한글 영어 바뀐거 바로 변경 * fix : isHangul로 대체 #136 으로 * chore : doc수정 * Update docs/src/pages/docs/api/getHangulAcronym.en.mdx Co-authored-by: 박찬혁 <[email protected]> * fix : Update hangul.ts 안쓰는 메소드 삭제 * Update getHangulAcronym.ko.mdx * Update getHangulAcronym.en.mdx * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update getHangulAcronym.ts * Update getHangulAcronym.spec.ts * Create fair-brooms-drive.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#145) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. (#130) * feat: parseHangul * fix: parseHangul의 이름을 extractHangul로 수정 및 테스트 코드 보완 * test: 일관된 테스트 코드 작성이 될 수 있도록 describe 설명 수정 * test: 테스트 코드 수정 * docs: extractHangul의 문서 작성 * test: 테스트 문구 수정 * fix: index.ts에 export 추가 * Create fresh-students-sit.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#146) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix : getHangulacronym함수를 acronymizeHangul 메서드로 대체합니다. (#148) * Update and rename getHangulAcronym.ts to acronymizeHangul.ts * Update and rename getHangulAcronym.spec.ts to acronymizeHangul.spec.ts * Update index.ts * Update and rename getHangulAcronym.en.mdx to acronymizeHangul.en.mdx * Update and rename getHangulAcronym.ko.mdx to acronymizeHangul.ko.mdx * Create odd-squids-sin.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#150) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 (#144) * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 * docs: amountToHangul의 영어 문서 작성 * Create famous-cheetahs-sneeze.md * Update famous-cheetahs-sneeze.md --------- Co-authored-by: 박찬혁 <[email protected]> * fix: packlint ESLint error (#149) * test: utils 기능들의 테스트 케이스를 개선합니다 (#151) * test: hasBatchim 함수의 테스트 케이스를 추가합니다 * test: hasSingleBatchim의 테스트 케이스를 추가합니다 * fix: nextra theme asset 개선 (#152) * chore: version packages (#153) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 패키지가 노출하는 인터페이스를 명확히 하기 위해 index.ts를 named export로 수정합니다 (#157) * fix: exposing public apis strictly * Create wild-cows-juggle.md * chore: version packages (#160) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * docs: CONTRIBUTING.md 파일에 메서드 컨벤션을 작성합니다. (#132) * Update CONTRIBUTING.md * fix * write contribution.md Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> --------- Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> * test: amountToHangul 테스트 추가 (#135) * test: amountToHangul 테스트 추가 * test: amountToHangul 테스트 코드 수정 * test: amountToHangul 테스트 코드 스타일 변경 * test: amountToHangul test 개선 * fix: assert.throws대신 vitest toThrow로 메서드 변경 * fix: vitest toThrowError 메서드로 변경 --------- Co-authored-by: kinndohyun <[email protected]> Co-authored-by: 박찬혁 <[email protected]> * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 (#159) * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 * Create big-cups-call.md --------- Co-authored-by: 박찬혁 <[email protected]> * docs: acronymizeHangul 리턴 타입 표기 수정 (#161) * chore: version packages (#163) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 일관된 toThrowError 메서드 사용 (#166) Co-authored-by: kinndohyun <[email protected]> * chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 (#164) * chore(eslint): add cspell to check bad naming * chore: update * Create grumpy-singers-love.md --------- Co-authored-by: 박찬혁 <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jaemin Kim <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: seunghee <[email protected]> Co-authored-by: taehyun <[email protected]> Co-authored-by: SeongMin Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: 김도현 <[email protected]> Co-authored-by: kinndohyun <[email protected]> Co-authored-by: Song Hyo Jin <[email protected]> Co-authored-by: wnhlee <[email protected]>

chore(eslint): add cspell to check bad naming

3b52a1d

manudeli self-assigned this Jul 3, 2024

manudeli commented Jul 3, 2024

View reviewed changes

manudeli marked this pull request as ready for review July 3, 2024 07:46

manudeli requested review from okinawaa and raon0211 as code owners July 3, 2024 07:46

minsoo-web reviewed Jul 3, 2024

View reviewed changes

chore: update

606b474

vercel bot had a problem deploying to Preview July 3, 2024 08:09 Failure

Merge branch 'main' into chore/eslint-check-bad-naming

d884e34

vercel bot had a problem deploying to Preview July 4, 2024 14:47 Failure

okinawaa approved these changes Jul 5, 2024

View reviewed changes

okinawaa merged commit 16b77b2 into main Jul 5, 2024
9 of 10 checks passed

seungrodotlee pushed a commit to seungrodotlee/es-hangul that referenced this pull request Jul 6, 2024

chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 (toss#164)

fcba76d

* chore(eslint): add cspell to check bad naming * chore: update

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 #164

chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 #164

manudeli commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

codecov-commenter commented Jul 3, 2024 •

edited

Loading

manudeli left a comment

manudeli Jul 3, 2024

manudeli commented Jul 3, 2024

minsoo-web left a comment

manudeli commented Jul 4, 2024

okinawaa left a comment

minsoo-web commented Jul 5, 2024

chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 #164

chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 #164

Conversation

manudeli commented Jul 3, 2024 • edited Loading

Overview

PR Checklist

vercel bot commented Jul 3, 2024 • edited Loading

changeset-bot bot commented Jul 3, 2024 • edited Loading

⚠️ No Changeset found

codecov-commenter commented Jul 3, 2024 • edited Loading

Codecov Report

manudeli left a comment

Choose a reason for hiding this comment

manudeli Jul 3, 2024

Choose a reason for hiding this comment

manudeli commented Jul 3, 2024

minsoo-web left a comment

Choose a reason for hiding this comment

manudeli commented Jul 4, 2024

okinawaa left a comment

Choose a reason for hiding this comment

minsoo-web commented Jul 5, 2024

manudeli commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

codecov-commenter commented Jul 3, 2024 •

edited

Loading