search

graphieros / vue-data-ui

An open source user-empowering data visualization Vue 3 components library for eloquent data storytelling
https://vue-data-ui.graphieros.com/
MIT License
1.08k stars 50 forks source link

Fix - casing typo in the ArenaVueUiStackbar filename #98

Closed cyrilf closed 4 weeks ago

cyrilf commented 4 weeks ago

When installing the project locally on Linux (Ubuntu in my case, but it would be the same for any OS with a file system that is case-sensitive), there is an error in the console:

[vite] Internal server error: Failed to resolve import "../TestingArena/ArenaVueUiStackbar.vue" from "src/App.vue". Does the file exist?

So I simply renamed the file as ArenaVueUiStackbar (with a lower b to bar) seems to be the dominant choice in the code-base.

Side note:

I see a similar difference between the types and the README for VueUiSparkStackBarConfig and VueUiSparkStackbarDatasetItem. Sometimes it's upper case for Bar sometimes lowercase bar. I was going to include a second commit to fix it in this PR, but actually I don't know if changing a type is a breaking change or not. So I'll let you handle it if you think it's necessary.

graphieros commented 4 weeks ago

Thanks @cyrilf :) Basically the readme should reflect the types in .d.ts. Changing a type name there leads to breaking changes unfortunately.

cyrilf commented 3 weeks ago

Yes, ok. @graphieros As you can see on this page the casing is not correct. Even if it's a breaking change, I would favor renaming the type file to respect the repo naming convention, in which case I have a commit ready, let me know. Otherwise, I let you handle the renaming in the README and instalation files?

graphieros commented 3 weeks ago

Allright @cyrilf let's go for the type renaming :)