Monorepo inital structure & bootstrap vscode extension

[sergioflores-j]

[WIP]

Summary

Move the project to a monorepo structure so we can create the VSCode extension.

This PR fixes/implements the following bugs/features:

For the MVP

• [X] Monorepo setup using npm workspaces
  • [x] ESLint/TSConfig working in the new setup
  • [ ] Makefile working
• [X] Bootstraps VSCode Extension (WIP: hello-world)
• [ ] Documentation

Next steps - To be discussed

Create issues accordingly

• For the monorepo
  • Using yarn workspaces: so we can run commands within a working directory
  • Using NX: so we can have some tools for the workspace (e.g. nx affected) so we can get rid of most Makefile scripts & easily publish new versions for each package.
• Possible packages split:
  • CLI from core (so we can run core checks independently from the "interface" that is calling)
  • Docs generator script from core
  • Rules from core (would maybe solve registry issue)

Closing issues

Resolves #12

[sergioflores-j]

@flaviostutz / @tiagostutz what do you guys think about this structure?

I'm still working on the vscode extension itself, but I'd like to collect some feedback on the simplest monorepo setup we could have to bootstrap this!

My approach for the monorepo MVP:

• Use npm workspaces to manage (shared) dependencies
• Makefile in the root with scripts running for both packages (WIP)

The ideal state (next iterations):

• Use NX to maintain the packages / publish new versions. Just so we keep everything in sync (GH releases, tags, package.json's, etc)
  • Some good monorepo for inspiration: https://github.com/facebook/jest & https://github.com/storybookjs/storybook

Let me know what are your thoughts!