From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?utf-8?B?Sm/Do28gVMOhdm9yYQ==?= Newsgroups: gmane.emacs.devel Subject: Re: [SPAM UNSURE] Explain a bit more on how to configure language server in Eglot's manual Date: Tue, 07 Mar 2023 11:59:32 +0000 Message-ID: <87356gvkkb.fsf@gmail.com> References: <86sfeisu49.fsf@stephe-leake.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="34502"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Stephen Leake , Emacs developers To: Yuan Fu Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Mar 07 12:58:35 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pZVxi-0008lz-5P for ged-emacs-devel@m.gmane-mx.org; Tue, 07 Mar 2023 12:58:34 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pZVws-0003i3-Ox; Tue, 07 Mar 2023 06:57:42 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pZVwq-0003Ow-3k for emacs-devel@gnu.org; Tue, 07 Mar 2023 06:57:40 -0500 Original-Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pZVwo-00037C-EG for emacs-devel@gnu.org; Tue, 07 Mar 2023 06:57:39 -0500 Original-Received: by mail-wm1-x32c.google.com with SMTP id k37so7620126wms.0 for ; Tue, 07 Mar 2023 03:57:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1678190256; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=I1rm6BZROR2jR8iFcgVl7EAU8nVNQ5LeU71aS0OABvY=; b=VQsCg75YoBlIZm1PRKzUz3fqmvzK+h7l1ESW5gOf+mV8e1ke3I+IHtTDUde0c/l6fk u3fdK5eidpdJvKvP7XLPzAG/66jLw5XhbvAJyP09qs3yMgo9yJAsh0cT9h2GMvPW+cs8 jTOVog4AcdIDF6O1RvULHDdy7mGy0ElZoxOROIpe7Ha7UvEOYEqJ3DFVJdVS5OFM+WqM mFxdd6ufaqK4s+i9ow/b9ZY915oYsfGFpkNdeq0Pazto65TKLr8cNrs9zxU2EkPEoqsi 6JZtL29YUV36MOZkdNaJGx3F7iCZqM7LXIUH4opM9uDTBKXbtBWghttxRGOnDFpyB2Gz bpNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678190256; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=I1rm6BZROR2jR8iFcgVl7EAU8nVNQ5LeU71aS0OABvY=; b=kQ2Z0SgCzEDqpEwyYLG2G3AC+rCAqf/FwqAKPhguXn2vHG0OzOdG830JqhwtmLa8D5 pEHTYmGkTE5urmtdD1HnOlwPEHLvjG8xjw0UOnHqThYwYsf8IpAAlj9QkuqqROGB5D7i 2ErhQNw6KAxyqFx7AiX413I2Ma3wR/ieCgRwMgL3qu9z1TsMVhZiocqwVx53UhA+f05G vah3rq2H8tIgoNjTr01upz1W8/iKOiGoAbT2tlwAuZoOt8uyZC30eSeymauWVqKXn6we 3mFOUadaVRCWbNPqYjo9ZrTz4yqLcHDr5XpDEZIoUybG57ncWpp2frDyBpnHCIgzP4Qs pZzw== X-Gm-Message-State: AO0yUKXcA6z7pj7VnqVserEBJh0XDc4+H66/5/aDfjQRdEYhisb9PJSi siYFFJhDBNWChPougR0yjX2bRLPMUW0= X-Google-Smtp-Source: AK7set8EPx8wMhmrV6dOMipPdOQMAMRAH5OAyGGY3EDV7S6CwDeJS1st33O26ghoTp7TBBKma1QgIw== X-Received: by 2002:a05:600c:4f0c:b0:3ea:c100:f18d with SMTP id l12-20020a05600c4f0c00b003eac100f18dmr12941552wmq.9.1678190256155; Tue, 07 Mar 2023 03:57:36 -0800 (PST) Original-Received: from krug ([87.196.72.142]) by smtp.gmail.com with ESMTPSA id hg13-20020a05600c538d00b003d9aa76dc6asm16512121wmb.0.2023.03.07.03.57.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Mar 2023 03:57:35 -0800 (PST) In-Reply-To: (Yuan Fu's message of "Mon, 6 Mar 2023 14:28:38 -0800") Received-SPF: pass client-ip=2a00:1450:4864:20::32c; envelope-from=joaotavora@gmail.com; helo=mail-wm1-x32c.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:304076 Archived-At: Yuan Fu writes: >> On Mar 5, 2023, at 4:16 PM, Jo=C3=A3o T=C3=A1vora = wrote: >>=20 >> Yuan, please show the patch to Eglot's manual and let's work from >> there. > > I=E2=80=99m not an amazing writer, but here it is. Thanks. I think the most important part in your patch is to show me exactly the points in the manual's writing that are confusing. >> I'm also OK with adding more examples, and work on simplifying the >> per-project configuration workflow, maybe by somehow making it >> easier to translate that dotted path notation into the nested JSON >> object that the server is ultimately looking for. > > I feel that explaining the relationship between the dotted notation, > the JSON object and the plist value that eglot accepts is already some > cognitive load. And adding a translator into the mix will make it > worse. If we provide the translator but don=E2=80=99t explain how it work= s, it > will be just as confusing. But I could be wrong, I didn=E2=80=99t ponder = this > too deeply. The dotted-to-plist translator proposed is optional. Some people requested use of dotted notation and that will surely need a translator. I wouldn't use it. But you're right that it's orthogonal to the request of a clearly and well-structured writing on this topic, which I agree that this version of the manual doesn't offer (the old Eglot README was very slightly better in this department, IIRC) >> If this distinction is not clear in the manual, either, it should >> be made so. > > initializatiOption is only mentioned in the documentation of > eglot-server-progrems, while workspaceConfiguration has a dozen > paragraphs devoted to it. So maybe it=E2=80=99s easy to take > workspaceConfiguration as the =E2=80=9Cmain=E2=80=9D way to configure a s= erver.=20 No, there are two ways, and neither is more valuable than the other. It depends entirely on what the user wants.=20=20 > Maybe we can spend a little bit of text noting initializationOption > under the =E2=80=9CCustomizing eglot=E2=80=9D section. I'm leaning into making a dedicated "Server configuration" section with 3 subsections: initializationOptions, eglot-workspace-configuration, and the representations of common JSON object that is used for both of them. Jo=C3=A3o