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

Update 1.setup.md #473

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update 1.setup.md #473

wants to merge 1 commit into from

Conversation

hermes85pl
Copy link

Provide alternative setting for development in a cleaner way.

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes (if not applicable, please state why)

Provide alternative setting for development in a cleaner way.
Copy link

vercel bot commented Jun 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nuxt-security ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 4, 2024 5:15pm

@hermes85pl
Copy link
Author

hermes85pl commented Jun 4, 2024

I think that it would be better to find a solution to make DevTools work out of the box, without any additional configuration, as they are becoming omnipresent. In my opinion requiring everyone to do the same change in their configuration should be avoided and the module should resort to providing reasonable defaults instead. Still, until such a decision is made, I think that the change that I proposed enables the module's users to make a cleaner change in their configuration in order for DevTools to work.

@Baroshem
Copy link
Owner

Baroshem commented Jun 7, 2024

Hey @hermes85pl

I do agree with your idea. @vejja do you think we should ship such if statement as a part of the default config?

detect what is the environment and if it is dev then set a different value of the header automaically to avoid conflict with the dev tools? We could keep the devtools section with an info that in the default config it is supported but if you change it you can solve the issue like following.

WDYT?

@hermes85pl
Copy link
Author

So there would be some information that the default config for the development environment is slightly different (with the explanation what exactly and why so), and additionally how to achieve the same (using the above method) to achieve the same in case you provided your own config and the DevTools stopped working for you? Did I get it right?

@Baroshem
Copy link
Owner

Yes, thats the idea so that majority of the users wouldnt have to set the same config in dev environment as majority of the users already use dev tools (we are anning to have some devtools integration as well once I find a time to implement it 😃)

@Baroshem
Copy link
Owner

@vejja what are your thoughts? :)

@vejja
Copy link
Collaborator

vejja commented Jun 24, 2024

I think it's a good idea !

@Baroshem
Copy link
Owner

@hermes85pl would you be interested in creating a PR with this change where the setup of this specific header wouldnt be neede at all in dev environment?

We can provide all help needed :)

@hermes85pl
Copy link
Author

It doesn't fit in my agenda, and this is why I created this PR instead and only suggested a better idea for the final solution.

How do you feel about merging this PR to change the docs like this until there is a better solution?

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

Successfully merging this pull request may close these issues.

None yet

3 participants