foambubble/foam

Make foam respect the .gitignore file

Open

#1,388 opened on 2024年8月31日

GitHub で見る
 (8 comments) (2 reactions) (0 assignees)TypeScript (14,407 stars) (623 forks)batch import
good first issuehelp wanted

説明

Is your feature request related to a problem? Please describe.

The graph view plots all the files in the repository. This is a problem if the user has a virtual env installed in the repository, becuase it will plot all the .md files in the env. This also applies to wikilink autocompletion, where the pop-up will include all the files in the venv.

Describe the solution you'd like

Make foam respect the .gitignore file, meaning that the folders and files defined in .gitignore should be ignored by foam entirely.

Describe alternatives you've considered

The user could filter the filetypes in Foam > Files: Notes Extensions and use a custom filetype, but this is really not an alternative.

Screenshots or Videos

No response

コントリビューターガイド

技術スタック
typescript
領域
developer experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScriptVS Code APIGitignore patterns
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
To implement this feature, first examine how foam currently discovers files for graph view and wikilink autocompletion. Look at the file scanning logic in the workspace or graph module. Then integrate a gitignore parser, such as the 'ignore' or 'gitignore parser' npm package, to filter out ignored files. Ensure that changes apply consistently across both graph and autocompletion. Consider caching the parsed gitignore rules and watching for changes to .gitignore.