-
-
Notifications
You must be signed in to change notification settings - Fork 1k
feat: add ESLint rule disallowing string concatenation in error messages #9034
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c5686b1
build: add ESLint rule disallowing string concatenation in error mess…
Planeshifter 7fa9bda
docs: update example
kgryte d67c64f
docs: update example
kgryte 8641735
docs: update example
kgryte f94280c
test: move declaration
kgryte 6eeccc9
Apply suggestions from code review
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
120 changes: 120 additions & 0 deletions
120
lib/node_modules/@stdlib/_tools/eslint/rules/no-error-string-concat/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <!-- | ||
|
|
||
| @license Apache-2.0 | ||
|
|
||
| Copyright (c) 2025 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. | ||
|
|
||
| --> | ||
|
|
||
| # no-error-string-concat | ||
|
|
||
| > [ESLint rule][eslint-rules] disallowing string concatenation in error messages. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var rule = require( '@stdlib/_tools/eslint/rules/no-error-string-concat' ); | ||
| ``` | ||
|
|
||
| #### rule | ||
|
|
||
| [ESLint rule][eslint-rules] disallowing string concatenation in error messages. | ||
|
|
||
| **Bad**: | ||
|
|
||
| <!-- run-disable --> | ||
|
|
||
| <!-- eslint-disable stdlib/no-error-string-concat --> | ||
|
|
||
| ```javascript | ||
| throw new Error( 'invalid argument. Value: `' + value + '`.' ); | ||
| ``` | ||
|
|
||
| **Good**: | ||
|
|
||
| <!-- run-disable --> | ||
|
|
||
| ```javascript | ||
| var format = require( '@stdlib/string/format' ); | ||
|
|
||
| throw new Error( format( 'invalid argument. Value: `%s`.', value ) ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| ```javascript | ||
| var Linter = require( 'eslint' ).Linter; | ||
| var rule = require( '@stdlib/_tools/eslint/rules/no-error-string-concat' ); | ||
|
|
||
| var linter = new Linter(); | ||
| linter.defineRule( 'no-error-string-concat', rule ); | ||
|
|
||
| var code = 'throw new Error( \'invalid argument. Value: `\' + value + \'`.\' );'; | ||
| var result = linter.verify( code, { | ||
| 'rules': { | ||
| 'no-error-string-concat': 'error' | ||
| } | ||
| }); | ||
| /* returns | ||
| [ | ||
| { | ||
| 'ruleId': 'no-error-string-concat', | ||
| 'severity': 2, | ||
| 'message': 'Use `@stdlib/string/format` instead of string concatenation in error messages.', | ||
| 'line': 1, | ||
| 'column': 18, | ||
| 'nodeType': 'BinaryExpression', | ||
| 'endLine': 1, | ||
| 'endColumn': 61 | ||
| } | ||
| ] | ||
| */ | ||
| ``` | ||
|
|
||
| </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 --> |
51 changes: 51 additions & 0 deletions
51
lib/node_modules/@stdlib/_tools/eslint/rules/no-error-string-concat/examples/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2025 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 = 'throw new Error( \'invalid argument. Value: `\' + value + \'`.\' );'; | ||
|
|
||
| linter.defineRule( 'no-error-string-concat', rule ); | ||
|
|
||
| result = linter.verify( code, { | ||
| 'rules': { | ||
| 'no-error-string-concat': 'error' | ||
| } | ||
| }); | ||
| console.log( result ); | ||
| /* => | ||
| [ | ||
| { | ||
| 'ruleId': 'no-error-string-concat', | ||
| 'severity': 2, | ||
| 'message': 'Use `@stdlib/string/format` instead of string concatenation in error messages.', | ||
| 'line': 1, | ||
| 'column': 18, | ||
| 'nodeType': 'BinaryExpression', | ||
| 'endLine': 1, | ||
| 'endColumn': 61 | ||
| } | ||
| ] | ||
| */ | ||
39 changes: 39 additions & 0 deletions
39
lib/node_modules/@stdlib/_tools/eslint/rules/no-error-string-concat/lib/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2025 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 disallowing string concatenation in error messages. | ||
| * | ||
| * @module @stdlib/_tools/eslint/rules/no-error-string-concat | ||
| * | ||
| * @example | ||
| * var rule = require( '@stdlib/_tools/eslint/rules/no-error-string-concat' ); | ||
| * | ||
| * console.log( rule ); | ||
| */ | ||
|
|
||
| // MODULES // | ||
|
|
||
| var main = require( './main.js' ); | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| module.exports = main; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.