Using directory local environment for language servers and other functionality
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- swift
- Domaine
- developer-experience, tooling
Piste de recherche
Commencez par la conception proposée du protocole EnvironmentProvider et de EnvironmentProviderStore ; aucun fichier CodeEdit ni aucun test n’est nommé dans l’issue. Utilisez comme contexte les références liées de Zed shell_env.rs et environment.rs, puis répartissez le travail selon les deux étapes indiquées. Le travail est terminé lorsque les environnements locaux au répertoire prennent en charge direnv, venv, asdf et dotenv, sont transmis aux processus concernés et peuvent ensuite être étendus via une API d’extensions.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Swift
- Étoiles
- 23k
- Forks
- 1.2k
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de CodeEditApp/CodeEdit
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
CodeEditApp/CodeEdit#2190 ·
-
Is this project dead? Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 15/100
CodeEditApp/CodeEdit#2195 · 7 réactions ·
-
enhancement
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
CodeEditApp/CodeEdit#2185 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
CodeEditApp/CodeEdit#2181 ·
-
creashes on starting Ouvertebug
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
CodeEditApp/CodeEdit#2180 ·
Toutes les issues de CodeEditApp/CodeEdit
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
googleapis/google-cloud-swift#1106 ·
-
bug channel: beta feature: preferences feature: ui/ux
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Cocoanetics/SwiftACP#52 ·