Move files and reorganize

kgryte · kgryte · commit e79b550fc532 · 2021-08-13T12:19:57.000-07:00
diff --git a/tools/make/Makefile b/tools/make/Makefile
@@ -88,7 +88,6 @@ include $(TOOLS_MAKE_LIB_DIR)/links/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/lint/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/ls/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/markdown/Makefile
-include $(TOOLS_MAKE_LIB_DIR)/node/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/notes/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/repl/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/stats/Makefile
diff --git a/tools/make/lib/install/Makefile b/tools/make/lib/install/Makefile
@@ -16,6 +16,12 @@
 # limitations under the License.
 #/
 
+# DEPENDENCIES #
+
+# Please keep in alphabetical order...
+include $(TOOLS_MAKE_LIB_DIR)/install/node.mk
+
+
 # RULES #
 
 #/
@@ -24,6 +30,6 @@
 # @example
 # make install
 #/
-install: install-node
+install: install-node clean-deps-electron install-deps-electron
 
 .PHONY: install
diff --git a/tools/make/lib/install/README.md b/tools/make/lib/install/README.md
@@ -26,7 +26,12 @@ limitations under the License.
 
 <section class="intro">
 
-This directory contains [`make`][make] rules for running the project's installation processes.
+This directory contains [`make`][make] rules for running the project's installation processes (e.g., managing [Node.js][node-js] environments, including `node_modules` dependencies and Node.js native [add-ons][node-js-add-ons]).
+
+-   [Commands](#commands)
+
+    -   [Install](#install)
+    -   [Node.js](#nodejs)
 
 </section>
 
@@ -54,6 +59,72 @@ Runs the project's install sequence.
 $ make install
 ```
 
+* * *
+
+<a name="nodejs"></a>
+
+### Node.js
+
+#### install-node
+
+Installs node modules dependencies and compiles native [add-ons][node-js-add-ons].
+
+<!-- run-disable -->
+
+```bash
+$ make install-node
+```
+
+#### clean-node
+
+Runs cleanup tasks specific to Node.js, such as removing node modules dependencies and compiled native [add-ons][node-js-add-ons].
+
+<!-- run-disable -->
+
+```bash
+$ make clean-node
+```
+
+#### install-node-modules
+
+Installs node modules dependencies.
+
+<!-- run-disable -->
+
+```bash
+$ make install-node-modules
+```
+
+#### clean-node-modules
+
+Removes node modules dependencies.
+
+<!-- run-disable -->
+
+```bash
+$ make clean-node-modules
+```
+
+#### install-node-addons
+
+Compiles Node.js native [add-ons][node-js-add-ons].
+
+<!-- run-disable -->
+
+```bash
+$ make install-node-addons
+```
+
+#### clean-node-addons
+
+Removes Node.js native [add-ons][node-js-add-ons].
+
+<!-- run-disable -->
+
+```bash
+$ make clean-node-addons
+```
+
 </section>
 
 <!-- /.usage -->
@@ -72,6 +143,10 @@ $ make install
 
 [make]: https://www.gnu.org/software/make/
 
+[node-js]: https://nodejs.org/en/
+
+[node-js-add-ons]: https://nodejs.org/api/addons.html
+
 </section>
 
 <!-- /.links -->
diff --git a/tools/make/lib/install/addons.mk b/tools/make/lib/install/addons.mk
@@ -20,12 +20,6 @@
 
 # Define the path of the executable for [node-gyp][1].
 #
-# To install `node-gyp`:
-#
-# ```bash
-# $ npm install node-gyp
-# ```
-#
 # [1]: https://github.com/nodejs/node-gyp
 NODE_GYP ?= $(BIN_DIR)/node-gyp
 
@@ -54,12 +48,18 @@ endif
 install_node_addons_list_addons_flags := "--pattern $(node_addons_pattern)"
 
 
-# TARGETS #
+# RULES #
 
-# Install add-ons.
+#/
+# Installs Node.js native add-ons.
 #
-# This target installs native add-ons. If unable to install a native add-on, the target prints an error message and proceeds to try installing the next add-on.
-
+# ## Notes
+#
+# -   If unable to install a native add-on, the target prints an error message and proceeds to try installing the next add-on.
+#
+# @example
+# make install-node-addons
+#/
 install-node-addons: $(NODE_MODULES) clean-node-addons
 	$(QUIET) $(MAKE) LIST_PACKAGE_ADDONS_FLAGS=$(install_node_addons_list_addons_flags) -f $(this_file) list-pkgs-addons | while read -r pkg; do \
 		if echo "$$pkg" | grep -v '^\/.*\|^[a-zA-Z]:.*' >/dev/null; then \
@@ -77,11 +77,12 @@ install-node-addons: $(NODE_MODULES) clean-node-addons
 
 .PHONY: install-node-addons
 
-
-# Remove add-ons.
+#/
+# Removes all compiled and generated files for Node.js native add-ons.
 #
-# This target removes all compiled and generated files for native add-ons.
-
+# @example
+# make clean-node-addons
+#/
 clean-node-addons:
 	$(QUIET) $(MAKE) LIST_PACKAGE_ADDONS_FLAGS=$(install_node_addons_list_addons_flags) -f $(this_file) list-pkgs-addons | while read -r pkg; do \
 		if echo "$$pkg" | grep -v '^\/.*\|^[a-zA-Z]:.*' >/dev/null; then \
diff --git a/tools/make/lib/install/modules.mk b/tools/make/lib/install/modules.mk
diff --git a/tools/make/lib/install/node.mk b/tools/make/lib/install/node.mk
@@ -18,25 +18,37 @@
 
 # DEPENDENCIES #
 
-include $(TOOLS_MAKE_LIB_DIR)/node/addons.mk
-include $(TOOLS_MAKE_LIB_DIR)/node/modules.mk
+# Please keep in alphabetical order...
+include $(TOOLS_MAKE_LIB_DIR)/install/addons.mk
+include $(TOOLS_MAKE_LIB_DIR)/install/modules.mk
 
 
-# TARGETS #
+# RULES #
 
-# Run Node install sequence.
+#/
+# Runs the Node.js install sequence.
 #
-# This target runs the Node install sequence, including installing node module dependencies and compiling native add-ons.
-
-install-node: install-node-modules install-node-addons clean-deps-electron install-deps-electron
+# ## Notes
+#
+# -   This recipe installs node module dependencies and compiles native add-ons.
+#
+# @example
+# make install-node
+#/
+install-node: install-node-modules install-node-addons
 
 .PHONY: install-node
 
-
-# Perform Node clean-up.
+#/
+# Runs cleanup tasks specific to Node.js.
 #
-# This target runs cleanup tasks specific to Node.js, such as removing node module dependencies and removing native add-ons.
-
+# ## Notes
+#
+# -   This recipe removes node module dependencies and native add-ons.
+#
+# @example
+# make clean-node
+#/
 clean-node: clean-node-addons clean-node-modules
 
 .PHONY: clean-node
diff --git a/tools/make/lib/node/README.md b/tools/make/lib/node/README.md
