Github messages for voidlinux
 help / color / mirror / Atom feed
From: classabbyamp <classabbyamp@users.noreply.github.com>
To: ml@inbox.vuxu.org
Subject: Re: [PR PATCH] [Merged]: [RFC] add EditorConfig file
Date: Fri, 08 Mar 2024 00:59:12 +0100	[thread overview]
Message-ID: <20240307235912.137A3220AE@inbox.vuxu.org> (raw)
In-Reply-To: <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-48808@inbox.vuxu.org>

[-- Attachment #1: Type: text/plain, Size: 1284 bytes --]

There's a merged pull request on the void-packages repository

[RFC] add EditorConfig file
https://github.com/void-linux/void-packages/pull/48808

Description:
This PR adds an [EditorConfig](https://editorconfig.org) file to help following the general style used in the repo, along with xlint.

EditorConfig is supported by many editors (see previous link), and automatically adjusts editor settings for indentation, line endings, encoding, etc for a file based on rules. Editors that support it don't act as reformatters when saving; they only use the settings for additions and new files (just as if you has manually changed those settings), which should help new lines and new files follow basic style without user intervention and without generating large "reformat" git diffs[^1].

The exact rules in this PR are just what I surmised to be "the style", namely:
- utf-8, `lf` line-endings, no trailing whitespace at end of lines, and final newline for all files (mostly "files on linux in git")
- 4 space indent for markdown, 2 space indent for YAML
- tab indent for xbps-src and `template`/`update` (done in the everything glob)


[^1]: While that is the case, there are also linters/formatters that can use the `.editorconfig` file if a wholesale reformat is desired.

      parent reply	other threads:[~2024-03-07 23:59 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-18  7:46 [PR PATCH] " 0x5c
2024-03-05 14:57 ` [PR PATCH] [Updated] " 0x5c
2024-03-05 14:58 ` 0x5c
2024-03-05 15:01 ` 0x5c
2024-03-05 15:49 ` [PR PATCH] [Updated] " 0x5c
2024-03-05 15:50 ` 0x5c
2024-03-05 16:03 ` 0x5c
2024-03-07 23:59 ` classabbyamp [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240307235912.137A3220AE@inbox.vuxu.org \
    --to=classabbyamp@users.noreply.github.com \
    --cc=ml@inbox.vuxu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).