Skip to content

fix javascript lint errors(#10211) #10269

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

Closed
InFiNiTy0639 wants to merge 1 commit into from
Closed

fix javascript lint errors(#10211) #10269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 44 additions & 42 deletions lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-image/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@

// MODULES //

var parseJSDoc = require( 'doctrine' ).parse;
var remark = require( 'remark' );
var remarkLint = require( 'remark-lint' );
var remarkPlugin = require( 'remark-lint-no-shortcut-reference-image' );
var isObject = require( '@stdlib/assert/is-object' );
var findJSDoc = require( '@stdlib/_tools/eslint/utils/find-jsdoc' );
var parseJSDoc = require('doctrine').parse;
var remark = require('remark');
var remarkLint = require('remark-lint');
var remarkPlugin = require('remark-lint-no-shortcut-reference-image');
var isObject = require('@stdlib/assert/is-object');
var findJSDoc = require('@stdlib/_tools/eslint/utils/find-jsdoc');


// VARIABLES //
Expand All @@ -39,24 +39,44 @@ var rule;

// FUNCTIONS //

/**
* Copies AST node location info.
*
* @private
* @param {Object} loc - AST node location
* @returns {Object} copied location info
*/
function copyLocationInfo(loc) {
return {
'start': {
'line': loc.start.line,
'column': loc.start.column
},
'end': {
'line': loc.end.line,
'column': loc.end.column
}
};
}

/**
* Rule to prevent shortcut Markdown reference images from being used in JSDoc descriptions.
*
* @param {Object} context - ESLint context
* @returns {Object} validators
*/
function main( context ) {
function main(context) {
var source;
var config;
var lint;

config = {
'plugins': [
remarkLint,
[ remarkPlugin, 'error' ]
[remarkPlugin, 'error']
]
};
lint = remark().use( config ).processSync; // eslint-disable-line node/no-sync
lint = remark().use(config).processSync; // eslint-disable-line node/no-sync
source = context.getSourceCode();

return {
Expand All @@ -72,18 +92,18 @@ function main( context ) {
* @private
* @param {ASTNode} node - AST node
*/
function validate( node ) {
function validate(node) {
var jsdoc;
var vfile;
var ast;

jsdoc = findJSDoc( source, node );
if ( isObject( jsdoc ) ) {
ast = parseJSDoc( jsdoc.value, DOPTS );
if ( ast.description ) {
vfile = lint( ast.description );
if ( vfile.messages.length ) {
reportErrors( vfile.messages, jsdoc.loc );
jsdoc = findJSDoc(source, node);
if (isObject(jsdoc)) {
ast = parseJSDoc(jsdoc.value, DOPTS);
if (ast.description) {
vfile = lint(ast.description);
if (vfile.messages.length) {
reportErrors(vfile.messages, jsdoc.loc);
}
}
}
Expand All @@ -96,41 +116,23 @@ function main( context ) {
* @param {ObjectArray} errors - Markdown lint errors
* @param {Object} location - JSDoc location information
*/
function reportErrors( errors, location ) {
function reportErrors(errors, location) {
var err;
var msg;
var loc;
var i;

for ( i = 0; i < errors.length; i++ ) {
err = errors[ i ];
for (i = 0; i < errors.length; i++) {
err = errors[i];
msg = err.message;
loc = copyLocationInfo( location );
loc = copyLocationInfo(location);
loc.start.line = err.location.start.line + 1; // Note: we assume `/**` is on its own line
loc.start.column = err.location.start.column + 1; // Note: we assume that 1 space separates `*` from JSDoc description content (e.g., `* ## Beep`)
report( msg, loc );
report(msg, loc);
}
}

/**
* Copies AST node location info.
*
* @private
* @param {Object} loc - AST node location
* @returns {Object} copied location info
*/
function copyLocationInfo( loc ) {
return {
'start': {
'line': loc.start.line,
'column': loc.start.column
},
'end': {
'line': loc.end.line,
'column': loc.end.column
}
};
}


/**
* Reports an error message.
Expand All @@ -139,7 +141,7 @@ function main( context ) {
* @param {string} msg - error message
* @param {Object} loc - error location info
*/
function report( msg, loc ) {
function report(msg, loc) {
context.report({
'node': null,
'message': msg,
Expand Down
5 changes: 3 additions & 2 deletions lib/node_modules/@stdlib/datasets/cdc-nchs-us-infant-mortality-bw-1915-2013/scripts/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve;
var readFile = require( '@stdlib/fs/read-file' ).sync;
var writeFile = require( '@stdlib/fs/write-file' ).sync;
var RE_EOL = require( '@stdlib/regexp/eol' ).REGEXP;
var format = require( '@stdlib/string/format' );


// VARIABLES //
Expand Down Expand Up @@ -66,7 +67,7 @@ function main() {
for ( i = 0; i < data.length; i++ ) {
d = data[ i ].split( ',' );
if ( d.length !== fields.length ) {
throw new Error( 'unexpected error. Number of row values ('+d.length+') does not match the expected number of fields ('+fields.length+').' );
throw new Error( format( 'unexpected error. Number of row values (%u) does not match the expected number of fields (%u).', d.length, fields.length ) );
}
for ( j = 1; j < d.length; j++ ) {
d[ j ] = parseFloat( d[ j ] );
Expand All @@ -86,7 +87,7 @@ function main() {
} else if ( d[ 0 ] === 'white' ) {
json.white.push( d[ 2 ] );
} else {
throw new Error( 'unexpected error. Unrecognized race: `'+d[2]+'`.' );
throw new Error( format( 'unexpected error. Unrecognized race: `%s`.', d[ 2 ] ) );
}
}
if ( json.black.length !== json.white.length ) {
Expand Down