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

[turborepo] outdated eslint doc (eslint-config-custom package) #5797

Closed
boompikachu opened this issue Aug 24, 2023 · 4 comments · Fixed by #5812
Closed

[turborepo] outdated eslint doc (eslint-config-custom package) #5797

boompikachu opened this issue Aug 24, 2023 · 4 comments · Fixed by #5812
Assignees
Labels
area: docs Improvements or additions to documentation owned-by: turborepo

Comments

@boompikachu
Copy link
Contributor

What version of Turborepo are you using?

1.10.13

What package manager are you using / does the bug impact?

pnpm

What operating system are you using?

Mac

Describe the Bug

The documentation in https://turbo.build/repo/docs/handbook/linting/eslint is outdated. In the newly created monorepo, there are no longer an index.js file in packages/eslint-config-custom but a library.js, next.js, and react-internal.js instead. The website doesn't mentioned anything about these files.

Also, the extended eslint are different; old = "custom" new = "custom/next" which is different from this section: https://turbo.build/repo/docs/getting-started/create-new#understanding-eslint-config-custom

Expected Behavior

The doc should reflect the monorepo config

To Reproduce

image image

====================

image image

Reproduction Repo

No response

@boompikachu boompikachu added kind: bug Something isn't working needs: triage New issues get this label. Remove it after triage owned-by: turborepo labels Aug 24, 2023
@tknickman
Copy link
Member

Thanks @boompikachu, we're in the middle of re-working these to be more consistent / correct. The code is landing first and the docs will follow shortly!

@tknickman tknickman self-assigned this Aug 24, 2023
@tknickman tknickman added area: docs Improvements or additions to documentation and removed kind: bug Something isn't working needs: triage New issues get this label. Remove it after triage labels Aug 24, 2023
@boompikachu
Copy link
Contributor Author

Thanks @boompikachu, we're in the middle of re-working these to be more consistent / correct. The code is landing first and the docs will follow shortly!

Thank you for an amazing monorepo

By the way, when changing from using index.ts (1.10.12) to next.js (1.10.13) file, will old users know the changes? I'm curious since if I were to init my turborepo now, will I miss out on some of the new features in the future?

@TatianaRG
Copy link

Hi, is there any updated docs/ examples how to use the newly created files ( next.is, library.js etc..) Thanks

@matrixersp
Copy link

what are the use cases of library.js?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation owned-by: turborepo
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants