Implement .copilotignore support to ignore files

[TerminalFi]

No description provided.

[jfcherng]

As per #98 (comment), I think we should follow .copilotignore rather than invent our own.

As per https://github.com/orgs/community/discussions/10305#discussioncomment-6069843, it seems that .copilotignore already works in VSCode.

[timfjord]

It looks like this .copilotignore is basically a list of patterns to ignore in a format similar to the one introduced in the copilot_ignore setting.
So maybe we could rely on the .copilotignore by simply splitting it into lines and treating it like the copilot_ignore setting in the PR (we just need to think how to cache it properly)?

[TerminalFi]

@timfjord @jfcherng some progress. Probably worth you all testing. Still need to think about proper way to maybe log pattern matching and if this is global

[TerminalFi]

@jfcherng @timfjord I think we only need to cover somehow detecting new folders added to a window. And disabling text commands if file is ignored.

But does the decorator approach work well here?

[TerminalFi]

We could combine these decorators to maybe

def _must_be_active_view_not_ignored(*, failed_return: Any = None) -> Callable[[T_Callable], T_Callable]:
    def decorator(func: T_Callable) -> T_Callable:
        @wraps(func)
        def wrapped(self: Any, *arg, **kwargs) -> Any:
            if is_active_view(self.view) and not CopilotIgnore(self.view.window()).trigger(self.view):
                return func(self, *arg, **kwargs)
            return failed_return

        return cast(T_Callable, wrapped)

    return decorator

[jfcherng]

We could combine these decorators to maybe

It seems to make sense because .copilotignore works for all copilot features

[timfjord]

Maybe to avoid dealing with edge cases, we could add a separate command to manually reload the .copilotignore file

[TerminalFi]

@jfcherng I can't seem to run ci-fix ?

make ci-fix
========== fix: ruff (lint) ==========
ruff check --fix .
All checks passed!
========== fix: ruff (format) ==========
ruff format .
14 files left unchanged

[TerminalFi]

I was also thinking about updating statusbar LSP-copilot (ignored) if a file is ignored ? Thoughts?

[jfcherng]

@jfcherng I can't seem to run ci-fix ?

make ci-fix
========== fix: ruff (lint) ==========
ruff check --fix .
All checks passed!
========== fix: ruff (format) ==========
ruff format .
14 files left unchanged

it runs and nothing needs to be changed. it won't fix mypy issues for you.

[jfcherng]

Maybe to avoid dealing with edge cases, we could add a separate command to manually reload the .copilotignore file

I thought that we can have a ViewEventListener for view activation. When a view is activated (i.e., focused), read .copilotignore file and set is_copilot_ignored attribute to the view. Reading the file shouldn't take too much time.

[jfcherng]

I was also thinking about updating statusbar LSP-copilot (ignored) if a file is ignored ? Thoughts?

Following up, we can just read is_copilot_ignored attribute of the activated view. status_text is now a jinja2 template. It should be quite flexible.

[TerminalFi]

Maybe to avoid dealing with edge cases, we could add a separate command to manually reload the .copilotignore file

I thought that we can have a ViewEventListener for view activation. When a view is activated (focused), read .copilotignore file and set is_copilot_ignored attribute to the view. Reading the file shouldn't takes to much time.

I don't know that we need to read file per view. Probably need to update to ensure the following

1. File is read on new window
2. File is read when file is saved that name is .copilotignore
3. File is read when new folder added to window

Can 3. be achieved?

[jfcherng]

I just made a renaming 8308bc0

[jfcherng]

File is read when new folder added to window

This seems to be an issue if we go the watcher way.

[jfcherng]

Hmm.. users can drag sidebar folder to change to order of workspace folders. I guess this will break the current implementation?

[TerminalFi]

Hmm.. users can drag sidebar folder to change to order of workspace folders. I guess this will break the current implementation?

Why does order matter ? We store the folder prefix with its patterns. ?

[TerminalFi]

File is read when new folder added to window

This seems to be an issue if we go the watcher way.

Yeah, we need ST support to fix all
Caveats

[jfcherng]

I got the following error in console.

ValueError: ('is_enabled must return a bool', <LSP-copilot.plugin.commands.CopilotSignOutCommand object at 0x000002C0BB580EE0>)

[TerminalFi]

I got the following error in console.

ValueError: ('is_enabled must return a bool', <LSP-copilot.plugin.commands.CopilotSignOutCommand object at 0x000002C0BB580EE0>)

Yes, that is because of

    @_must_be_active_view_not_ignored()
    @_provide_plugin_session(failed_return=False)
    def is_enabled(self, plugin: CopilotPlugin, session: Session) -> bool:  # type: ignore
        return self._can_meet_requirement(session)

The decorator can be used @_must_be_active_view_not_ignored() I don't think.

We will need to disable certain text commands manually if ignored instead of a blanket decorator on all text commands