build: disable various JSDoc rules for TS test files

Author: Planeshifter

etc/eslint/.eslintrc.typescript.tests.js

@@ -0,0 +1,84 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 //
+
+// FIXME: remove the next line and uncomment the subsequent line once all remark JSDoc ESLint rules are completed
+var copy = require( './../../lib/node_modules/@stdlib/utils/copy' );
+
+// var copy = require( './utils/copy.js' );
+var defaults = require( './.eslintrc.typescript.js' );
+
+
+// MAIN //
+
+/**
+* ESLint configuration.
+*
+* @namespace eslint
+*/
+var eslint = copy( defaults );
+
+/**
+* Disable the rule which requires explicit return types for functions and class methods.
+*
+* @private
+*/
+eslint.rules[ '@typescript-eslint/explicit-function-return-type' ] = 'off';
+
+/**
+* Disable the rule which disallows the use of variables before they are defined.
+*
+* @private
+*/
+eslint.rules[ '@typescript-eslint/no-use-before-define' ] = 'off';
+
+/**
+* Disable the rule which enforces consistent brace style for blocks.
+*
+* @private
+*/
+eslint.rules[ 'brace-style' ] = 'off';
+
+/**
+* Disable the rule which requires that throws statements are documented in JSDoc.
+*
+* @private
+*/
+eslint.rules[ 'jsdoc/require-throws' ] = 'off';
+
+/**
+* Disable the rule which requires that return statements are documented in JSDoc.
+*
+* @private
+*/
+eslint.rules[ 'jsdoc/require-returns' ] = 'off';
+
+/**
+* Disable the rule which requires that function parameters are documented in JSDoc.
+*
+* @private
+*/
+eslint.rules[ 'jsdoc/require-param' ] = 'off';
+
+
+// EXPORTS //
+
+module.exports = eslint;

etc/eslint/overrides/index.js

@@ -162,8 +162,12 @@ var overrides = [
 		}
 	},
 	{
-		'files': [ '*.d.ts', '*.ts', '*.tsx' ],
+		'files': [ '*.d.ts' ],
 		'extends': resolve( __dirname, '..', '.eslintrc.typescript.js' )
+	},
+	{
+		'files': [ '**/test/*.ts' ],
+		'extends': resolve( __dirname, '..', '.eslintrc.typescript.tests.js' )
 	}
 ];
 

tools/make/lib/lint/typescript/eslint.mk

@@ -32,6 +32,9 @@ ESLINT ?= $(BIN_DIR)/eslint
 # Define the path to the ESLint configuration file:
 ESLINT_TS_CONF ?= $(CONFIG_DIR)/eslint/.eslintrc.typescript.js
 
+# Define the path to the ESLint configuration file for tests:
+ESLINT_TS_CONF_TESTS ?= $(CONFIG_DIR)/eslint/.eslintrc.typescript.tests.js
+
 # Define the path to a TypeScript configuration file:
 TS_CONFIG ?= $(CONFIG_DIR)/typescript/tsconfig.json
 
@@ -121,7 +124,7 @@ ifeq ($(FAIL_FAST), true)
 		DIR=`dirname $$file`; \
 		LOCAL_TS_CONFIG=$$DIR/tsconfig.json; \
 		cp $(TS_CONFIG) $$DIR; \
-		$(ESLINT) $(ESLINT_TS_FLAGS) --config $(ESLINT_TS_CONF) --parser-options=project:$$LOCAL_TS_CONFIG $$file || exit 1; \
+		$(ESLINT) $(ESLINT_TS_FLAGS) --config $(ESLINT_TS_CONF_TESTS) --parser-options=project:$$LOCAL_TS_CONFIG $$file || exit 1; \
 		rm $$LOCAL_TS_CONFIG; \
 	done
 else
@@ -131,7 +134,7 @@ else
 		DIR=`dirname $$file`; \
 		LOCAL_TS_CONFIG=$$DIR/tsconfig.json; \
 		cp $(TS_CONFIG) $$DIR; \
-		$(ESLINT) $(ESLINT_TS_FLAGS) --config $(ESLINT_TS_CONF) --parser-options=project:$$LOCAL_TS_CONFIG $$file || echo 'Linting failed.'; \
+		$(ESLINT) $(ESLINT_TS_FLAGS) --config $(ESLINT_TS_CONF_TESTS) --parser-options=project:$$LOCAL_TS_CONFIG $$file || echo 'Linting failed.'; \
 		rm $$LOCAL_TS_CONFIG; \
 	done
 endif