Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add _tools/eslint/rules/line-closing-bracket-spacing #4211

Merged
merged 3 commits into from
Dec 28, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 50 additions & 7 deletions etc/eslint/rules/stdlib.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ rules[ 'stdlib/capitalized-comments' ] = [ 'warn', {
'stdlib',
'throws'
]
} ];
}];

/**
* Enforce that return annotation values match actual output.
Expand Down Expand Up @@ -346,8 +346,7 @@ rules[ 'stdlib/jsdoc-checkbox-character-style' ] = [
{
'checked': 'x',
'unchecked': ' '
}
];
}];
headlessNode marked this conversation as resolved.
Show resolved Hide resolved

/**
* Prevent checkboxes being followed by too much whitespace.
Expand Down Expand Up @@ -502,8 +501,7 @@ rules[ 'stdlib/jsdoc-code-block-style' ] = [ 'error', 'fenced' ];
rules[ 'stdlib/jsdoc-fenced-code-flag' ] = [
'error', {
'allowEmpty': false
}
];
}];
headlessNode marked this conversation as resolved.
Show resolved Hide resolved

/**
* Require lowercased definition labels.
Expand Down Expand Up @@ -1649,8 +1647,7 @@ rules[ 'stdlib/jsdoc-list-item-spacing' ] = 'error';
rules[ 'stdlib/jsdoc-markdown-remark' ] = [ 'error',
{
'config': require( './../../remark/.remarkrc.jsdoc.js' )
}
];
}];
headlessNode marked this conversation as resolved.
Show resolved Hide resolved

/**
* Require angle-bracketed links to include a protocol.
Expand Down Expand Up @@ -3861,6 +3858,52 @@ rules[ 'stdlib/jsdoc-unordered-list-marker-style' ] = [ 'error', '-' ];
*/
rules[ 'stdlib/jsdoc-main-export' ] = 'error';

/**
* Disallow spaces between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.
*
* @name line-closing-bracket-spacing
* @memberof rules
* @type {string}
* @default 'error'
*
* @example
* // Bad...
* var log = require( '@stdlib/console/log' );
*
* log({
* 'foo': true
* } );
*
* log([
* 1,
* 2,
* 3
* ] );
*
* log([{
* 'bar': true
* } ] );
*
* @example
* // Good...
* var log = require( '@stdlib/console/log' );
*
* log({
* 'foo': true
* });
*
* log([
* 1,
* 2,
* 3
* ]);
*
* log([{
* 'bar': true
* }]);
*/
rules[ 'stdlib/line-closing-bracket-spacing' ] = 'error';

/**
* Enforce that export statements are placed at the end of a file.
*
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/_tools/eslint/rules/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -765,6 +765,15 @@ setReadOnly( rules, 'jsdoc-typedef-typos', require( '@stdlib/_tools/eslint/rules
*/
setReadOnly( rules, 'jsdoc-unordered-list-marker-style', require( '@stdlib/_tools/eslint/rules/jsdoc-unordered-list-marker-style' ) );

/**
* @name line-closing-bracket-spacing
* @memberof rules
* @readonly
* @type {Function}
* @see {@link module:@stdlib/_tools/eslint/rules/line-closing-bracket-spacing}
*/
setReadOnly( rules, 'line-closing-bracket-spacing', require( '@stdlib/_tools/eslint/rules/line-closing-bracket-spacing' ) );

/**
* @name module-exports-last
* @memberof rules
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!--

@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.

-->

# line-closing-bracket-spacing

> [ESLint rule][eslint-rules] to enforce that no spaces are present between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var rule = require( '@stdlib/_tools/eslint/rules/line-closing-bracket-spacing' );
```

#### rule

[ESLint rule][eslint-rules] to enforce that no spaces are present between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.

**Bad**:

<!-- eslint-disable stdlib/line-closing-bracket-spacing -->

```javascript
var log = require( '@stdlib/console/log' );

log({
'foo': true
} );

log([
1,
2,
3
] );

log([{
'bar': true
} ] );
```

**Good**:

```javascript
var log = require( '@stdlib/console/log' );

log({
'foo': true
});

log([
1,
2,
3
]);

log([{
'bar': true
}]);
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var Linter = require( 'eslint' ).Linter;
var rule = require( '@stdlib/_tools/eslint/rules/line-closing-bracket-spacing' );

var linter = new Linter();

var code = [
'function test() {',
' var log = require( \'@stdlib/console/log\' );',
' log({',
' "key": "value"',
' } );',
' var arr = [{',
' "nested": true',
' } ];',
' log( arr );',
'}'
].join( '\n' );

linter.defineRule( 'line-closing-bracket-spacing', rule );

var result = linter.verify( code, {
'rules': {
'line-closing-bracket-spacing': 'error'
}
});
/* returns
[
{
'ruleId': 'line-closing-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line',
'line': 3,
'column': 3,
'nodeType': 'CallExpression'
},
{
'ruleId': 'line-closing-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line',
'line': 6,
'column': 13,
'nodeType': 'ArrayExpression'
}
]
*/
```

</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">

[eslint-rules]: https://eslint.org/docs/developer-guide/working-with-rules

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/**
* @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';

var Linter = require( 'eslint' ).Linter;
var rule = require( './../lib' );

var linter = new Linter();

var code = [
'function test() {',
' var log = require( \'@stdlib/console/log\' );',
' log({',
' "key": "value"',
' } );',
' var arr = [{',
' "nested": true',
' } ];',
' log( arr );',
'}'
].join( '\n' );

linter.defineRule( 'line-closing-bracket-spacing', rule );

var result = linter.verify( code, {
'rules': {
'line-closing-bracket-spacing': 'error'
}
});
console.log( result );
/* =>
[
{
'ruleId': 'line-closing-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line',
'line': 3,
'column': 3,
'nodeType': 'CallExpression'
},
{
'ruleId': 'line-closing-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line',
'line': 6,
'column': 13,
'nodeType': 'ArrayExpression'
}
]
*/
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/**
* @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';

/**
* ESLint rule to enforce that no spaces are present between a closing parenthesis or bracket and a nested object or array expression at the beginning of a line.
*
* @module @stdlib/_tools/eslint/rules/line-closing-bracket-spacing
*
* @example
* var rule = require( '@stdlib/_tools/eslint/rules/line-closing-bracket-spacing' );
*
* console.log( rule );
*/

// MODULES //

var main = require( './main.js' );


// EXPORTS //

module.exports = main;
Loading
Loading