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

docs: exhibit defineConfig #4343

Merged
merged 1 commit into from
Jul 27, 2021
Merged

docs: exhibit defineConfig #4343

merged 1 commit into from
Jul 27, 2021

Conversation

Shinigami92
Copy link
Member

Description

I see more and more folks using just export default () = {...} and then saying that the config cannot handle this and that.
Worst case example: #4300 (reply in thread)

This can be prevented by that we exhibit defineConfig more in the docs, cause some lazy folks just copy paste and take docs as best practice.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@Shinigami92 Shinigami92 added documentation Improvements or additions to documentation p1-chore Doesn't change code behavior (priority) labels Jul 21, 2021
@Shinigami92 Shinigami92 requested a review from patak-dev July 21, 2021 19:07
@Shinigami92 Shinigami92 self-assigned this Jul 21, 2021
@Shinigami92 Shinigami92 force-pushed the exhibit-define-config branch from e2f067f to 75eb673 Compare July 21, 2021 19:56
@Shinigami92 Shinigami92 requested review from antfu and GrygrFlzr July 21, 2021 19:58
@Shinigami92
Copy link
Member Author

@antfu Would you like to review this?

@antfu antfu changed the title chore(docs): exhibit defineConfig docs: exhibit defineConfig Jul 27, 2021
@antfu antfu merged commit cd44691 into main Jul 27, 2021
@antfu antfu deleted the exhibit-define-config branch July 27, 2021 15:00
aleclarson pushed a commit to aleclarson/vite that referenced this pull request Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation p1-chore Doesn't change code behavior (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants