RFC: Roadmap for v2

Hey, as someone who has been using react-scroll for a while, I really think we should have some changes in the lib. I’m creating this issue because I have some ideas of what we need to do on a possible v2.0 (I believe @fisshy also may have a lot of things he wants to change). So far, I have tracked the following things to address:

Breaking changes:

• Remove Helpers from v2 (since it was deprecated on v1.7)

Enhancements:

• Reduce bundle size (by removing export default from modules/index.js and doing other refactorings);
• Update lib dependencies and devDependencies (important to fix security issues);
• Fix some of the issues with methods and components of the lib;
• TypeScript conversion? We have types now, but I think we could support it out of the box;
• Improve accessibility (#282);
• Add hooks (something like useScroll - more info on the comments and on #435).

Documentation:

• Update Readme and all examples (to match the latest versions of React);
• Create a website as a demo? (maybe in the future?)

Development/GitHub changes:

• Create workflows for version 2.0 (to run tests, linting…) on PR’s;
• Add Prettier, ESLint, EditorConfig;
• Remove .vscode settings (since we can add a .editorconfig, it’s not necessary);
• Add issues and PR templates for GitHub;

I really want react-scroll to be updated. We have an average of 250 thousand downloads per week on npm and we can say for sure that this lib is outdated (on examples and implementation). So let’s update it 🚀

@fisshy, we really need your opinion around here 💜

ps: this is an RFC I created, so this list may change.

[LauraBeatris]

Nice! @jpedroschmitz let me know when you send the PR so I can take a look before implementing the CI workflow

[jpedroschmitz]

That’s nice @LauraBeatris,

I will start by adding lint scripts and after that, we can include it on a CI workflow, to run on every PR.