Using directory local environment for language servers and other functionality
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- swift
- Área
- developer-experience, tooling
Línea de trabajo
Comienza con el diseño propuesto del protocolo EnvironmentProvider y de EnvironmentProviderStore; en el issue no se nombran archivos de CodeEdit ni tests. Usa como contexto las referencias enlazadas de Zed shell_env.rs y environment.rs y, después, divide el trabajo en las dos etapas indicadas. El trabajo estará terminado cuando los entornos locales al directorio admitan direnv, venv, asdf y dotenv, se pasen a los procesos relevantes y posteriormente puedan ampliarse mediante una API de extensiones.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Swift
- Estrellas
- 23k
- Forks
- 1.2k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de CodeEditApp/CodeEdit
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
CodeEditApp/CodeEdit#2190 ·
-
Is this project dead? Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 15/100
CodeEditApp/CodeEdit#2195 · 5 reacciones ·
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
CodeEditApp/CodeEdit#2185 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
CodeEditApp/CodeEdit#2181 ·
-
creashes on starting Abiertobug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
CodeEditApp/CodeEdit#2180 ·
Todos los issues de CodeEditApp/CodeEdit
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
manaflow-ai/cmux#13763 ·
-
type: feature request
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
googleapis/google-cloud-swift#1036 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
wultra/mtoken-sdk-ios#253 ·
-
The correction-threshold rationale says 17 restraint cases collide; the current corpus has 16 Abiertoarea:dictation documentation P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
uttrflow/uttrflow-swift#1180 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100