list_enabled_extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a06e95534c9bd4d57500dbbff08e25d59f2837737cb0e2c11eb99bb72ff4ee4
+  data.tar.gz: 8ebde44c421028931f828ea2490cfd68a3840b3b7b0df54de6a12f5b8278c15b
+SHA512:
+  metadata.gz: 5cbb649c340505d1722d7b689b9714df83c9d54e59f7515c7ba2d6f7d11876c40d4a326eaebcaa5bff2c72076aab2726a7fb4eb26185141025c205e3c5a302b5
+  data.tar.gz: 794b9b169e86cbc06b1bd0d73354a3fce04828d348d1b7c4693cf1d7b8e9bea815b6a73e30c3132db53ba1eafa2c11f1235b20120be943e8fd070a6c8ce81309

data/.gitignore

@@ -0,0 +1,2 @@
+build/
+*gem

data/exe/list-enabled-extensions

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+load Pathname.new(__dir__).join('list_enabled_extensions').to_s

data/exe/list_enabled_extensions

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'pathname'
+require_relative '../lib/database_reader'
+require_relative '../lib/workspace_storage_finder'
+
+class CommandLineInterface
+  def initialize
+    @options = {}
+    parse_options
+  end
+
+  def run
+    if db_path
+      read_specific_db
+    else
+      search_for_db
+    end
+  rescue WorkspaceStorageFinder::Error, DatabaseReader::Error => e
+    $stderr.puts e.message
+    exit 1
+  end
+
+  private
+
+  def parse_options
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: find_workspace_hash [options] [workspace_path (default: current directory)]'
+
+      opts.on('--storage-path PATH', 'Path to the VSCode workspace storage (If not picked automatically or you changed it)') do |path|
+        @options[:workspaces_storage_path] = Pathname.new(path).expand_path
+      end
+
+      opts.on('--db-path PATH', 'Direct path of the state.vscdb file') do |path|
+        @options[:db_path] = Pathname.new(path).expand_path
+      end
+
+      opts.on('--sql-query SQL QUERY', "default: #{DatabaseReader.default_query}") do |path|
+        @options[:sql_query] = nil
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end.parse!
+  end
+
+  def read_specific_db
+    print_extensions_maybe(db_reader: db_reader(path: db_path))
+  end
+
+  def search_for_db
+    storage_finder = WorkspaceStorageFinder.new(path: workspaces_storage_path)
+    print_extensions_maybe(db_reader: db_reader(path: storage_finder.find_path(needle: current_workspace_path).join('state.vscdb')))
+  end
+
+  def print_extensions_maybe(db_reader:)
+    extensions = db_reader.extensions
+    if extensions.any?
+      puts "\e[38;5;10mFOUND EXTENSIONS:\e[0m"
+      extensions.each do |extension|
+        puts "#{extension}"
+      end
+    else
+      $stderr.puts "No extensions found in the database file '#{db_reader.path}'  ❌"
+      exit 1
+    end
+  end
+
+  def db_reader(path: db_path)
+    DatabaseReader.new(path:)
+  end
+
+  def db_path
+    @options[:db_path]
+  end
+
+  def current_workspace_path
+    @current_workspace_path ||= Pathname.new(ARGV[0] || Dir.pwd).expand_path
+  end
+
+  def workspaces_storage_path
+    @workspaces_storage_path ||= self.class.possible_workspaces_storage_path
+  end
+
+  class << self
+    def possible_workspaces_storage_path
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        Pathname.new(ENV.fetch('APPDATA') { raise 'APPDATA environment variable not set.' })
+      when /darwin|mac os/
+        Pathname.new(Dir.home) + 'Library/Application Support'
+      when /linux|solaris|bsd/
+        Pathname.new(Dir.home) + '.config'
+      else
+        raise 'Unsupported OS'
+      end.join('Code/User/workspaceStorage')
+    end
+  end
+end
+
+# Run the script
+CommandLineInterface.new.run

data/lib/database_reader.rb

@@ -0,0 +1,53 @@
+require 'json'
+require 'sqlite3'
+require 'pathname'
+require 'forwardable'
+
+class DatabaseReader
+  extend Forwardable
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+
+  def initialize(path:, query: nil)
+    @path = Pathname.new(path)
+    @query = query || default_query
+  end
+
+  delegate default_query: :'self.class'
+
+  def extensions
+    @extensions ||=
+      JSON.parse(query_extensions.dig(0, 1) || raise(NotFoundError, "Unexpected query result #{query_extensions}"))
+          .map { |ext| ext['id'] }
+  end
+
+  private
+
+  def query_extensions
+    connection.execute(query)
+  rescue SQLite3::Exception => e
+    raise Error, "Error querying database: #{e}"
+  ensure
+    connection.close if connection
+  end
+
+  def connection
+    return @connection if @connection && !@connection.closed?
+
+    @connection = SQLite3::Database.new(path.to_s)
+  rescue SQLite3::Exception => e
+    raise Error, "Error opening database: #{e} (path: #{path})"
+  end
+
+  public
+
+  attr_reader :path, :query
+
+  class << self
+    def default_query
+      <<~SQL
+        SELECT * FROM ItemTable WHERE key LIKE 'extensionsIdentifiers/enabled'
+      SQL
+    end
+  end
+end

data/lib/workspace_storage_finder.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'pathname'
+
+class WorkspaceStorageFinder
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+
+  def initialize(path:)
+    @root = Pathname.new(path)
+  end
+
+  def find_path(needle:)
+    needle = Pathname.new(needle).realpath.to_s
+    worspace_storage_paths.each do |path|
+      next unless path.exist?
+
+      workspace_json_path = path.join('workspace.json')
+      next unless workspace_json_path.exist?
+
+      workspace_data = JSON.parse(workspace_json_path.read)
+      folder_value = workspace_data['folder']
+      return path if folder_value && folder_value == "file://#{needle}"
+    end
+
+    raise(NotFoundError, "Workspace storage not found for #{needle}. Searched in #{worspace_storage_paths.count} " \
+      "folders within \"#{root}\".")
+  end
+
+  def worspace_storage_paths
+    @worspace_storage_paths ||= root.children.select(&:directory?)
+  end
+
+  attr_reader :root
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: list_enabled_extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GPT-4
+- Anton Topchii
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.11
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.23.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: This gem provides a command-line tool to list enabled VSCode extensions
+  for a given workspace.
+email:
+- player1@infinitevoid.net
+executables:
+- list-enabled-extensions
+- list_enabled_extensions
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- exe/list-enabled-extensions
+- exe/list_enabled_extensions
+- lib/database_reader.rb
+- lib/workspace_storage_finder.rb
+homepage: http://github.com/crawler/list_enabled_extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A tool to list enabled VSCode extensions for a workspace
+test_files: []