Skip to content

chore: fix JavaScript lint errors #13259

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.

Sign up for GitHub

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

Merged
kgryte merged 7 commits into from
Aug 7, 2026
+15 −6
Merged

chore: fix JavaScript lint errors #13259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a5fd04
chore: fix JavaScript lint errors (issue #13252)
ujjwalv01 Jul 4, 2026
d254ed2
chore(fs/read-dir): apply isError() in place of instanceof Error
ujjwalv01 Aug 6, 2026
c106f42
chore(fs/read-dir): disable ESLint rules for anti-pattern code block …
ujjwalv01 Aug 6, 2026
5e0a6aa
chore(fs/read-dir): fix markdown lint errors in Notes section
ujjwalv01 Aug 6, 2026
649daa6
chore(fs/read-dir): fix markdown lint errors - indent eslint-disable …
ujjwalv01 Aug 6, 2026
54ef47b
Merge branch 'develop' into fix-js-lint-13252
kgryte Aug 6, 2026
07a6f6d
style: add empty line
kgryte Aug 6, 2026
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
16 changes: 12 additions & 4 deletions lib/node_modules/@stdlib/fs/read-dir/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,10 @@ function onRead( error, data ) {
Synchronously reads the contents of a directory.

```javascript
var isError = require( '@stdlib/assert/is-error' );
Comment thread
kgryte marked this conversation as resolved.

var out = readDir.sync( __dirname );
if ( out instanceof Error ) {
if ( isError( out ) ) {
throw out;
}
console.log( out );
Expand All @@ -70,6 +72,8 @@ console.log( out );

- The difference between this module and [`fs.readdirSync()`][fs] is that [`fs.readdirSync()`][fs] will throw if an `error` is encountered (e.g., if given a non-existent `path`) and this module will return an `error`. Hence, the following anti-pattern

<!-- eslint-disable no-restricted-syntax, n/no-sync -->

```javascript
var fs = require( 'fs' );

Expand All @@ -81,16 +85,19 @@ console.log( out );
}
```

<!-- eslint-enable no-restricted-syntax, n/no-sync -->

can be replaced by an approach which addresses existence via `error` handling.

```javascript
var isError = require( '@stdlib/assert/is-error' );
var readDir = require( '@stdlib/fs/read-dir' );

var dir = '/path/to/dir';

// Explicitly handle the error...
dir = readDir.sync( dir );
if ( dir instanceof Error ) {
if ( isError( dir ) ) {
// You choose what to do...
throw dir;
}
Expand All @@ -107,20 +114,21 @@ console.log( out );
<!-- eslint no-undef: "error" -->

```javascript
var isError = require( '@stdlib/assert/is-error' );
var readDir = require( '@stdlib/fs/read-dir' );

/* Sync */

var out = readDir.sync( __dirname );
// returns <Array>

console.log( out instanceof Error );
console.log( isError( out ) );
// => false

out = readDir.sync( 'beepboop' );
// returns <Error>

console.log( out instanceof Error );
console.log( isError( out ) );
// => true

/* Async */
Expand Down
5 changes: 3 additions & 2 deletions lib/node_modules/@stdlib/fs/read-dir/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,21 @@

'use strict';

var isError = require( '@stdlib/assert/is-error' );
var readDir = require( './../lib' );

/* Sync */

var out = readDir.sync( __dirname );
// returns <Array>

console.log( out instanceof Error );
console.log( isError( out ) );
// => false

out = readDir.sync( 'beepboop' );
// returns <Error>

console.log( out instanceof Error );
console.log( isError( out ) );
// => true

/* Async */
Expand Down
Loading