Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing docs for imports-first #1638

Closed
lolgab opened this issue Jan 31, 2020 · 4 comments · Fixed by #1835
Closed

Missing docs for imports-first #1638

lolgab opened this issue Jan 31, 2020 · 4 comments · Fixed by #1835

Comments

@lolgab
Copy link

lolgab commented Jan 31, 2020

Hi,
I just noticed that imports-first is the only rule that doesn't have a markdown documentation file in docs/rules folder.

@ljharb ljharb changed the title Missing docs for import-first Missing docs for imports-first Jan 31, 2020
@beatrizrezener
Copy link
Contributor

Hi!
As I think this is due to imports-first being a depreciated alias, renamed to first (docs/rules/first.md), I would like to know if you still think it would be interesting to have some documentation about it.

@ljharb
Copy link
Member

ljharb commented Jun 21, 2020

@beatrizrezener thanks, good point :-) perhaps a symlink to the first docs would work?

beatrizrezener added a commit to beatrizrezener/eslint-plugin-import that referenced this issue Jun 22, 2020
Closes import-js#1638.

Signed-off-by: Beatriz Rezener <beatrizrezener@gmail.com>
beatrizrezener added a commit to beatrizrezener/eslint-plugin-import that referenced this issue Jun 22, 2020
Closes import-js#1638.

Signed-off-by: Beatriz Rezener <beatrizrezener@gmail.com>
beatrizrezener added a commit to beatrizrezener/eslint-plugin-import that referenced this issue Jun 23, 2020
Closes import-js#1638.

Signed-off-by: Beatriz Rezener <beatrizrezener@gmail.com>
beatrizrezener added a commit to beatrizrezener/eslint-plugin-import that referenced this issue Jun 23, 2020
Closes import-js#1638.

Signed-off-by: Beatriz Rezener <beatrizrezener@gmail.com>
@beatrizrezener
Copy link
Contributor

Hi guys,
I have tested and it works well on macOS, unfortunately I have seen that unix symlink files are different from windows, so it didn't work there :(

Also, I didn't find a way to make symlinks work in GitHub, although it identifies that it is a symlink file (the icon is different).

image

I don't know how common it is to use symlinks on github projects, so maybe you can enlighten me if it's okay to go on like this or if it would be better to just create a file that says it was replaced by first. A suggestion: beatrizrezener@a2a7557

@lolgab
Copy link
Author

lolgab commented Jun 23, 2020

I don't know how common it is to use symlinks on github projects, so maybe you can enlighten me if it's okay to go on like this or if it would be better to just create a file that says it was replaced by first. A suggestion: beatrizrezener/eslint-plugin-import@a2a7557

I'd say an honest deprecation notice it's much better than doing workarounds with system links that can create misconceptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

3 participants