Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
46 changes: 46 additions & 0 deletions etc/eslint/rules/stdlib.js
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,52 @@ rules[ 'stdlib/doctest-quote-props' ] = 'error';
*/
rules[ 'stdlib/empty-line-before-comment' ] = 'error';

/**
* No spaces allowed between an opening parenthesis or bracket and a nested object or array expression.
*
* @name eol-open-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/eol-open-bracket-spacing' ] = 'error';

/**
* Require blockquotes to have `2` character indentation.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
<!--
@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.
-->

# eol-open-bracket-spacing

> [ESLint rule][eslint-rules] to enforce that no spaces are present between an opening parenthesis or bracket and a nested object or array expression.
<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

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

#### rule

[ESLint rule][eslint-rules] to enforce that no spaces are present between an opening parenthesis or bracket and a nested object or array expression.

**Bad**:

<!-- eslint-disable stdlib/eol-open-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/eol-open-bracket-spacing' );

var linter = new Linter();
var result;
var code;

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

linter.defineRule( 'eol-open-bracket-spacing', rule );

result = linter.verify( code, {
'rules': {
'eol-open-bracket-spacing': 'error'
}
});
/* returns
[
{
'ruleId': 'eol-open-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between an opening parenthesis or bracket and a nested object or array expression',
'line': 3,
'column': 3,
'nodeType': 'CallExpression'
},
{
'ruleId': 'eol-open-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between an opening parenthesis or bracket and a nested object or array expression',
'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,68 @@
/**
* @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 result;
var code;

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

linter.defineRule( 'eol-open-bracket-spacing', rule );

result = linter.verify( code, {
'rules': {
'eol-open-bracket-spacing': 'error'
}
});
console.log( result );
/* =>
[
{
'ruleId': 'eol-open-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between an opening parenthesis or bracket and a nested object or array expression',
'line': 3,
'column': 3,
'nodeType': 'CallExpression'
},
{
'ruleId': 'eol-open-bracket-spacing',
'severity': 2,
'message': 'No spaces allowed between an opening parenthesis or bracket and a nested object or array expression',
'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 an opening parenthesis or bracket and a nested object or array expression.
*
* @module @stdlib/_tools/eslint/rules/eol-open-bracket-spacing
*
* @example
* var rule = require( '@stdlib/_tools/eslint/rules/eol-open-bracket-spacing' );
*
* console.log( rule );
*/

// MODULES //

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


// EXPORTS //

module.exports = main;
Loading
Loading