vuejs/vetur

Error message suggests non-documented formatter prettier-tslint

Open

#3,124 opened on Aug 24, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (594 forks)github user discovery
bugdocsgood first issueinteg:tslint

Repository metrics

Stars
 (5,752 stars)
PR merge metrics
 (PR metrics pending)

Description

  • I have searched through existing issues
  • I have read through docs
  • I have read FAQ
  • I have tried restarting VS Code or running Vetur: Restart VLS

Info

  • Platform: Win
  • Vetur version: 0.34.1
  • VS Code version: 1.59.1

Problem

When setting vetur.format.defaultFormatter.ts in settings.json to an invalid value, the following message pops up:

Value is not accepted. Valid values: "none", "prettier", "prettier-tslint", "vscode-typescript".

The option prettier-tslint is not mentioned as a valid formatter in the docs. Should the error message or the docs be updated?

I did test the prettier-tslint option and it does actually seem to work.

Reproducible Case

Add the following line to either settings.json:

"vetur.format.defaultFormatter.ts": "invalid-formatter",

Contributor guide

Research direction
Compare the list of valid formatter values in the error message with the official Vetur documentation. Decide whether to update the error message or the docs to include 'prettier tslint' or remove it. Check if 'prettier tslint' is still supported or deprecated.
Tech stack
typescript
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
VS Code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70