[aur-general] Subdirectories: is my workaround acceptable?
Hi fellow AUR maintainers, Over time, I have refined my editor settings in Visual Studio Code to make working with PKGBUILDs more enjoyable. For example, I have added settings which, on a PKGBUILD-by-PKGBUILD basis, enforce a consistent style throughout the whole PKGBUILD. I also have settings to auto-enable shellcheck for linting. For several PKGBUILDs that I maintain, I’d like to share those settings with fellow contributors so whenever they open the directory that contains my PKGBUILD as a workspace in VS Code, it picks up those settings and applies them automatically so those contributors can enjoy zero-configuration linting and consistent styling. Now my issue here is: VS Code’s workspace-level settings live in a .vscode subdirectory so a team of contributors can share those settings via Git along with the project files. But I’ve noticed that aurweb appears to enforce some kind of no-subdirectories rule [1]. I started working around that limitation by including a tarball [2] with my PKGBUILDs instead of a .vscode directory. While aurweb would have rejected that directory, it does accept the tarball. - Do you find my workaround acceptable? Or would that go against the spirit of aurweb’s no-subdirectories rule? - What is the rationale behind the no-subdirectories rule, anyway? Thanks for your thoughts in advance. Regards, Claudia (aka Auerhuhn) --- [1]: https://gitlab.archlinux.org/archlinux/aurweb/-/blob/4ddd1dec9c1d19481593f40... [2]: https://aur.archlinux.org/cgit/aur.git/tree/?h=batch-rename
On 16/06/2022 17:42, Claudia Pellegrino via aur-general wrote:
Hi fellow AUR maintainers,
Hello Claudia,
[..] I started working around that limitation by including a tarball [2] with my PKGBUILDs instead of a .vscode directory. While aurweb would have rejected that directory, it does accept the tarball.
The AUR is for hosting the PKGBUILD files and any patches / sources required to build those. Supplementary files such as IDE settings etc should not be there because they are not required for building said packages. Cheers, Leonidas -- Leonidas Spyropoulos PGP: 59E43E106B247368
On Thu, Jun 16, 2022 at 9:33 PM Leonidas Spyropoulos via aur-general <aur-general@lists.archlinux.org> wrote:
On 16/06/2022 17:42, Claudia Pellegrino via aur-general wrote:
Hi fellow AUR maintainers,
Hello Claudia,
[..] I started working around that limitation by including a tarball [2] with my PKGBUILDs instead of a .vscode directory. While aurweb would have rejected that directory, it does accept the tarball.
The AUR is for hosting the PKGBUILD files and any patches / sources required to build those. Supplementary files such as IDE settings etc should not be there because they are not required for building said packages.
Cheers, Leonidas
-- Leonidas Spyropoulos PGP: 59E43E106B247368
You can keep such settings in the parent directory. e.g. if you have an aur package in `~/aur/pkgname` you can keep your vscode settings in `~/aur/.vscode`. You can also optionally use something like aurpublish to make such a setup easier. https://github.com/eli-schwartz/aurpublish https://github.com/eNV25/pkgs
participants (3)
-
Claudia Pellegrino
-
eNV25
-
Leonidas Spyropoulos