Add Codebase Overview #7828
Add Codebase Overview #7828
Conversation
| var setInnerHTML = require('setInnerHTML'); | ||
| ``` | ||
|
|
||
| Haste was originally developed for giant apps like Facebook. It's easy to move files to different folders and iports them without worrying about relative paths. The fuzzy file search in any editor always takes you to the correct place thanks to globally unique names. |
There was a problem hiding this comment.
Thank you for writing such a detailed guide 👍
|
Might be worth while explaining the If we were to switch to CommonJS resolution that would mean that a file can only require things at the same level or below ( |
|
Going to get it in and do a separate pass about |
* Add Codebase Overview * Update codebase-overview.md * Update codebase-overview.md
|
I think some links are broken (those that have /react/contributing/.html pattern) |
|
The way our docs website is set up, links are broken on GitHub but they work on the website: I know it’s confusing 😞 |
| var setInnerHTML = require('setInnerHTML'); | ||
| ``` | ||
|
|
||
| Haste was originally developed for giant apps like Facebook. It's easy to move files to different folders and import them without worrying about relative paths. The fuzzy file search in any editor always takes you to the correct place thanks to globally unique names. |
There was a problem hiding this comment.
Technically, haste doesn't have the constraint that filename needs to be unique nor that it matches the name that you require. Haste only looks at the @providesModule token in the first comment of the file.
Most people on fb codebase use the same filename because why invent a new name and it indeeds make it easier to search files by name.
Now, React in addition to haste has an export step to npm that takes all the files, move them to the root directory and rewrites all the require('Module') to require('./Module') which uses the filename.
So in the React codebase, filenames must match the name of the @providesModule. React Native doesn't have the same step so you can name your files whatever you want for example.
Feel free to leave this comment as is, but I figured I would let you know what is exactly happening :)
There was a problem hiding this comment.
Yea I learned that since I first wrote this (as a draft) but couldn't figure out how to explain it without sounding even more confusing. Left it as is because it applies in our context.
There was a problem hiding this comment.
FWIW, @cpojer was planning to try to fix this and make them match. fingers crossed
There was a problem hiding this comment.
Yes. It is gonna happen EOY or early H1 2017.
* Add Codebase Overview * Update codebase-overview.md * Update codebase-overview.md
I'm not sure it's worth writing another Internals Guide because I feel like this covers most questions and gives good starting points for the stack reconciler. If not, I can do it though!