chore: migrate @nuxt/eslint-config from v0.1 to v0.3
#26
Conversation
✅ Deploy Preview for nuxt-leaflet ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hello @Gugustinette , please review when you have a time 🙏 |
| .override('nuxt/typescript/rules', { | ||
| rules: { | ||
| // TODO: Discuss if we want to enable this | ||
| '@typescript-eslint/no-explicit-any': 'off', |
There was a problem hiding this comment.
The typing around the Leaflet ecosystem isn't the best at the moment, which result in such things being somehow required :
declare module 'leaflet.markercluster' {
export const MarkerClusterGroup: any;
}import { ref } from 'vue';
const map = ref(null) as any; // So we can call => map.value.leafletObjectSo I agree with turning that rule off for now.
Maybe we should comment the line with something like "Required while typing around Leaflet's ecosystem isn't cleaned up." ?
There was a problem hiding this comment.
I think the same way. In the end, it would be healthier to take it in the direction of removal.
So I agree with turning that rule off for now.
The scope of application of this ESLint rule is the developer of this module.
Therefore, I think there is a way to write it in README.md so that developers can understand it.
Maybe we should comment the line with something like "Required while typing around Leaflet's ecosystem isn't cleaned up." ?
There was a problem hiding this comment.
Maybe it make sense to add some sort of CONTRIBUTING.md file to make it clear + add basic contribution stuff ? (Something like https://github.com/nuxt-modules/i18n/blob/main/CONTRIBUTING.md I guess)
I prefer not to overload the README file if possible (I mean I hate it when I open a git repo and the Readme is 1000 lines lol)
There was a problem hiding this comment.
Which mean we could remove the "Development" section of the README.md and make a link to CONTRIBUTING.md at the top of the README.
There was a problem hiding this comment.
Well, the contribution guide would be better since it's for development.
Since the content is different from this PR, it would like to create a separate issue and create a contribution guide.
There was a problem hiding this comment.
Btw, a contribution guide was recently added to Nuxt Script. This may be helpful.
nuxt/scripts#109
https://scripts.nuxt.com/docs/getting-started/contributing
There was a problem hiding this comment.
Yeah you can create a separate issue ! 😄
The contributing guide could be in the "About" section of the doc, should look better.
For this PR just keep a comment on the file and I'll merge.
There was a problem hiding this comment.
@shinGangan Can you update the comment with "Required while Leaflet's typing isn't improved" ?
(Also, maybe it's worth pulling last changes and run the lint command again to make sure any new files are linted correctly)
There was a problem hiding this comment.
Sorry, I overlooked it...
I'll respond to added the comments!
Also, there's a conflict, so I'll address that as well.
|
I handled everything here : #36 So this is no longer necessary, but I used your config file thanks 👍 |
|
I was busy overwhelmed, so thank you for taking care of it! 🙏 |
🔗 Linked issue
❓ Type of change
📚 Description
migrating
@nuxt/eslint-configfromv0.1.1tov0.3.0.In addition, fix lint error.