From e9de23811507640f21e8513abb88439db8ca84b7 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 18 Oct 2023 06:16:20 -0700 Subject: [PATCH] Use Prettier to format TOML files --- .../check-prettier-formatting-task.yml | 4 + .prettierrc.yml | 5 + docs/acknowledgments.md | 1 + package-lock.json | 94 ++++++++++++++++++- package.json | 3 +- 5 files changed, 105 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-prettier-formatting-task.yml b/.github/workflows/check-prettier-formatting-task.yml index 7b17cbb..3e98618 100644 --- a/.github/workflows/check-prettier-formatting-task.yml +++ b/.github/workflows/check-prettier-formatting-task.yml @@ -89,6 +89,8 @@ on: - "**.mkdn?" - "**.ronn" - "**.workbook" + # TOML + - "**.toml" # YAML - "**/.clang-format" - "**/.clang-tidy" @@ -185,6 +187,8 @@ on: - "**.mkdn?" - "**.ronn" - "**.workbook" + # TOML + - "**.toml" # YAML - "**/.clang-format" - "**/.clang-tidy" diff --git a/.prettierrc.yml b/.prettierrc.yml index 3f9069d..fd2ad8f 100644 --- a/.prettierrc.yml +++ b/.prettierrc.yml @@ -5,6 +5,11 @@ overrides: - "*.html" options: parser: go-template + - files: + - "*.toml" + options: + parser: toml plugins: - prettier-plugin-go-template + - prettier-plugin-toml printWidth: 120 diff --git a/docs/acknowledgments.md b/docs/acknowledgments.md index 749c6d9..a63cbcf 100644 --- a/docs/acknowledgments.md +++ b/docs/acknowledgments.md @@ -53,6 +53,7 @@ This project is based on many amazing open source software projects: - [**Poetry**](https://python-poetry.org/) - Python package manager - [**Prettier**](https://prettier.io/) - Code formatter - [**prettier-plugin-go-template**](https://github.com/NiklasPor/prettier-plugin-go-template) - Prettier plugin for Go template files +- [**Prettier Toml Plugin**](https://www.npmjs.com/package/prettier-plugin-toml) - Prettier plugin for TOML files - [**Task**](https://taskfile.dev/) - Task runner - [**Wget**](https://www.gnu.org/software/wget/) - File downloader - [**yamllint**](https://yamllint.readthedocs.io/) - YAML linter diff --git a/package-lock.json b/package-lock.json index dde276c..dc293c4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,12 +11,52 @@ "markdown-link-check": "3.11.2", "markdownlint-cli": "0.37.0", "prettier": "3.0.3", - "prettier-plugin-go-template": "0.0.15" + "prettier-plugin-go-template": "0.0.15", + "prettier-plugin-toml": "1.0.0" }, "engines": { "node": "18.x" } }, + "node_modules/@chevrotain/cst-dts-gen": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/@chevrotain/cst-dts-gen/-/cst-dts-gen-11.0.3.tgz", + "integrity": "sha512-BvIKpRLeS/8UbfxXxgC33xOumsacaeCKAjAeLyOn7Pcp95HiRbrpl14S+9vaZLolnbssPIUuiUd8IvgkRyt6NQ==", + "dev": true, + "dependencies": { + "@chevrotain/gast": "11.0.3", + "@chevrotain/types": "11.0.3", + "lodash-es": "4.17.21" + } + }, + "node_modules/@chevrotain/gast": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/@chevrotain/gast/-/gast-11.0.3.tgz", + "integrity": "sha512-+qNfcoNk70PyS/uxmj3li5NiECO+2YKZZQMbmjTqRI3Qchu8Hig/Q9vgkHpI3alNjr7M+a2St5pw5w5F6NL5/Q==", + "dev": true, + "dependencies": { + "@chevrotain/types": "11.0.3", + "lodash-es": "4.17.21" + } + }, + "node_modules/@chevrotain/regexp-to-ast": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/@chevrotain/regexp-to-ast/-/regexp-to-ast-11.0.3.tgz", + "integrity": "sha512-1fMHaBZxLFvWI067AVbGJav1eRY7N8DDvYCTwGBiE/ytKBgP8azTdgyrKyWZ9Mfh09eHWb5PgTSO8wi7U824RA==", + "dev": true + }, + "node_modules/@chevrotain/types": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/@chevrotain/types/-/types-11.0.3.tgz", + "integrity": "sha512-gsiM3G8b58kZC2HaWR50gu6Y1440cHiJ+i3JUvcp/35JchYejb2+5MVeJK0iKThYpAa/P2PYFV4hoi44HD+aHQ==", + "dev": true + }, + "node_modules/@chevrotain/utils": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/@chevrotain/utils/-/utils-11.0.3.tgz", + "integrity": "sha512-YslZMgtJUyuMbZ+aKvfF3x1f5liK4mWNxghFRv7jqRR9C3R3fAOGTTKvxXDa2Y1s9zSbcpuO0cAxDYsc9SrXoQ==", + "dev": true + }, "node_modules/@financial-times/origami-service-makefile": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/@financial-times/origami-service-makefile/-/origami-service-makefile-7.0.3.tgz", @@ -74,6 +114,25 @@ "node": ">=14.16" } }, + "node_modules/@toml-tools/lexer": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@toml-tools/lexer/-/lexer-1.0.0.tgz", + "integrity": "sha512-rVoOC9FibF2CICwCBWQnYcjAEOmLCJExer178K2AsY0Nk9FjJNVoVJuR5UAtuq42BZOajvH+ainf6Gj2GpCnXQ==", + "dev": true, + "dependencies": { + "chevrotain": "^11.0.1" + } + }, + "node_modules/@toml-tools/parser": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@toml-tools/parser/-/parser-1.0.0.tgz", + "integrity": "sha512-j8cd3A3ccLHppGoWI69urbiVJslrpwI6sZ61ySDUPxM/FTkQWRx/JkkF8aipnl0Ds0feWXyjyvmWzn70mIohYg==", + "dev": true, + "dependencies": { + "@toml-tools/lexer": "^1.0.0", + "chevrotain": "^11.0.1" + } + }, "node_modules/@types/http-cache-semantics": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.2.tgz", @@ -397,6 +456,20 @@ "url": "https://github.com/sponsors/fb55" } }, + "node_modules/chevrotain": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/chevrotain/-/chevrotain-11.0.3.tgz", + "integrity": "sha512-ci2iJH6LeIkvP9eJW6gpueU8cnZhv85ELY8w8WiFtNjMHA5ad6pQLaJo9mEly/9qUyCpvqX8/POVUTf18/HFdw==", + "dev": true, + "dependencies": { + "@chevrotain/cst-dts-gen": "11.0.3", + "@chevrotain/gast": "11.0.3", + "@chevrotain/regexp-to-ast": "11.0.3", + "@chevrotain/types": "11.0.3", + "@chevrotain/utils": "11.0.3", + "lodash-es": "4.17.21" + } + }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -1314,6 +1387,12 @@ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, + "node_modules/lodash-es": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz", + "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==", + "dev": true + }, "node_modules/lowercase-keys": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", @@ -1727,6 +1806,19 @@ "prettier": "^3.0.0" } }, + "node_modules/prettier-plugin-toml": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prettier-plugin-toml/-/prettier-plugin-toml-1.0.0.tgz", + "integrity": "sha512-YMn4Fqy/ANHommZh61s5qqtpfcgPB00Ty890bFPr73B0HAy77zgyH89SvAK+NyPPx3AdM56a4Yo66LH9GPnuZw==", + "dev": true, + "dependencies": { + "@toml-tools/lexer": "^1.0.0", + "@toml-tools/parser": "^1.0.0" + }, + "peerDependencies": { + "prettier": "^3.0.0" + } + }, "node_modules/progress": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", diff --git a/package.json b/package.json index 9dc452f..2e6900c 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,8 @@ "markdown-link-check": "3.11.2", "markdownlint-cli": "0.37.0", "prettier": "3.0.3", - "prettier-plugin-go-template": "0.0.15" + "prettier-plugin-go-template": "0.0.15", + "prettier-plugin-toml": "1.0.0" }, "engines": { "node": "18.x"