[PR #2183] [CLOSED] Improve formatting configuration #3670

Closed
opened 2026-04-25 00:16:35 +02:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/2183
Author: @ahobsonsayers
Created: 10/5/2023
Status: Closed

Base: masterHead: improve-formatting-configuration


📝 Commits (3)

📊 Changes

8 files changed (+109 additions, -36 deletions)

View changed files

.editorconfig (+8 -0)
.prettierrc (+17 -0)
.vscode/extensions.json (+3 -0)
📝 .vscode/settings.json (+14 -17)
📝 client/package-lock.json (+33 -11)
📝 client/package.json (+5 -3)
📝 package-lock.json (+24 -2)
📝 package.json (+5 -3)

📄 Description

When developing my first contrbution to this repo in #2182 , I noticed that the configuration of the formatting could be improved slightly to help people developing in VSCode and other IDEs, as well as aid with keeping consistent formatting across the codebase - assuming this is what you want. This was particularly relevant to me as I noticed when editing some existing files in my other PR, that my IDE was trying to format it differently to how it currently was, which i had to be careful to avoid.

I have moved your prettier config from the vscode settings to a .prettierrc file so that it is IDE agnostic - vetur will still use this config. Additionally i have added prettier to the dev dependancies and added a task to run prettier across all files should you wish to do this at some point (I did not run this for this PR).

I hope these improvements simply help contributers know the formatting this project would like, allows them to easily ensure they are meeting the style and helps avoid changing the formatting of existing files.

If this is not what is wanted, please let me know, it just seemed like an easy win that I think is helpful (well for me at least)


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/2183 **Author:** [@ahobsonsayers](https://github.com/ahobsonsayers) **Created:** 10/5/2023 **Status:** ❌ Closed **Base:** `master` ← **Head:** `improve-formatting-configuration` --- ### 📝 Commits (3) - [`309aeb5`](https://github.com/advplyr/audiobookshelf/commit/309aeb5714406e9ff308232ac6cbc9c103abc747) Improve formatting configuration - [`15badfb`](https://github.com/advplyr/audiobookshelf/commit/15badfbbcce0d338a3b98c6cd69567b359fc5a9a) Add editorconfig - [`b39bf72`](https://github.com/advplyr/audiobookshelf/commit/b39bf7260eb4ae73adb59d7955e68038cf271e35) Update formatting config ### 📊 Changes **8 files changed** (+109 additions, -36 deletions) <details> <summary>View changed files</summary> ➕ `.editorconfig` (+8 -0) ➕ `.prettierrc` (+17 -0) ➕ `.vscode/extensions.json` (+3 -0) 📝 `.vscode/settings.json` (+14 -17) 📝 `client/package-lock.json` (+33 -11) 📝 `client/package.json` (+5 -3) 📝 `package-lock.json` (+24 -2) 📝 `package.json` (+5 -3) </details> ### 📄 Description When developing my first contrbution to this repo in #2182 , I noticed that the configuration of the formatting could be improved slightly to help people developing in VSCode and other IDEs, as well as aid with keeping consistent formatting across the codebase - assuming this is what you want. This was particularly relevant to me as I noticed when editing some existing files in my other PR, that my IDE was trying to format it differently to how it currently was, which i had to be careful to avoid. I have moved your prettier config from the vscode settings to a `.prettierrc` file so that it is IDE agnostic - vetur will still use this config. Additionally i have added prettier to the dev dependancies and added a task to run prettier across all files should you wish to do this at some point (I did not run this for this PR). I hope these improvements simply help contributers know the formatting this project would like, allows them to easily ensure they are meeting the style and helps avoid changing the formatting of existing files. If this is not what is wanted, please let me know, it just seemed like an easy win that I think is helpful (well for me at least) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:16:35 +02:00
adam closed this issue 2026-04-25 00:16:35 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3670