ts-plugin / ts-plugin/ts-import-plugin

Documents are not clear enough

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PR is Welcome
Dominant language
TypeScript
Stars
603
Forks
36
Avg merge
1m
Merged PRs (30d)
1

Description

  • libraryDirectory
  • camel2DashComponentName
  • camel2UnderlineComponentName

So here I got 3 options to figure out, I guess that libraryDirectory is transform import { x } from 'y' to import x from 'y/valueOfLibraryDirectory/x, and camel2DashComponentName camel2UnderlineComponentName are which rule will be applied to transform the x.

I'll later find the source to confirm my guess. Maybe readme.md should be more clear about that. Thx

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 by reading README.md and then inspect the source that defines libraryDirectory, camel2DashComponentName, and camel2UnderlineComponentName. Clarify how each option transforms an import and explain the behavior in the README; done means a newcomer can distinguish the three options without tracing the implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.