Update Markdown formatting for Prettier 3.4

Prettier 3.4 removes extra spaces after unordered list line prefixes. https://prettier.io/blog/2024/11/26/3.4.0#markdown
br3ndonland · Dec 20, 2024 · 3f9bfd2 · 3f9bfd2
1 parent fe631cc
commit 3f9bfd2
Show file tree

Hide file tree

Showing 8 changed files with 523 additions and 523 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -199,7 +199,7 @@ jobs:
           git tag -l --sort=-taggerdate:iso --format="$GIT_LOG_FORMAT" >>CHANGELOG.md
           git tag -l --sort=-taggerdate:iso --format="$GIT_LOG_FORMAT" >>docs/changelog.md
       - name: Format changelog with Prettier
-        run: npx -s -y prettier@'^3' --write CHANGELOG.md docs/changelog.md
+        run: npx -s -y prettier@'^3.4' --write CHANGELOG.md docs/changelog.md
       - name: Create pull request with updated changelog
         uses: peter-evans/create-pull-request@v6
         with:

diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/cloud-object-storage.md b/docs/cloud-object-storage.md
diff --git a/docs/comparisons.md b/docs/comparisons.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/environment.md b/docs/environment.md
@@ -8,9 +8,9 @@ The implementation of `fastenv.DotEnv` is based on `os.environ`, and it inherits
 
 Practically speaking, "superset of `os.environ`" means:
 
--   **When an environment variable is set in an instance of `class DotEnv`, it is also set in `os.environ`**.
--   **When an environment variable is deleted from an instance of `class DotEnv`, it is also deleted from `os.environ`**.
--   **When an environment variable is set directly with `os.environ`, it is not automatically set in instances of `class DotEnv`.** `os.environ` contains variables specific to the local environment, such as `os.environ["HOME"]`, so these variables are not included in `class DotEnv` by default.
+- **When an environment variable is set in an instance of `class DotEnv`, it is also set in `os.environ`**.
+- **When an environment variable is deleted from an instance of `class DotEnv`, it is also deleted from `os.environ`**.
+- **When an environment variable is set directly with `os.environ`, it is not automatically set in instances of `class DotEnv`.** `os.environ` contains variables specific to the local environment, such as `os.environ["HOME"]`, so these variables are not included in `class DotEnv` by default.
 
 ## Getting started
 

diff --git a/docs/index.md b/docs/index.md
@@ -15,11 +15,11 @@ fastenv [\[fæst iː ən v\]](https://en.wikipedia.org/wiki/Help:IPA/English) is
 
 This project aims to:
 
--   [x] **Replace the aging [python-dotenv](https://github.com/theskumar/python-dotenv) project** with a similar, but more intuitive API, and modern syntax and tooling.
--   [x] **Implement asynchronous file I/O**. Reading and writing files can be done asynchronously with packages like [AnyIO](https://github.com/agronholm/anyio).
--   [x] **Implement asynchronous object storage integration**. Dotenv files are commonly kept in cloud object storage, but environment variable management packages typically don't integrate with object storage clients. Additional logic is therefore required to download _.env_ files from object storage prior to loading environment variables. This project aims to integrate with S3-compatible object storage, with a focus on downloading and uploading file objects.
--   [ ] **Read settings from TOML**. [It's all about _pyproject.toml_ now](https://snarky.ca/what-the-heck-is-pyproject-toml/). The Python community has pushed [PEP 517](https://www.python.org/dev/peps/pep-0517/) build tooling and [PEP 518](https://www.python.org/dev/peps/pep-0518/) build requirements forward, and [even `setuptools` has come around](https://setuptools.readthedocs.io/en/latest/build_meta.html). [PEP 621](https://www.python.org/dev/peps/pep-0621/) defined how to store package metadata and dependencies in _pyproject.toml_. Why don't we use the metadata from our _pyproject.toml_ files in our Python applications?
--   [ ] **Unify settings management for FastAPI**. [Uvicorn](https://www.uvicorn.org/), [Starlette](https://www.starlette.io/config/), and _[pydantic](https://pydantic-docs.helpmanual.io/usage/settings/)_ each have their own ways of loading environment variables and configuring application settings. This means that, when [configuring a FastAPI application](https://fastapi.tiangolo.com/advanced/settings/), there are at least three different settings management tools available, each with their own pros and cons. It would be helpful to address the limitations of each of these options, potentially providing a similar, improved API for each one.
+- [x] **Replace the aging [python-dotenv](https://github.com/theskumar/python-dotenv) project** with a similar, but more intuitive API, and modern syntax and tooling.
+- [x] **Implement asynchronous file I/O**. Reading and writing files can be done asynchronously with packages like [AnyIO](https://github.com/agronholm/anyio).
+- [x] **Implement asynchronous object storage integration**. Dotenv files are commonly kept in cloud object storage, but environment variable management packages typically don't integrate with object storage clients. Additional logic is therefore required to download _.env_ files from object storage prior to loading environment variables. This project aims to integrate with S3-compatible object storage, with a focus on downloading and uploading file objects.
+- [ ] **Read settings from TOML**. [It's all about _pyproject.toml_ now](https://snarky.ca/what-the-heck-is-pyproject-toml/). The Python community has pushed [PEP 517](https://www.python.org/dev/peps/pep-0517/) build tooling and [PEP 518](https://www.python.org/dev/peps/pep-0518/) build requirements forward, and [even `setuptools` has come around](https://setuptools.readthedocs.io/en/latest/build_meta.html). [PEP 621](https://www.python.org/dev/peps/pep-0621/) defined how to store package metadata and dependencies in _pyproject.toml_. Why don't we use the metadata from our _pyproject.toml_ files in our Python applications?
+- [ ] **Unify settings management for FastAPI**. [Uvicorn](https://www.uvicorn.org/), [Starlette](https://www.starlette.io/config/), and _[pydantic](https://pydantic-docs.helpmanual.io/usage/settings/)_ each have their own ways of loading environment variables and configuring application settings. This means that, when [configuring a FastAPI application](https://fastapi.tiangolo.com/advanced/settings/), there are at least three different settings management tools available, each with their own pros and cons. It would be helpful to address the limitations of each of these options, potentially providing a similar, improved API for each one.
 
 The source code is 100% type-annotated and unit-tested.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -87,13 +87,13 @@ check = [
   "ruff check",
   "ruff format --check",
   "mypy",
-  "npx -s -y prettier@'^3' . --check",
+  "npx -s -y prettier@'^3.4' . --check",
   "npx -s -y cspell --dot --gitignore *.md **/*.md",
 ]
 format = [
   "ruff check --fix",
   "ruff format",
-  "npx -s -y prettier@'^3' . --write",
+  "npx -s -y prettier@'^3.4' . --write",
 ]
 
 [tool.hatch.envs.docs]