aprilmintacpineda · May 13, 2022 10:38 · Jan 7, 2020 · Jan 7, 2020 · Dec 26, 2019 · Dec 26, 2019
diff --git a/NodeJS require local modules resolver.md b/NodeJS require local modules resolver.md
@@ -52,5 +52,5 @@ You can now use `_require` for your `local modules`, and you can still use `requ
 
 1. This is not a hacky solution that suggests you mess with a built-in function of node that might change in future version, in short, it's version independent and might even work with previous versions of node with the assumption that `path` and `require` on those version works the same way, unless that version of node implements `_require` as a built-in function, if it does, then simply change the name? ¯\_(ツ)_/¯
 2. It works globally anywhere in your NodeJS app.
-3. You don't have to manually do something like `require(`${basepath}/my/module.js`)`.
+3. You don't have to manually do something like ```require(`${basepath}/my/module.js`)```.
 4. Since we are using `path` module, it should work on other OS too. (Tell me if it doesn't, I'd like to figure out why).
diff --git a/NodeJS require local modules resolver.md b/NodeJS require local modules resolver.md
@@ -46,4 +46,11 @@ The file structure would look like:
 |- constants.js
 ```
 
-You can now use `_require` for your `local modules`, and you can still use `require` for your `node_modules`.
+You can now use `_require` for your `local modules`, and you can still use `require` for your `node_modules`.
+
+## Why use this solution?
+
+1. This is not a hacky solution that suggests you mess with a built-in function of node that might change in future version, in short, it's version independent and might even work with previous versions of node with the assumption that `path` and `require` on those version works the same way, unless that version of node implements `_require` as a built-in function, if it does, then simply change the name? ¯\_(ツ)_/¯
+2. It works globally anywhere in your NodeJS app.
+3. You don't have to manually do something like `require(`${basepath}/my/module.js`)`.
+4. Since we are using `path` module, it should work on other OS too. (Tell me if it doesn't, I'd like to figure out why).
diff --git a/NodeJS require local modules resolver.md b/NodeJS require local modules resolver.md
@@ -18,6 +18,8 @@ on the top of your `server.js` or whatever the filename is of that which you run
 ```js
 const path = require('path');
 global._require = module => require(path.join(__dirname, module));
+
+//.. rest of your codes
 ```
 
 Then on `a/very/far/away/module.js`:

diff --git a/NodeJS require local modules resolver.md b/NodeJS require local modules resolver.md
@@ -23,9 +23,10 @@ global._require = module => require(path.join(__dirname, module));
 Then on `a/very/far/away/module.js`:
 
 ```js
+// coming from /root/libs/validator
 const validator = _require('libs/validator');
-// coming from the /root
-const { validListOfThings } = require('constants');
+// coming from the /root/constanst
+const { validListOfThings } = _require('constants');
 ```
 
 The file structure would look like:

diff --git a/NodeJS require local modules resolver.md b/NodeJS require local modules resolver.md
@@ -22,7 +22,7 @@ global._require = module => require(path.join(__dirname, module));
 
 Then on `a/very/far/away/module.js`:
 
-```
+```js
 const validator = _require('libs/validator');
 // coming from the /root
 const { validListOfThings } = require('constants');

diff --git a/README.md → NodeJS require local modules resolver.md b/README.md → NodeJS require local modules resolver.md
diff --git a/README.md b/README.md
@@ -1,4 +1,16 @@
-The simplest solution I thought of:
+# NodeJS require concept for local modules
+
+## The problem
+
+As your NodeJS app grows bigger, the file structure tends to go 3 to even 5 layers deep. The problem now is as you `require` local modules you created, you'll have to write them in this way:
+
+```js
+const myModule = require('../../../my/module');
+```
+
+This can become an awful developer experience.
+
+## The simplest solution I thought of:
 
 
 on the top of your `server.js` or whatever the filename is of that which you run first when you startup your nodejs application.

diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+The simplest solution I thought of:
+
+
+on the top of your `server.js` or whatever the filename is of that which you run first when you startup your nodejs application.
+
+```js
+const path = require('path');
+global._require = module => require(path.join(__dirname, module));
+```
+
+Then on `a/very/far/away/module.js`:
+
+```
+const validator = _require('libs/validator');
+// coming from the /root
+const { validListOfThings } = require('constants');
+```
+
+The file structure would look like:
+
+```
+/root
+|- a
+|  |- very
+|  |  |- far
+|  |  |  |- away
+|  |  |  |  |- module.js
+|- libs
+|  |- validator.js
+|- server.js
+|- constants.js
+```
+
+You can now use `_require` for your `local modules`, and you can still use `require` for your `node_modules`.