Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

.github/workflows/scaffold_pkg_via_branch_push.yml

@@ -84,8 +84,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           added-files: ${{ steps.changed-files.outputs.files }}
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "[email protected]"
           git config --local user.name "stdlib-bot"

.github/workflows/standalone_publish.yml

@@ -91,6 +91,17 @@ jobs:
           lfs: false
         timeout-minutes: 10
 
+      # Configure Git:
+      - name: 'Configure Git'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "stdlib-bot"
+
+      # Apply Git notes:
+      - name: 'Apply Git notes'
+        run: |
+          make apply-git-notes
+
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA

.github/workflows/standalone_publish_custom.yml

@@ -98,6 +98,18 @@ jobs:
           lfs: false
         timeout-minutes: 10
 
+      # Configure Git:
+      - name: 'Configure Git'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "stdlib-bot"
+
+      # Apply Git notes:
+      - name: 'Apply Git notes'
+        run: |
+          make apply-git-notes
+        timeout-minutes: 5
+
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA

.github/workflows/standalone_push_changes.yml

@@ -66,6 +66,17 @@ jobs:
           lfs: false
         timeout-minutes: 10
 
+      # Configure Git:
+      - name: 'Configure Git'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "stdlib-bot"
+
+      # Apply Git notes:
+      - name: 'Apply Git notes'
+        run: |
+          make apply-git-notes
+
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA

CONTRIBUTORS

@@ -51,6 +51,7 @@ Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
 NightKnight <[email protected]>
 Nithin Katta <[email protected]>
+Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
 Philipp Burckhardt <[email protected]>

docs/git-notes/9df16105aa2d89808d3395c610334ca9cce35b3c renamed to docs/git-notes/9df16105aa2d89808d3395c610334ca9cce35b3c.txt

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable max-statements */
+
 'use strict';
 
 // MODULES //
@@ -26,7 +28,6 @@ var semver = require( 'semver' );
 var recommendVersionBump = require( '@stdlib/_tools/changelog/recommend-version-bump' );
 var name2standalone = require( '@stdlib/_tools/pkgs/name2standalone' );
 var substringAfter = require( '@stdlib/string/substring-after' );
-var objectEntries = require( '@stdlib/utils/entries' );
 var parseCommits = require( '@stdlib/_tools/changelog/parse-commits' );
 var objectKeys = require( '@stdlib/utils/keys' );
 var namespaces = require( '@stdlib/_tools/pkgs/namespaces' ).sync;
@@ -58,6 +59,7 @@ var STDLIB_REPO_NODE_PATH = 'https://github.com/stdlib-js/stdlib/tree/develop/li
 var RE_PACKAGE_SUBDIRS = /\/?(benchmark|bin|data|docs|etc|examples|include|lib|scripts|src|test)\/?[\s\S]*$/;
 var RE_MARKDOWN_HEADER = /(^#+)/gm;
 var RE_EXTRANEOUS_NEWLINES = /\n{3,}/g;
+var PLACEHOLDER_SUMMARY = 'No changes reported for this release.';
 
 
 // FUNCTIONS //
@@ -258,13 +260,16 @@ function generate( pkg, releaseType ) {
 		isNamespacePkg = true;
 		standalone = '@stdlib/stdlib';
 		pkg = '';
-		releases = objectEntries( npmReleases( standalone ) );
+		releases = npmReleases( standalone );
 	} else {
 		// Case: all other packages
 		isNamespacePkg = contains( STDLIB_NAMESPACE_PKGS, pkg );
 		standalone = name2standalone( pkg );
 		pkg = replace( pkg, '@stdlib/', '' );
-		releases = objectEntries( npmReleases( standalone ) );
+		releases = npmReleases( standalone );
+	}
+	if ( releases.length > 0 ) {
+		newestRelease = releases[ releases.length-1 ][ 0 ];
 	}
 
 	str = '# CHANGELOG\n\n';
@@ -288,10 +293,19 @@ function generate( pkg, releaseType ) {
 
 	if ( releaseType === 'auto' ) {
 		releaseType = recommendVersionBump( commits.unreleased );
+
+		// If no bump is recommended, default to 'patch' as we still want to trigger a release:
+		if ( releaseType === null ) {
+			releaseType = 'patch';
+		}
+
+		// Ensure major bump only happens if we are already on a major release line:
+		if ( releaseType === 'major' && semver.major( newestRelease ) < 1 ) {
+			releaseType = 'minor';
+		}
 	}
 	if ( releaseType && releaseType !== 'none' ) {
-		if ( releases.length > 0 ) {
-			newestRelease = releases[ releases.length-1 ][ 0 ];
+		if ( newestRelease ) {
 			nextVersion = semver.inc( newestRelease, releaseType );
 		} else {
 			nextVersion = semver.inc( '0.0.0', releaseType );
@@ -311,8 +325,8 @@ function generate( pkg, releaseType ) {
 		for ( i = 0; i < pkgNames.length; i++ ) {
 			name = pkgNames[ i ];
 			unreleased = releaseSummary( bySubpackage[ name ], true, true );
-			if ( unreleased ) {
-				str += packageSummaryWrapper( pkg, '', name, unreleased );
+			if ( unreleased || nextVersion ) {
+				str += packageSummaryWrapper( pkg, '', name, unreleased || PLACEHOLDER_SUMMARY );
 			}
 		}
 		str += sectionEnd( 'packages' );
@@ -323,10 +337,10 @@ function generate( pkg, releaseType ) {
 		str += sectionEnd( 'release' );
 	} else {
 		unreleased = releaseSummary( commits.unreleased );
-		if ( unreleased ) {
+		if ( unreleased || nextVersion ) {
 			str += releaseSectionStart( nextVersion );
 			str += '## ' + ( nextVersion || 'Unreleased' ) + ' (' + formatDate() + ')\n\n';
-			str += unreleased;
+			str += unreleased || PLACEHOLDER_SUMMARY;
 			str += sectionEnd( 'release' );
 		}
 	}
@@ -335,7 +349,7 @@ function generate( pkg, releaseType ) {
 			version = releases[ i ][ 0 ];
 			releaseCommits = commits[ version ];
 			if ( !releaseCommits ) {
-				continue;
+				releaseCommits = [];
 			}
 			str += '## ' + version + ' (' + formatDate( releases[ i ][ 1 ] ) + ')\n\n';
 			bySubpackage = groupBySubPackage( releaseCommits, pkg );
@@ -346,7 +360,7 @@ function generate( pkg, releaseType ) {
 				name = pkgNames[ j ];
 				summary = releaseSummary( bySubpackage[ name ], true, true );
 				if ( !summary ) {
-					continue;
+					summary = PLACEHOLDER_SUMMARY;
 				}
 				str += packageSummaryWrapper( pkg, version, name, summary );
 			}
@@ -361,7 +375,7 @@ function generate( pkg, releaseType ) {
 			version = releases[ i ][ 0 ];
 			summary = releaseSummary( commits[ version ] );
 			if ( !summary ) {
-				continue;
+				summary = PLACEHOLDER_SUMMARY;
 			}
 			str += releaseSectionStart( version );
 			str += '## ' + version + ' (' + formatDate( releases[ i ][ 1 ] ) + ')\n\n';
@@ -382,13 +396,19 @@ function generate( pkg, releaseType ) {
 	* @returns {string} release indicator
 	*/
 	function indicator( commit ) {
+		var prevReleaseDate;
+		var releaseDate;
 		var date;
 		var i;
 		date = new Date( commit.date );
 
 		// Walk the releases in reverse chronological order:
 		for ( i = releases.length-1; i >= 0; i-- ) {
-			if ( date <= new Date( releases[ i ][ 1 ] ) ) {
+			releaseDate = new Date( releases[ i ][ 1 ] );
+
+			// Get the previous release date or set it to a very early date if none exists:
+			prevReleaseDate = ( i > 0 ) ? new Date( releases[ i-1 ][ 1 ] ) : new Date( 0 );
+			if ( date <= releaseDate && date > prevReleaseDate ) {
 				return releases[ i ][ 0 ]; // version
 			}
 		}

lib/node_modules/@stdlib/_tools/changelog/generate/lib/main.js

@@ -21,6 +21,7 @@
 // MODULES //
 
 var shell = require( 'child_process' ).execSync; // eslint-disable-line node/no-sync
+var semver = require( 'semver' );
 var logger = require( 'debug' );
 var omit = require( '@stdlib/utils/omit' );
 var rootDir = require( '@stdlib/_tools/utils/root-dir' );
@@ -35,35 +36,43 @@ var OMITTED_KEYS = [ 'created', 'modified', 'unpublished' ];
 // MAIN //
 
 /**
-* Returns a list of published package versions and their release dates.
+* Returns a two-element array of published package versions and their release dates.
 *
 * @private
 * @param {string} pkg - package name
-* @returns {Object} object mapping versions to release dates
+* @returns {Array} two-element array of published package versions and their release dates
 *
 * @example
 * var releases = npmReleases( '@stdlib/utils-omit' );
-* // returns {...}
+* // returns [...]
 */
 function npmReleases( pkg ) {
+	var releases;
 	var command;
+	var version;
 	var opts;
-	var out;
+	var map;
 
 	command = 'npm view ' + pkg + ' time --json';
 	opts = {
 		'cwd': rootDir(),
 		'stdio': [ 'pipe', 'pipe', 'ignore' ] // stdin, stdout, stderr
 	};
 	try {
-		out = shell( command, opts ).toString();
-		out = JSON.parse( out );
+		map = shell( command, opts ).toString();
+		map = JSON.parse( map );
 	} catch ( err ) {
 		debug( 'Encountered an error when attempting to retrieve package release dates: %s', err.message );
 		return {};
 	}
-	out = omit( out, OMITTED_KEYS );
-	return out;
+	map = omit( map, OMITTED_KEYS );
+	releases = [];
+	for ( version in map ) {
+		if ( semver.valid( version ) && !semver.prerelease( version ) ) {
+			releases.push( [ version, map[ version ] ] );
+		}
+	}
+	return releases;
 }
 
 

lib/node_modules/@stdlib/_tools/changelog/generate/lib/npm_releases.js

@@ -108,7 +108,7 @@ function main( context ) {
 		match = RE_REQUIRE.exec( tag.description );
 		if ( match ) {
 			// The main export should be required last, so no `require` calls should follow:
-			if ( match.index !== tag.description.lastIndexOf( 'require' ) ) {
+			if ( match.index !== tag.description.lastIndexOf( 'require(' ) ) {
 				report( 'Example code of main export should require itself last, i.e. contain `require( \'@'+modulePath+'\' )` as the last `require` call', loc );
 			}
 		} else {

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-main-export/lib/main.js

@@ -71,13 +71,12 @@ var Linter = require( 'eslint' ).Linter;
 var rule = require( '@stdlib/_tools/eslint/rules/require-spaces' );
 
 var linter = new Linter();
-var result;
 
 var code = 'var betainc = require(\'@stdlib/math/base/special/betainc\');';
 
 linter.defineRule( 'require-spaces', rule );
 
-result = linter.verify( code, {
+var result = linter.verify( code, {
     'rules': {
         'require-spaces': 'error'
     }