Skip to content

Update README.md to improve integration #35

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

Merged
merged 3 commits into from
Apr 15, 2025
Merged

Conversation

nckrtl
Copy link
Contributor

@nckrtl nckrtl commented Apr 8, 2025

Strictly following the current readme doesn't result in Wayfinder working properly (with at least Vue). The following changes should:

  • The suggested aliases require you to als update your tsconfig, else it's not aware of the aliases (this is not mentioned in the readme). Suggestion: just instruct to setup the general @ alias.
  • Defining a relative path is not recommend as per vite.dev: "When aliasing to file system paths, always use absolute paths. Relative alias values will be used as-is and will not be resolved into file system paths."
  • Updated all @routes and @actions to @/routes and @/actions

@timacdonald
Copy link
Member

I don't mind if we remove the additional aliases, but if we go down this path, I'd recommend we remove the alias section all together. The Laravel Vite plugin already adds the @ alias.

Removed the alias section and added a note under the first template/code example using the @ alias.
@nckrtl
Copy link
Contributor Author

nckrtl commented Apr 9, 2025

Yeah that makes sense. Removed the alias section. I wasn't aware myself that Laravel Vite Plugin provides the alias by default. I think it makes sense to mention it. I placed a note under the first template/code example.

@timacdonald
Copy link
Member

I've removed the note. Think I would rather we make the assumption that the application is using the Vite plugin and work out how to improve it once we have people that are having issues.

@timacdonald timacdonald merged commit fe3e183 into laravel:main Apr 15, 2025
7 checks passed
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.

2 participants