improve error message for npm-based formatters to emphasize local-only

Open
#2,107 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, javascript
Domain
tooling

Research direction

Start by reading lib/src/main/java/com/diffplug/spotless/npm/SimpleRestClient.java and tracing the exception shown in the issue. Determine what message npm-based formatters currently expose, then update it to emphasize local-only operation and clarify any remote interaction; verify the resulting error wording with the relevant existing checks, if present.

Written by the indexing model from the issue text.

Description

enhancement

Hello dear maintainers,

I was setting up spotless in my project and while trying it out I started facing the below exception (which I already managed to fix).

I got a bit scared though, because it seems that it's trying to send my code to a remote server... is that correct?

I understand that you don't have control over all the plugins (i.e. I guess nothing would prevent prettier itself from doing this), but in this case here it seems that potential code leaking is coming from spotless itself.

If the answer to the above question is "yes", is it possible to optout of this altogether?

The below exception seems to be related to this class, but I can't make any conclusions just by looking at this class alone.

Thanks!

image
Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.