From eed3c8c38fabee8d830a74a03748d4a87b66340b Mon Sep 17 00:00:00 2001 From: Amber's Careware <93293456+ambers-careware@users.noreply.github.com> Date: Wed, 3 Nov 2021 14:15:51 -0600 Subject: [PATCH] Update config-luaurc.md (#104) When running `luau-analyze` with a .luarc that has a "mode" key, it outputs the following: > .luaurc: Unknown key mode I'm assuming it was named "mode" at first and was re-named "languageMode" later on? --- rfcs/config-luaurc.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rfcs/config-luaurc.md b/rfcs/config-luaurc.md index 0086a00..170142a 100644 --- a/rfcs/config-luaurc.md +++ b/rfcs/config-luaurc.md @@ -29,20 +29,20 @@ Example of a valid .luaurc file: ```json5 { - "mode": "nonstrict", + "languageMode": "nonstrict", "lint": { "*": true, "LocalUnused": false }, "lintErrors": true, "globals": ["expect"] // TestEZ } ``` -Note that in absence of a configuration file, we will use default settings: mode will be set to nonstrict, a set of lint warnings is going to be enabled by default (this proposal doesn't detail that set - that will be subject to a different proposal), type checking issues are going to be treated as errors, lint issues are going to be treated as warnings. +Note that in absence of a configuration file, we will use default settings: languageMode will be set to nonstrict, a set of lint warnings is going to be enabled by default (this proposal doesn't detail that set - that will be subject to a different proposal), type checking issues are going to be treated as errors, lint issues are going to be treated as warnings. ## Design -- compatibility Today we support .robloxrc files; this proposal will keep parsing legacy specification of configuration for compatibility: -- Top-level `"language"` key can refer to an object that has `"mode"` key that also defines language mode +- Top-level `"language"` key can refer to an object that has `"languageMode"` key that also defines language mode - Top-level `"lint"` object values can refer to a string `"disabled"`/`"enabled"`/`"fatal"` instead of a boolean as a value. These keys are only going to be supported for compatibility and only when the file name is .robloxrc (which is only going to be parsed by internal Roblox command line tools but this proposal mentions it for completeness).