Add rule to enforce spacing between interfaces

Author: Planeshifter

lib/node_modules/@stdlib/_tools/repl-txt/rules/interface-spacing/lib/index.js

@@ -0,0 +1,39 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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';
+
+/**
+* Lint rule to enforce a specified number of empty lines between interfaces.
+*
+* @module @stdlib/_tools/repl-txt/rules/interface-spacing
+*
+* @example
+* var rule = require( '@stdlib/_tools/repl-txt/rules/interface-spacing' );
+*
+* console.log( rule );
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

lib/node_modules/@stdlib/_tools/repl-txt/rules/interface-spacing/lib/main.js

@@ -0,0 +1,69 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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';
+
+// VARIABLES //
+
+var DEFAULT_SPACING = 2;
+
+
+// MAIN //
+
+/**
+* Rule for enforcing a specified number of empty lines between interfaces.
+*
+* @param {Context} context - lint context
+* @returns {Object} validators
+*/
+function main( context ) {
+	var spacing = context.options[ 0 ] || DEFAULT_SPACING;
+
+	/**
+	* Checks whether sections appear in the designated order.
+	*
+	* @private
+	* @param {Array} interfaces - function documentation sections
+	*/
+	function interfaceSpacing( interfaces ) {
+		var emptyLines;
+		var elem;
+		var end;
+		var i;
+
+		end = interfaces[ 0 ].end;
+		if ( interfaces.length > 1 ) {
+			for ( i = 1; i < interfaces.length; i++ ) {
+				elem = interfaces[ i ];
+				emptyLines = elem.start - end - 1;
+				if ( emptyLines !== spacing ) {
+					context.report( 'Interface documentation sections must be separated by `' + spacing + '` empty lines. Encountered: `'+ emptyLines+'`.', interfaces[ i ] );
+				}
+				end = elem.end;
+			}
+		}
+	}
+	return {
+		'interfaces': interfaceSpacing
+	};
+}
+
+
+// EXPORTS //
+
+module.exports = main;

lib/node_modules/@stdlib/_tools/repl-txt/rules/interface-spacing/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@stdlib/_tools/repl-txt/rules/interface-spacing",
+  "version": "0.0.0",
+  "description": "Lint rule to enforce a specified number of empty lines between interfaces.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "bin": {},
+  "main": "./lib",
+  "directories": {
+    "lib": "./lib"
+  },
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "tools",
+    "tool",
+    "repl.txt",
+    "repl",
+    "lint",
+    "custom",
+    "rules",
+    "rule",
+    "plugin",
+    "interface",
+    "spacing"
+  ]
+}