Skip to content
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

[Improve code]: CSpellの導入 #25

Open
sheep-snow opened this issue Mar 6, 2024 · 2 comments
Open

[Improve code]: CSpellの導入 #25

sheep-snow opened this issue Mar 6, 2024 · 2 comments
Labels
invalid This doesn't seem right Necessary Middle Priority Issue

Comments

@sheep-snow
Copy link

Where and how it seems bad?

コラボレーターのみなさんがTypoのチェックを簡単にできるように、スペルチェッカー CSPell の導入を提案します
https://cspell.org/

What it shoud become?

得られる結果

  • VSCode上で、辞書と固有名詞の無視リストにない単語がハイライトされるようになります
  • VSCode拡張 streetsidesoftware.code-spell-checker が推奨に挙がるのでコントリビューターに導入してもらいやすくなります

行うこと
VSCode拡張 と、CSpell 用のConfigfileを1ファイルワークスペース内に追加します。具体的には次の内容です。

.vscode/cspell.json

// CSpell: https://cspell.org/
{
    // Version of the setting file.  Always 0.2
    "version": "0.2",
    // current active spelling language
    "language": "en",
    // list of globs to specify which files are to be ignored.
    "ignorePaths": [
        "node_modules/**",
        "vscode-extension/**",
        ".git/objects/**",
        ".vscode/**",
        ".vscode-insiders/**"
    ],
    // list of words to be always considered correct
    "words": [
        "skyshare",
        "ogp",
        "Authorication",
        "upstash",
        "predeploy",
        "bluesky",
        "pagedb",
        "atproto",
        "atprotocol",
        "astro",
        "astrojs",
        "partytown",
        "rkey",
        "appspot",
        "ogpdev",
        "ogpprod",
        "eddb",
        "editdb"
    ],
    "enableFiletypes": [
        "json",
        "css",
        "node",
        "md",
        "typescript",
        "js"
    ]
}

.vscode/extensions.json

{
    "recommendations": [
        "streetsidesoftware.code-spell-checker",
    ]
}
@sheep-snow sheep-snow added the invalid This doesn't seem right label Mar 6, 2024
@nkte8
Copy link
Owner

nkte8 commented Mar 7, 2024

提案ありがとうございます! #27 の部分と同カテゴリとして検討します。コードルール制定で細かいコンポーネント名等も変わる可能性があり、辞書登録する単語の定義もこれに追従した方が良いと考えるためです。

@sheep-snow
Copy link
Author

お知らせありがとうございます、理解です!

@nkte8 nkte8 transferred this issue from nkte8/skyshare-archive Mar 13, 2024
@nkte8 nkte8 added the Necessary Middle Priority Issue label Mar 16, 2024
@nkte8 nkte8 removed their assignment Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right Necessary Middle Priority Issue
Projects
Status: No status
Development

No branches or pull requests

2 participants