Merge branch 'develop' into feat/stats-base-dists-f-pdf-c-port

Author: rautelaKamal

.github/workflows/lint_changed_files.yml

@@ -341,6 +341,43 @@ jobs:
             make lint-typescript-declarations-files FILES="${files}"
           fi
 
+      # Lint TypeScript declarations test files:
+      - name: 'Lint TypeScript declarations test files'
+        if: success() || failure()
+        run: |
+          # Determine root directory:
+          root=$(git rev-parse --show-toplevel)
+
+          # Define the path to ESLint configuration file for linting TypeScript tests:
+          eslint_typescript_tests_conf="${root}/etc/eslint/.eslintrc.typescript.tests.js"
+
+          # Get changed files:
+          changed_files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n')
+
+          # Get directly changed `test.ts` files:
+          files=$(echo "${changed_files}" | grep '/docs/types/test\.ts$' | tr '\n' ' ' | sed 's/ $//')
+
+          # Also get `test.ts` files corresponding to changed `index.d.ts` files...
+          declaration_files=$(echo "${changed_files}" | grep '/docs/types/.*\.d\.ts$' | sed 's/ $//')
+          if [[ -n "${declaration_files}" ]]; then
+            while IFS= read -r decl_file; do
+              # Only process index.d.ts files (skip other .d.ts files)
+              if [[ "${decl_file}" == */index.d.ts ]]; then
+                # Replace `index.d.ts` with `test.ts` to get the test file path:
+                test_file="${decl_file%index.d.ts}test.ts"
+
+                # Check if the test file exists and isn't already in the list:
+                if [[ -f "${test_file}" ]] && [[ ! " ${files} " =~ [[:space:]]${test_file}[[:space:]] ]]; then
+                  files="${files} ${test_file}"
+                fi
+              fi
+            done <<< "${declaration_files}"
+          fi
+
+          if [[ -n "${files}" ]]; then
+            make lint-typescript-declarations-files FILES="${files}" ESLINT_TS_CONF="${eslint_typescript_tests_conf}"
+          fi
+
       # Lint license headers:
       - name: 'Lint license headers'
         if: success() || failure()

lib/node_modules/@stdlib/_tools/links/create/test/test.cli.js

@@ -153,7 +153,7 @@ tape( 'the command-line interface tries to insert an entry for the provided URI
 
 	exec( cmd.join( ' ' ), done );
 
-	expected = 'Error: duplicate entry. Database already contains an entry for the provided URI: https://stdlib.io/.\n';
+	expected = 'Error: invalid argument. Database already contains an entry for the provided URI. Value: `https://stdlib.io/`.\n';
 
 	function done( error, stdout, stderr ) {
 		t.strictEqual( error instanceof Error, true, 'returns expected value' );
@@ -180,7 +180,7 @@ tape( 'the command-line interface tries to insert an entry for the provided URI
 	child.stdin.write( 'A standard library for JavaScript and Node.js\n' );
 	child.stdin.end();
 
-	expected = 'Error: duplicate entry. Database already contains an entry for the provided URI: https://stdlib.io/.\n';
+	expected = 'Error: invalid argument. Database already contains an entry for the provided URI. Value: `https://stdlib.io/`.\n';
 
 	function done( error, stdout, stderr ) {
 		stdout = stdout.toString();

lib/node_modules/@stdlib/_tools/lint/pkg-json-names/test/test.lint.js

@@ -25,6 +25,7 @@ var resolve = require( 'path' ).resolve;
 var tape = require( 'tape' );
 var isObjectArray = require( '@stdlib/assert/is-object-array' );
 var contains = require( '@stdlib/assert/contains' );
+var lint = require( './../lib/lint.js' );
 
 
 // FIXTURES //
@@ -35,8 +36,6 @@ var missingNamePath = join( __dirname, 'fixtures', 'missing-name.json' );
 var wrongScopePath = join( __dirname, 'fixtures', 'wrong-scope.json' );
 var nameMismatchPath = join( __dirname, 'fixtures', 'name-mismatch.json' );
 
-var lint = require( './../lib/lint.js' );
-
 
 // TESTS //
 

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/README.md

@@ -0,0 +1,139 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# Includes
+
+> [remark][remark] plugin to insert content from external Markdown files.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var includes = require( '@stdlib/_tools/remark/plugins/remark-includes' );
+```
+
+#### includes( \[options\] )
+
+Attaches a plugin to a [remark][remark] processor in order to insert content from external Markdown files between include comment directives.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var join = require( 'path' ).join;
+var remark = require( 'remark' );
+
+var opts = {
+    'dir': join( __dirname, 'snippets' )
+};
+
+var str = '# Hello World!\n';
+str += '\n';
+str += '<!-- <include path="./foo.md"> -->\n';
+str += '\n';
+str += '<!-- </include> -->\n';
+
+var vfile = remark().use( includes, opts ).processSync( str );
+```
+
+The plugin accepts the following options:
+
+-   **dir**: base directory for resolving include paths. Default: `null` (i.e., include paths are resolved relative to the processed file's directory).
+
+By default, include paths are resolved relative to the processed file's directory. Accordingly, when processing an in-memory string without a file path, includes may not be resolved unless a base directory is provided via the `dir` option.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The plugin recognizes HTML comments of the form
+
+    ```html
+    <!-- <include path="./relative/path/to/file.md"> -->
+
+    <!-- </include> -->
+    ```
+
+    and inserts the parsed Markdown content of the referenced file between the opening and closing comment tags.
+
+-   The opening include directive requires a `path` attribute with a double-quoted value.
+
+-   Include blocks must be non-overlapping sibling regions. Nested or overlapping include blocks are not supported.
+
+-   If a referenced file cannot be found, the plugin issues a warning and leaves the include block unchanged.
+
+-   If an opening include directive does not have a matching closing include directive, the plugin issues a warning and leaves the include block unchanged.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error", node/no-sync: "off" -->
+
+```javascript
+var join = require( 'path' ).join;
+var remark = require( 'remark' );
+var readFileSync = require( '@stdlib/fs/read-file' ).sync;
+var includes = require( '@stdlib/_tools/remark/plugins/remark-includes' );
+
+// Load a Markdown file...
+var fpath = join( __dirname, 'examples', 'fixtures', 'simple.txt' );
+var opts = {
+    'encoding': 'utf8'
+};
+var file = readFileSync( fpath, opts );
+
+// Insert includes:
+var vfile = remark().use( includes, {
+    'dir': join( __dirname, 'examples', 'fixtures' )
+}).processSync( file );
+
+console.log( vfile.contents );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[remark]: https://github.com/wooorm/remark
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/examples/fixtures/bar.txt

@@ -0,0 +1,3 @@
+## Bap
+
+Bip bop.

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/examples/fixtures/foo.txt

@@ -0,0 +1,3 @@
+## Greeting
+
+Beep boop.

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/examples/fixtures/simple.txt

@@ -0,0 +1,9 @@
+# Hello World!
+
+<!-- <include path="./foo.txt"> -->
+
+<!-- </include> -->
+
+<!-- <include path="./bar.txt"> -->
+
+<!-- </include> -->

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/examples/index.js

@@ -0,0 +1,39 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var join = require( 'path' ).join;
+var remark = require( 'remark' );
+var readFileSync = require( '@stdlib/fs/read-file' ).sync;
+var includes = require( './../lib' );
+
+// Load a Markdown file...
+var fpath = join( __dirname, 'fixtures', 'simple.txt' );
+var opts = {
+	'encoding': 'utf8'
+};
+var file = readFileSync( fpath, opts );
+
+// Insert includes:
+var vfile = remark().use( includes, {
+	'dir': join( __dirname, 'fixtures' )
+}).processSync( file );
+
+// Print the results:
+console.log( vfile.contents );

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/lib/attacher.js

@@ -0,0 +1,71 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var logger = require( 'debug' );
+var copy = require( '@stdlib/utils/copy' );
+var isObject = require( '@stdlib/assert/is-plain-object' );
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
+var format = require( '@stdlib/string/format' );
+var transformerFactory = require( './transformer.js' );
+var defaults = require( './defaults.json' );
+
+
+// VARIABLES //
+
+var debug = logger( 'remark-includes:attacher' );
+
+
+// MAIN //
+
+/**
+* Attaches a plugin to a remark processor in order to insert content from external Markdown files.
+*
+* @param {Options} [options] - options object
+* @param {string} [options.dir] - base directory for resolving include paths
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
+* @returns {Function} transformer
+*/
+function attacher( options ) {
+	var opts = copy( defaults );
+
+	// NOTE: cannot use `arguments.length` check, as `options` may be explicitly passed as `undefined`
+	if ( options !== void 0 ) {
+		if ( !isObject( options ) ) {
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+		}
+		if ( hasOwnProp( options, 'dir' ) ) {
+			if ( !isString( options.dir ) ) {
+				throw new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'dir', options.dir ) );
+			}
+			opts.dir = options.dir;
+		}
+	}
+	debug( 'Attaching a plugin configured with the following options: %s', JSON.stringify( opts ) );
+	return transformerFactory( opts );
+}
+
+
+// EXPORTS //
+
+module.exports = attacher;

lib/node_modules/@stdlib/_tools/remark/plugins/remark-includes/lib/defaults.json

@@ -0,0 +1,3 @@
+{
+  "dir": null
+}