microsoft / microsoft/TypeScript-Sublime-Plugin

inform user if tsconfig.json is not found

Open
#572 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.7k
Forks
236
Avg merge
21d 13h
Merged PRs (30d)
1

Description

I ran into the pb described in https://github.com/Microsoft/TypeScript-Sublime-Plugin/issues/213, and, indeed, setting "typescript_tsdk" in Package settings in order to locate the ts lib has fixed this pb.

I spent quite an hour to investigate the issue, and I think most newcomers are likely to run into this (because they will probably install last version of ts globally, as I did), so it should be a good think :

  • to document this more obviously (the setting is documented in the readme, but not the fact that it can solve this issue).
  • and to inform the user if no tsconfig.json was found by the compiler

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the README's documentation of the "typescript_tsdk" setting and trace how the plugin locates the TypeScript library and tsconfig.json. Done means documenting that setting as a remedy for this problem and informing the user when no tsconfig.json is found; no specific files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.