nkte8 / skyshare

Bluesky API Client with OGP generator.
https://skyshare.uk/
BSD 3-Clause "New" or "Revised" License
31 stars 4 forks source link

[Improve code]: CSpellの導入 #25

Open sheep-snow opened 7 months ago

sheep-snow commented 7 months ago

Where and how it seems bad?

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

What it shoud become?

得られる結果

行うこと 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",
    ]
}
nkte8 commented 7 months ago

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

sheep-snow commented 7 months ago

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