From c74e170c49a6bd2d78697723ef869be06bee330b Mon Sep 17 00:00:00 2001 From: Jack T Date: Mon, 29 Jul 2024 11:30:57 -0700 Subject: [PATCH] Add instructions to Readme on ignoring generated files --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6b12270..82fc15b 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,15 @@ id = 9670971 - `id`: number +## Code Generation +The formatting of code generation (such as spaces, tabs, width, and semicolons) is not guaranteed by Asphalt and may change between releases without being noted as a breaking change. + +Therefore, it is recommended to add Asphalt's generated files to your linter/formatter's "ignore" list. Here are instructions for the most commonly used tools: + +- [Stylua](https://github.com/JohnnyMorganz/StyLua?tab=readme-ov-file#glob-filtering) +- [Biome](https://biomejs.dev/guides/configure-biome/#ignore-files) +- [ESLint](https://eslint.org/docs/latest/use/configure/ignore) + ## API Key You will need an API key to sync with Asphalt. You can specify this using the `--api-key` argument, or the `ASPHALT_API_KEY` environment variable.