Allow unzipped source archives

Open
#1,324 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
tooling

Research direction

Start by reading the existing archive-filesystem-provider and its file-explorer behavior. Assess how a regular filesystem directory could use the same API as the zip-backed variant while remaining read-only. Done means unzipped database source folders can be displayed and interacted with without permitting edits, alongside existing zip files.

Written by the indexing model from the issue text.

Description

enhancement VSCode

Background

This feature request is about allowing unzipped database source archives in addition to zipped source archives. Historically, we allowed unzipped archives, but it was challenging to maintain multiple ways of interacting with sources as we grew the number of features that the extension supported. Also, users would sometimes inadvertently edit the unzipped sources and sometimes even expect that the database would be transparently updated to handle the new sources.

Previously, we had allowed unzipped database sources to be imported as regular folders into the project. This would signal to users that they could edit the sources, which should not be possible.

Proposal

Currently, we have created the archive-filesystem-provider, which displays the contents of zip files in the file explorer in read-only mode.

I think we should be able to extend archive-filesystem-provider so that there are two variants: one variant is backed by a zip file and the other is backed by a regular file system directory. Of course, this would mean that the name archive-filesystem-provider is no longer really appropriate, but that is a minor issue.

The benefit is that we can read in the source folder of a database and ensure that even though the file explorer points to regular files, everything is read-only. And we will also be able to interact with both kinds of filesystems through the same API even though they are differently implemented.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.