-
Notifications
You must be signed in to change notification settings - Fork 23
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
ref(electron): define project source code directory structure #126
Comments
@witnet/devs comments? |
This is my proposition:
|
@anler I like it. Only objections are I'd take About the requirement for the code in |
@aesedepece that sounds perfect
We can always start by writing those inside |
#144 is the implementation follow-up of this issue. |
BREAKING CHANGE: everyone need to update what they are working on in order to follow the new project structure fix witnet#144
BREAKING CHANGE: everyone need to update what they are working on in order to follow the new project structure fix witnet#144
BREAKING CHANGE: everyone need to update what they are working on in order to follow the new project structure fix witnet#144
* refactor(file name): implement project layout defined in #126 BREAKING CHANGE: everyone need to update what they are working on in order to follow the new project structure fix #144 * chore(tslint): turn off align rule due to conflict the tslint rule for aligning blocks of code and typescript-formatter are in conflict because the formatter doesn't like aligning parameters of a function, see microsoft/TypeScript#11629
I'm integrating the work on #27 into the new project structure and I wanted to get your opinion on this proposal for the IPC methods and handlers:
What do you think, @aesedepece, @anler, @witnet/devs? |
@mmartinbar looks 👌 but here are a couple of suggestions based in my personal taste:
😬 |
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
Adapted IPC work to project layout defined in witnet#126 witnet#27
As we start to devote more efforts to the front end side of Sheikah, our project source code will naturally tend to break separation of concerns unless a directory structure policy is defined and enforced ASAP.
Being one of the most popular Electron powered projects, behold Atom for reference:
Ok, that's a overly complicated when compared to our modest structure, but I think it brings some good ideas.
As you can see, the
lib
directory is divided intobrowser
(code run in the main process),renderer
(code run by the renderer process) andcommon
(shared code). Bothrenderer
andcommon
target "browser JS", while codebrowser
is NodeJS-specific.This could be our structure for the time being:
We should give a look to some other projects with similar stacks. Counterproposals are expected 😛
The text was updated successfully, but these errors were encountered: