Invalid plugin-option value. Expected null, false or "", but received true.

[Shinigami92]

Environments:

• Prettier Version: 2.1.1
• Running Prettier via: CLI
• Runtime: Node.js v14
• Operating System: Arch Linux 5.4.64-1-lts

Steps to reproduce:

I have added aliases for my plugin options so it can better support specific options for pug embedded in vue.

So at first I tried to define an option like:

// pugSingleQuote
{
	since: '1.6.0',
	category: CATEGORY_PUG,
	type: 'boolean',
	default: false,
	description: "Use single quotes instead of double quotes."
}

But then I needed implemented a strategy to fallback to prettier's default/configured values if the aliases are not set.
Therefor I need to have a triple state boolean (true, false, null)

// pugSingleQuote
{
	since: '1.6.0',
	category: CATEGORY_PUG,
	type: 'choice',
	default: null,
	choices: [
		{
			value: null,
			description: 'Use `singleQuote` value.'
		},
		{
			value: true,
			description: 'Use single quotes instead of double quotes.'
		},
		{
			value: false,
			description: 'Use double quotes instead of double quotes.'
		}
	]
}

So null is just the default and shut not be set by a customer
But true or false should be valid values...
false is working fine
true results in an error 👀

Expected behavior:

true should be a valid choice and not be interpreted as "" (empty-string)

Actual behavior:

[error] Error: Invalid --pug-single-quote value. Expected null, false or "", but received true.

[Shinigami92]

LOL it's even more funnier
When I use { "pugSingleQuote": "" } I get:

[error] Invalid pugSingleQuote value. Expected null, false or true, but received "". 👀
I thought you expect "" ?!

[fisker]

I think there are only boolean and string for CLI,

prettier/src/cli/util.js

Line 839 in 810325d

const [boolean, string] = partition(

I'm not sure how we treat --print-width.

[Shinigami92]

printWidth is just an int

But what I need here is true, false or something that lets me fall back to a plugin managed value
And I don't want to use "true" instead of true

[fisker]

I mean cli only accept string and boolean, where does this --print-width get transformed.

[Shinigami92]

You mean you are searching the code for this?

I'm a little bit confused cause my problem doesn't have anything to do with --print-width ^^'

[fisker]

I think it's the same thing, what we got for --print-width from CLI has to be string, and we are using as int.

--pug-single-quot should treat as string too, otherwise there will only boolean value, but we need use as boolean and null

[Shinigami92]

But why is the plain value true via .prettierrc.json interpreted as empty string and vice versa?
I understand that via CLI only strings can be serialized. But I configured the value in the config as json. And this should not be limited to this fallback.
Also I think that it is just a silly check like !myVal instead of myVal === false somewhere. Or in other words: I think there is somewhere a equality check instead of strict equality check.

If this can not be fixed by plugin support in prettier itself, please explain me how I can expect a boolean value that is also nullable or undefinable?

I need a better docu for defining options in plugins

[fisker]

Ah, sorry I misunderstood the problem, I don't know, need investigate.

[wscherphof]

Is there a workaround for still having single quotes?

[kaangokdemir]

I also have the same problem. But for --pug-bracket-same-line instead

[dockleryxk]

Still happening for me in prettier v3.0.3