chokidar icon indicating copy to clipboard operation
chokidar copied to clipboard

Published 20 hours ago • verified publisher icon paulmillr

Looking for new contributors and maintainers

Open paulmillr opened this issue 1 year ago • 10 comments
trafficstars

We are looking for folks who are able to:

  1. Fix CI tests
  2. Simplify the code (#1195)
  3. Fix current bugs

Any contributions are highly appreciated.

paulmillr avatar Feb 09 '24 13:02 paulmillr

Hi @paulmillr

I can take a look at 1 to start.

ben-polinsky avatar Feb 12 '24 14:02 ben-polinsky

@ben-polinsky great!

paulmillr avatar Feb 12 '24 14:02 paulmillr

I'm new to Chokidar, but recently retired and looking for something to contribute to.

I'll be happy to look at code simplification and at least fix symlink bug https://github.com/paulmillr/chokidar/issues/967. I'm running into issues with that now with typed-css-modules (PR for workaround).

samuelneff avatar Feb 14 '24 17:02 samuelneff

@samuelneff nice

paulmillr avatar Feb 14 '24 18:02 paulmillr

My first PR. 😄

https://github.com/paulmillr/chokidar/pull/1307

samuelneff avatar Feb 14 '24 22:02 samuelneff

Did all the tests work at some point? I've fixed two and am looking into a third breaking test.

should survive ENOENT for missing symlinks when followSymlinks:false

  • Verified the code is doing the right thing and the test had incorrect expectations.
  • Since we're not following symlinks then we don't care about the target of the symlink and only treat the symlink itself as a file.
  • Even though the target of the symlink doesn't exist anymore, the symlink itself as a file does exist and is a valid file.
  • I adjusted the test to match this expectation.

should watch symlinks within a watched dir as files when followSymlinks:false

  • Fixed underlying issue.
  • Readdirp still broadcasts events for watched symlink folders even when we are not following symlinks.
  • We want to treat the symlink as a file and ignore any events for contents of the symlink'd folder.
  • To do this I'm using the existing _symlinkPaths map to track symlink'd folders for the purpose of ignoring their contents later on.
  • This map was previously unused when not following symlinks.

should detect changes to symlink folders, even if they were deleted before

  • I'm a bit confused by this one so far.
  • fsevents dispatches a root_changed event when the files inside the symlink are changed but this event isn't handled at all.
  • No other events are being broadcast.

I'll look into this one and the others next week. Please let me know if you want a PR for the ones I've worked on so far or if I should hold off until all are fixed.

samuelneff avatar Feb 15 '24 23:02 samuelneff

please make a pr with everything at once. thanks.

paulmillr avatar Feb 16 '24 00:02 paulmillr

@ben-polinsky Sorry I forgot you said you were going to look at CI tests. Have you had time to start yet? We can collaborate if you like. I've worked on the three mentioned above.

You can write to me directly if you prefer; [email protected].

samuelneff avatar Feb 16 '24 14:02 samuelneff

perhaps the best thing to do would be to open a pull request and add Samuel to the fork's collaborators

paulmillr avatar Feb 16 '24 15:02 paulmillr

@samuelneff no problem at all. I only had some time this week to take a look at should survive ENOENT for missing symlinks when followSymlinks:false and came to the same conclusion as you. Didn't test on older versions of node, but did test on both M1 and Intel macs (same result).

Happy to work on the DTS Linting issue if you haven't started.

ben-polinsky avatar Feb 17 '24 17:02 ben-polinsky