wip: feat: Make foam respect the .gitignore file #1413

TieWay59 · 2024-11-20T04:06:25Z

…th management

TieWay59 · 2024-11-20T04:12:27Z

I have already fixed some issues with Uri.file and should replace it with something like Uri.joinPath for usage. I am not sure if this is a standard practice. @riccardoferretti

The current effect is that all ignored information is read upon program initialization:

However, if the ignore is updated, it will not refresh due to saving the file.

TODO：

Ensure that the semantics of the .gitignore file are correctly represented in glob ignore patterns.
Design logic so that updates to the ignore file are dynamically read when the command foam: update wikilink def is executed. I want to consult with @riccardoferretti on whether this is reasonable. What code locations should I refer to?

UPD： The .gitignore file is actually an extension of glob patterns, adding more path rules, comments, and negation features. I can easily parse comments, and negation features, and path rules might differ less from glob patterns.

riccardoferretti · 2024-11-20T18:56:18Z

Regarding point n.2 you can refer to how we handle changing the related configuration, e.g. foam.files.ignore - see extension.ts:93. Basically, i consider acceptable to ask the user to reload the window to apply the updates

TieWay59 · 2024-11-25T13:18:05Z

[foam.foam-vscode]: Cannot register 'foam.logging.level'. This property is already registered.

Activating extension 'foam.foam-vscode' failed: command 'foam-vscode.set-log-level' already exists.

@riccardoferretti Hello, I encountered a bug today while testing my modifications. I'd like to ask for some ideas on how to proceed. I've been running code that is essentially identical to this PR, and I'm still experiencing the issue.

2024-11-25 21:26:32 UPD I often encountered this issue during debugging before, and later deduced that it might be caused by the foam-lite plugin. After uninstalling it, the problem seemed to be temporarily resolved.

packages/foam-vscode/src/extension.ts

riccardoferretti

Left a few comments :)

riccardoferretti · 2024-11-26T09:23:21Z

packages/foam-vscode/src/services/editor.ts

@@ -201,6 +203,29 @@ export async function createMatcherAndDataStore(excludes: string[]): Promise<{
  const excludePatterns = new Map<string, string[]>();
  workspace.workspaceFolders.forEach(f => excludePatterns.set(f.name, []));

+  Logger.info('[wtw] Excluded patterns from settings: ' + excludes);
+  // Read .gitignore files and add patterns to excludePatterns
+  for (const folder of workspace.workspaceFolders) {


I don't think this block of code should live here, I would have it together with the rest of the configuration, in order to populate the excludePatterns variable, which is then fed into this fn.

I'll rework it later, can you hint me more about rest of the configuration ?

Sorry what do you mean? My understanding is that your blocker is only the notification to the user not working (and unfortunately I can't understand why that's the case) - am I missing something else?

oh yes, I was so blocked in the dispose problem, so I didn't give it actual implementation and everything else is still in the experiment stage. now I'm about to do it. I'll change a lot design in the next push, so I guess we can ignore this outdated change for now.

riccardoferretti · 2024-11-26T09:24:26Z

packages/foam-vscode/src/extension.ts

@@ -100,6 +100,13 @@ export async function activate(context: ExtensionContext) {
            'Foam: Reload the window to use the updated settings'
          );
        }
+      }),
+      // 2024-11-25 21:22:48 TODO wip not working as expected
+      workspace.createFileSystemWatcher('.gitignore').onDidChange(e => {


This needs to live inside context.subscriptions so that it's properly cleaned up afterwards

It's true! The issue is that the FileSystemWatcher may be disposed if it's not added to context.subscriptions. problem solved.

riccardoferretti · 2024-11-26T09:26:40Z

packages/foam-vscode/src/services/editor.ts

+  Logger.info('[wtw] Excluded patterns from settings: ' + excludes);
+  // Read .gitignore files and add patterns to excludePatterns
+  for (const folder of workspace.workspaceFolders) {
+    const gitignoreUri = Uri.joinPath(folder.uri, '.gitignore');


This path needs to be the same as the file(s) you are watching for changes. (this should be easy to do if you have both at the top level).
I would expect something like this in extension.ts:

compute .gitignore path(s)

extract exclude patterns from those

merge them with the regular configuration settings and use them in this fn

monitor the paths computed

packages/foam-vscode/src/extension.ts

…iles in the workspace

TieWay59 · 2024-11-28T10:09:33Z

packages/foam-vscode/src/extension.ts

+    const gitignoreFiles = await workspace.findFiles('**/.gitignore');
+
+    gitignoreFiles.forEach(gitignoreUri => {
+      try {
+        workspace.fs.stat(gitignoreUri); // Check if the file exists
+        const gitignoreContent = await workspace.fs.readFile(gitignoreUri);
+
+        // TODO maybe better to use a specific gitignore parser lib.
+        let ignore_rules = Buffer.from(gitignoreContent)
+          .toString('utf-8')
+          .split('\n')
+          .map(line => line.trim())
+          .filter(line => !isEmpty(line))
+          .filter(line => !line.startsWith('#'))
+          .forEach(line => excludes.push(line));
+
+        excludes.push(...ignore_rules);
+        Logger.info(
+          `Excluded patterns from ${gitignoreUri.path}: ${ignore_rules}`
+        );
+      } catch (error) {
+        Logger.error(`Error reading .gitignore file: ${error}`);
+      }
+    });


@riccardoferretti Do you think here is a reasonable place to calculate ignore rules? I tend to append them into exclude variable.

[info - 6:03:40 PM] [wtw] Starting Foam [info - 6:03:40 PM] [wtw] Excluded patterns from settings: **/.foam/**,**/.vscode/**/*,**/_layouts/**/*,**/_site/**/*,**/node_modules/**/*,**/.git,**/.svn,**/.hg,**/CVS,**/.DS_Store,**/Thumbs.db,**/.classpath,**/.factorypath,**/.project,**/.settings [info - 6:03:47 PM] Excluded patterns from /tmp/test_folder/.gitignore: ignored_note.md [info - 6:03:48 PM] Loading from directories: [info - 6:03:48 PM] - /tmp/test_folder [info - 6:03:48 PM] Include: **/* [info - 6:03:48 PM] Exclude: ignored_note.md,**/.foam/**,**/.vscode/**/*,**/_layouts/**/*,**/_site/**/*,**/node_modules/**/*,**/.git,**/.svn,**/.hg,**/CVS,**/.DS_Store,**/Thumbs.db,**/.classpath,**/.factorypath,**/.project,**/.settings [info - 6:03:49 PM] Workspace loaded in 1071ms [info - 6:03:49 PM] Graph loaded in 2ms [info - 6:03:49 PM] Tags loaded in 0ms [info - 6:03:49 PM] [wtw] Excluded patterns from settings: [info - 6:03:49 PM] [wtw] Excluded patterns from settings: [info - 6:03:49 PM] Loaded 2 resources [info - 6:03:50 PM] Excluded patterns from /tmp/test_folder/.gitignore: ignored_note.md [info - 6:03:50 PM] Excluded patterns from /tmp/test_folder/.gitignore: ignored_note.md

TieWay59 added 2 commits October 24, 2024 17:24

Add support for .gitignore file parsing to exclude patterns

74dc6c1

Refactor .gitignore file handling to use Uri.joinPath for improved pa…

68d2d37

…th management

wip: not working try

cf9a173

TieWay59 commented Nov 26, 2024

View reviewed changes

packages/foam-vscode/src/extension.ts Outdated Show resolved Hide resolved

riccardoferretti reviewed Nov 27, 2024

View reviewed changes

TieWay59 added 2 commits November 28, 2024 16:40

Add file system watcher for .gitignore changes to prompt reload

bd3051a

Enhance .gitignore handling by reading patterns from all .gitignore f…

ed3b0ae

…iles in the workspace

TieWay59 commented Nov 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wip: feat: Make foam respect the .gitignore file #1413

wip: feat: Make foam respect the .gitignore file #1413

TieWay59 commented Nov 20, 2024

TieWay59 commented Nov 20, 2024 •

edited

Loading

riccardoferretti commented Nov 20, 2024

TieWay59 commented Nov 25, 2024 •

edited

Loading

riccardoferretti left a comment

riccardoferretti Nov 26, 2024

TieWay59 Nov 28, 2024

riccardoferretti Nov 28, 2024

TieWay59 Nov 28, 2024

riccardoferretti Nov 26, 2024

TieWay59 Nov 28, 2024

riccardoferretti Nov 26, 2024

TieWay59 Nov 28, 2024

wip: feat: Make foam respect the .gitignore file #1413

Are you sure you want to change the base?

wip: feat: Make foam respect the .gitignore file #1413

Conversation

TieWay59 commented Nov 20, 2024

TieWay59 commented Nov 20, 2024 • edited Loading

riccardoferretti commented Nov 20, 2024

TieWay59 commented Nov 25, 2024 • edited Loading

riccardoferretti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TieWay59 commented Nov 20, 2024 •

edited

Loading

TieWay59 commented Nov 25, 2024 •

edited

Loading