Rename files and update build tools

Author: kgryte

.npmrc

@@ -0,0 +1,34 @@
+#/
+# @license MIT
+#
+# Copyright (c) 2020 Python Data APIs Consortium.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#/
+
+# Configuration for [npm][1].
+#
+# [1]: https://docs.npmjs.com/files/npmrc
+
+# Disable the creation of a lock file:
+package-lock = false
+shrinkwrap = false
+
+# Disable automatically "saving" dependencies on install:
+save = false

Makefile

@@ -111,15 +111,18 @@ ROOT_DIR ?= $(this_dir)
 # Define the directory for documentation:
 DOCS_DIR ?= $(ROOT_DIR)/docs
 
+# Define the directory for data:
+DATA_DIR ?= $(ROOT_DIR)/data
+
+# Define the directory for scripts:
+SCRIPTS_DIR ?= $(ROOT_DIR)/scripts
+
 # Define the path to the root `package.json`:
 ROOT_PACKAGE_JSON ?= $(ROOT_DIR)/package.json
 
 # Define the top-level directory containing node module dependencies:
 NODE_MODULES ?= $(ROOT_DIR)/node_modules
 
-# Define the folder name convention for scripts:
-SCRIPTS_FOLDER ?= scripts
-
 # Define the delete command:
 DELETE ?= -rm
 DELETE_FLAGS ?= -rf
@@ -138,6 +141,15 @@ else
 endif
 # TODO: add Windows command
 
+# Define the output file path for combined join data as JSON:
+JOIN_JSON_OUT ?= $(DATA_DIR)/join.json
+
+# Define the output file path for combined join data as CSV:
+JOIN_CSV_OUT ?= $(DATA_DIR)/join.csv
+
+# Define the output file path for viewing join data as an HTML table:
+JOIN_HTML_OUT ?= $(DOCS_DIR)/join.html
+
 
 # RULES #
 
@@ -150,80 +162,81 @@ endif
 # @example
 # make all
 #/
-all: install
+all: install join
 
 .PHONY: all
 
 #/
-# Prints the runtime value of a `Makefile` variable.
-#
-# ## Notes
-#
-# -   The rule uses the following format:
-#
-#     ```bash
-#     $ make inspect.<variable>
-#     ```
+# Installs project dependencies.
 #
 # @example
-# make inspect.ROOT_DIR
+# make install
+#/
+install: install-node
+
+.PHONY: install
+
+#/
+# Install node module dependencies.
 #
 # @example
-# make inspect.CC
+# make install-node
 #/
-inspect.%:
-	$(QUIET) echo '$*=$($*)'
+install-node:
+	$(QUIET) $(NPM) install
+
+.PHONY: install-node
 
 #/
-# Asserts that a `Makefile` variable is set.
-#
-# ## Notes
+# Generates a JSON file combining individual library join data.
 #
-# -   The rule uses the following format:
-#
-#     ```bash
-#     $ make assert.<variable>
-#     ```
+# @private
+#/
+$(JOIN_JSON_OUT):
+	$(QUIET) $(NODE) $(SCRIPTS_DIR)/join_json.js > $(JOIN_JSON_OUT)
+
+#/
+# Generates a CSV file combining individual library join data.
 #
-# -   If a variable is **not** set, the recipe exits with a non-zero exit code.
+# @private
+#/
+$(JOIN_CSV_OUT): $(JOIN_JSON_OUT)
+	$(QUIET) $(NODE) $(SCRIPTS_DIR)/join_csv.js > $(JOIN_CSV_OUT)
+
+#/
+# Generates HTML assets for viewing join data.
 #
-# @example
-# make inspect.CXX
+# @private
 #/
-assert.%:
-	$(QUIET) if [[ "${${*}}" = "" ]]; then \
-		echo "\nError: You must set the environment variable: ${*}.\n"; \
-		exit 1; \
-	fi
+$(JOIN_HTML_OUT): $(JOIN_JSON_OUT)
+	$(QUIET) $(NODE) $(SCRIPTS_DIR)/join_html.js > $(JOIN_HTML_OUT)
 
 #/
-# Installs project dependencies.
+# Generates data assets combining individual join data.
 #
 # @example
-# make install
+# make join
 #/
-install: install-node
-
-.PHONY: install
+join: $(JOIN_JSON_OUT) $(JOIN_CSV_OUT) $(JOIN_HTML_OUT)
 
 #/
-# Install node module dependencies.
+# Opens a data table in a web browser.
 #
 # @example
-# make install-node
+# make view-table
 #/
-install-node:
-	$(QUIET) $(NPM) install
+view-table: $(JOIN_HTML_OUT)
+	$(QUIET) $(OPEN) $(JOIN_HTML_OUT)
 
-.PHONY: install-node
+.PHONY: view-table
 
 #/
 # Runs the project's cleanup sequence.
 #
 # @example
 # make clean
 #/
-clean: clean-node clean-docs
+clean: clean-node clean-data clean-docs
 
 .PHONY: clean
 
@@ -237,24 +250,62 @@ clean-node:
 
 .PHONY: clean-node
 
+#/
+# Removes generated datasets.
+#
+# @example
+# make clean-data
+#/
+clean-data:
+	$(QUIET) $(DELETE) $(DELETE_FLAGS) $(JOIN_JSON_OUT)
+	$(QUIET) $(DELETE) $(DELETE_FLAGS) $(JOIN_CSV_OUT)
+
 #/
 # Removes generated documentation.
 #
 # @example
 # make clean-docs
 #/
 clean-docs:
-	$(QUIET) $(DELETE) $(DELETE_FLAGS) $(DOCS_DIR)/index.html
+	$(QUIET) $(DELETE) $(DELETE_FLAGS) $(JOIN_HTML_OUT)
 
 .PHONY: clean-docs
 
 #/
-# Opens the main data table in a web browser.
+# Prints the runtime value of a `Makefile` variable.
+#
+# ## Notes
+#
+# -   The rule uses the following format:
+#
+#     ```bash
+#     $ make inspect.<variable>
+#     ```
 #
 # @example
-# make view-data-table
+# make inspect.ROOT_DIR
 #/
-view-data-table:
-	$(QUIET) $(OPEN) $(DOCS_DIR)/index.html
+inspect.%:
+	$(QUIET) echo '$*=$($*)'
 
-.PHONY: view-data-table
+#/
+# Asserts that a `Makefile` variable is set.
+#
+# ## Notes
+#
+# -   The rule uses the following format:
+#
+#     ```bash
+#     $ make assert.<variable>
+#     ```
+#
+# -   If a variable is **not** set, the recipe exits with a non-zero exit code.
+#
+# @example
+# make assert.ROOT_DIR
+#/
+assert.%:
+	$(QUIET) if [[ "${${*}}" = "" ]]; then \
+		echo "\nError: You must set the environment variable: ${*}.\n"; \
+		exit 1; \
+	fi

README.md

@@ -79,7 +79,7 @@ $ cd ./array-api-comparison
 You can view the main data table in your local web browser by running
 
 ```bash
-$ make view-data-table
+$ make view-table
 ```
 
 * * *

docs/index.html docs/join.html

@@ -7690,3 +7690,4 @@ <h1>Array API Comparison</h1>
 	<script src="js/main.js"></script>
 </body>
 </html>
+

docs/template.html docs/join_template.html

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+
+/**
+* @license MIT
+*
+* Copyright (c) 2020 Python Data APIs Consortium.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all
+* copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+* SOFTWARE.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var readJSON = require( '@stdlib/fs/read-json' ).sync;
+var json2csv = require( './utils/json2csv.js' );
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var fpath;
+	var fopts;
+	var data;
+
+	fopts = {
+		'encoding': 'utf8'
+	};
+
+	// Load source data:
+	fpath = resolve( __dirname, '..', 'data', 'join.json' );
+	data = readJSON( fpath, fopts );
+	if ( data instanceof Error ) {
+		console.error( data.message );
+		return;
+	}
+	// Print the data as CSV:
+	console.log( json2csv( data ) );
+}
+
+main();

scripts/join_csv.js

@@ -29,7 +29,6 @@
 // MODULES //
 
 var resolve = require( 'path' ).resolve;
-var writeFile = require( '@stdlib/fs/write-file' ).sync;
 var readFile = require( '@stdlib/fs/read-file' ).sync;
 var readJSON = require( '@stdlib/fs/read-json' ).sync;
 var replace = require( '@stdlib/string/replace' );
@@ -50,7 +49,6 @@ function main() {
 	var keys;
 	var tmpl;
 	var out;
-	var err;
 	var N;
 	var M;
 	var d;
@@ -97,21 +95,16 @@ function main() {
 	out += '</table>';
 
 	// Load the HTML template:
-	fpath = resolve( __dirname, '..', 'docs', 'template.html' );
+	fpath = resolve( __dirname, '..', 'docs', 'join_template.html' );
 	tmpl = readFile( fpath, fopts );
 	if ( tmpl instanceof Error ) {
 		console.error( tmpl.message );
 		return;
 	}
 	tmpl = replace( tmpl, '{{TABLE}}', out );
 
-	// Write the generated HTML table to file:
-	fpath = resolve( __dirname, '..', 'docs', 'index.html' );
-	err = writeFile( fpath, tmpl, fopts );
-	if ( err instanceof Error ) {
-		console.error( err.message );
-		return;
-	}
+	// Print the generated HTML table to stdout:
+	console.log( tmpl );
 }
 
 main();