Using directory local environment for language servers and other functionality
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- swift
- Domínio
- developer-experience, tooling
Direção de pesquisa
Comece pelo design proposto do protocolo EnvironmentProvider e de EnvironmentProviderStore; nenhum arquivo ou teste de CodeEdit é nomeado na issue. Use como contexto as referências vinculadas de Zed shell_env.rs e environment.rs e, em seguida, divida o trabalho nos dois estágios indicados. O trabalho estará concluído quando os ambientes locais ao diretório derem suporte a direnv, venv, asdf e dotenv, forem passados aos processos relevantes e puderem ser estendidos posteriormente por meio de uma API de extensões.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Description
Environment providers.
I propose a new struct: EnvironmentProviderStore, for the environment providers, which would be used to get the environment for the current directory. This should be implemented in two stages:
a) Implement the API inside of CodeEdit to iron out rough edges, implement support for direnv, venv, asdf and dotenv using it.
b) Create an extension API allowing users to extend CodeEdit with their own environment providers, move existing ones to the extensions
The protocol is as follows:
protocol EnvironmentProvider {
var displayName { get }
func update_env(_ env: [String : String], for directory: FilePath) async throws -> [String: String]
}
Then, based on this protocol, projects should use functions reliant on it to find binaries in path, as well as passing the environment to executed processes
Alternatives Considered
Install everything globally
Additional Context
An example implementation for direnv
import Foundation
struct DirenvProvider: EnvironmentProvider {
let displayName = "direnv"
func update_env(_ env: [String: String], for directory: FilePath) async throws -> [String: String] {
let process = Process()
process.executableURL = URL(fileURLWithPath: "/usr/bin/env")
process.arguments = ["direnv", "export", "json"]
process.currentDirectoryURL = URL(fileURLWithPath: directory.string)
process.environment = env
let pipe = Pipe()
process.standardOutput = pipe
process.standardError = Pipe()
try process.run()
process.waitUntilExit()
guard process.terminationStatus == 0 else {
throw DirenvError.commandFailed(exitCode: process.terminationStatus)
}
let data = pipe.fileHandleForReading.readDataToEndOfFile()
guard let jsonString = String(data: data, encoding: .utf8) else {
throw DirenvError.invalidOutput
}
guard let jsonData = jsonString.data(using: .utf8),
let exportedEnv = try JSONSerialization.jsonObject(with: jsonData) as? [String: String] else {
throw DirenvError.jsonParsingFailed
}
var updatedEnv = env
for (key, value) in exportedEnv {
updatedEnv[key] = value
}
return updatedEnv
}
}
enum DirenvError: Error, LocalizedError {
case commandFailed(exitCode: Int32)
case invalidOutput
case jsonParsingFailed
var errorDescription: String? {
switch self {
case .commandFailed(let exitCode):
return "direnv command failed with exit code \(exitCode)"
case .invalidOutput:
return "direnv produced invalid output"
case .jsonParsingFailed:
return "Failed to parse direnv JSON output"
}
}
}
This should of course be made to asynchronously execute the direnv process but that's mostly details
Zed implementation for reference (it hardcodes direnv and relies on a shell hook for everything else which is explicitly not what I want to do here:
https://github.com/zed-industries/zed/blob/main/crates/util/src/shell_env.rs
https://github.com/zed-industries/zed/blob/main/crates/project/src/environment.rs#L178
Screenshots
No response
- Linguagem predominante
- Swift
- Estrelas
- 23k
- Forks
- 1.2k
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de CodeEditApp/CodeEdit
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
CodeEditApp/CodeEdit#2190 ·
-
Is this project dead? Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 15/100
CodeEditApp/CodeEdit#2195 · 7 reações ·
-
enhancement
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
CodeEditApp/CodeEdit#2185 ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
CodeEditApp/CodeEdit#2181 ·
-
creashes on starting Abertabug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
CodeEditApp/CodeEdit#2180 ·
Todas as issues de CodeEditApp/CodeEdit
Issues semelhantes
-
pending-maintainer-response pending-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
make notarise-dmg notarises whichever dist/ image sorts last, not the one make dmg just built Abertaarea:build bug good first issue P2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
uttrflow/uttrflow-swift#1412 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
enhancement
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 80/100
-
T-Defect
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
element-hq/element-x-ios#6191 ·