Message format enforces quotes which limits usability of message text.

[moxiegirl]

Check for existing issues

• Completed

Describe the feature

vale version 3.9.2

Existing rule is:

extends: substitution
message: "Use %s instead of '%s'."
level: warning
ignorecase: false
action:
  name: replace
swap:
  Some phrase: some-sub

Output message is:

 Use 'some-sub' instead of 'Some phrase'. 

The code has hard coded the ' so if my rule message is this:

message: "Use |%s| instead of '%s'."

Vale outputs this for the warning:

Use |'some-sub'| instead of 'Some phrase'.  

The goal is this which conveys the actual tag a user should use and is available for cut-n-paste:

Use |some-sub| instead of 'Some phrase'.  

[jdkato]

This is only true in a specific case (substitution with the replace action) since "|" is used as a special character to denote multiple options.

Here's how I would write it:

extends: substitution
message: "Use '%s' instead of '%s'."
level: warning
ignorecase: false
action:
  name: replace
swap:
  Some phrase: '\|some-sub\|'

This will work correctly from the CLI and in editor integrations (the suggestion will be |some-sub|).

Another option is to use existence and hard-code the message:

extends: existence
message: "Use |some-sub| instead of '%s'."
level: warning
ignorecase: false
action:
  name: replace
  params:
    - "|some-sub|"
tokens:
  - Some phrase

[moxiegirl]

@jdkato Thank you for the response. We have over 100 substitutions in our enterprise docs. To save time, it is important that the replace function your first suggestion work with the exact sub tag. I actually had tested several permutations including your first suggestion before submitting this ticket. Unfortunately, it didn't work which is why I went into the code and found the tics were hard coded.

extends: substitution
message: "Use '%s' in a substitution instead of '%s'."
level: warning
ignorecase: false
action:
  name: replace
swap:
  "Admin REST APIs": '\|admin-rest\|'

It doesn't work. The suggestion comes out like this in the Vale output and the replace function is borked:

substitution seemed ideal as the very word is name for this particular structure in RST. Your second suggestion, if I understand the rule, won't work as I would have to create 100+ yml files to implement it.

I ended up implementing this:

extends: substitution
message: "Use '%s' in a substitution instead of '%s'."
level: warning
ignorecase: false
action:
  name: replace
swap:
  "Admin REST APIs": admin-rest

The Quick Fix then replaces with the correct phrase, in this case admin-rest.

The user an add the pipes to complete the tag |admin-rest|. Less than ideal but it is at least halfway there.

I appreciate the work involved in your response to me and in reading this one to yours, assuming you do. Thank you for your time.

[jdkato]

Are you using the latest version of Vale? The issue isn't with '; it's about escaping the pipes, which should work with v3.9.3:

This will work even better (in terms of supporting the "|" character) once ChrisChinchilla/vale-vscode#41 lands, but it shouldn't be required if they're correctly escaped.

[moxiegirl]

@jdkato You were right, it was the version, I was on 3.9.2. The upgrade fixed it. Worked perfectly.

🥇 Thank you very much.