Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

documentation for 'import-name' needs clarification for more complex names #588

Closed
ericsnap opened this issue Oct 25, 2018 · 2 comments
Closed
Labels
Domain: Documentation Rules or repository tasks related to how to document code.
Milestone

Comments

@ericsnap
Copy link
Contributor

The import-name rule is awesome and the override configuration is pretty slick.
However, it took me a while to figure out how to use it for request-promise-native which is usually imported as request since it simply wraps the request package.
I think the documentation could be updated with this additional note:

Note that the name of the package is the expected camelCase name of the package. For example, to allow `request-promise-native` to be imported as `request`, add this configuration: `'import-name': [true, { 'requestPromiseNative': 'request'}]`

I forked the project and wanted to create a PR, but I couldn't find any contribute.md file or something similar describing the project's expectations regarding PRs. I figured posting it here might be the fastest way for someone involved with the project to make that change.

@JoshuaKGoldberg
Copy link

JoshuaKGoldberg commented Oct 25, 2018

Hey @ericsnap it'd be great to have a PR from you! There's no contribute.md or equivalent, yes, but there should be. Filed #589.

In general, if you want to make a change to the rule's .ts file or README.md, please do send those our way in the form of a pull request. There's no expectation of branch name or squashing commits, but please try to add a sentence or two in the PR description of what it does and link to this issue.

@ericsnap
Copy link
Contributor Author

@JoshuaKGoldberg filed PR #590 (I think...)

@JoshuaKGoldberg JoshuaKGoldberg added this to the 6.0.0-beta0 milestone Nov 6, 2018
@JoshuaKGoldberg JoshuaKGoldberg added the Domain: Documentation Rules or repository tasks related to how to document code. label Nov 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Domain: Documentation Rules or repository tasks related to how to document code.
Projects
None yet
Development

No branches or pull requests

2 participants