search

toss / es-hangul

A modern JavaScript library for handling Hangul characters.
https://es-hangul.slash.page/
MIT License
1.24k stars 83 forks source link

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

Closed manudeli closed 2 months ago

manudeli commented 2 months ago

related with #121

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

Overview

image

PR Checklist

  1. I have read the Contributing Guide
  2. I have written documents and tests, if needed.
vercel[bot] commented 2 months ago

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[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: d884e345be12cf0cb90b129eeb44a763a30ee593

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 commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/toss/es-hangul/pull/164/graphs/tree.svg?width=650&height=150&src=pr&token=My9jTW6bSr&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss)](https://app.codecov.io/gh/toss/es-hangul/pull/164?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ Coverage Diff @@ ## main #164 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 16 16 Lines 260 260 Branches 58 58 ========================================= Hits 260 260 ```
manudeli commented 2 months ago

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

manudeli commented 2 months ago

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로 잡아내면 좋겠다는 생각이긴 합니다

minsoo-web commented 2 months ago

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