generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f60c41a
commit eafbb67
Showing
1 changed file
with
98 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,98 @@ | ||
// CAMARA Project - support function for Spectral linter | ||
// 31.01.2024 - initial version | ||
|
||
const reservedWords = [ | ||
'abstract', | ||
'apiclient', | ||
'apiexception', | ||
'apiresponse', | ||
'assert', | ||
'boolean', | ||
'break', | ||
'byte', | ||
'case', | ||
'catch', | ||
'char', | ||
'class', | ||
'configuration', | ||
'const', | ||
'continue', | ||
'do', | ||
'double', | ||
'else', | ||
'extends', | ||
'file', | ||
'final', | ||
'finally', | ||
'float', | ||
'for', | ||
'goto', | ||
'if', | ||
'implements', | ||
'import', | ||
'instanceof', | ||
'int', | ||
'interface', | ||
'list', | ||
'localdate', | ||
'localreturntype', | ||
'localtime', | ||
'localvaraccept', | ||
'localvaraccepts', | ||
'localvarauthnames', | ||
'localvarcollectionqueryparams', | ||
'localvarcontenttype', | ||
'localvarcontenttypes', | ||
'localvarcookieparams', | ||
'localvarformparams', | ||
'localvarheaderparams', | ||
'localvarpath', | ||
'localvarpostbody', | ||
'localvarqueryparams', | ||
'long', | ||
'native', | ||
'new', | ||
'null', | ||
'object', | ||
'offsetdatetime', | ||
'package', | ||
'private', | ||
'protected', | ||
'public', | ||
'return', | ||
'short', | ||
'static', | ||
'strictfp', | ||
'stringutil', | ||
'super', | ||
'switch', | ||
'synchronized', | ||
'this', | ||
'throw', | ||
'throws', | ||
'transient', | ||
'try', | ||
'void', | ||
'volatile', | ||
'while' | ||
]; | ||
// Reserved word 'enum' and 'default' are removed from above reserved word array as they are common in openAPI keyword | ||
export default async function lintReservedWords(input) { | ||
// Iterate over properties of the input object | ||
for (const path in input) { | ||
if (typeof path === 'string') { | ||
|
||
for (const word of reservedWords) { | ||
const regex = new RegExp(`\\b${word}\\b`, 'g'); // Use a regular expression to match 'word' as a standalone word | ||
|
||
if (regex.test(path)) { | ||
const warningRuleName = 'camara-reserved-words'; | ||
const description = `Reserved words found in input: Consider avoiding the use of reserved word '${word}'`; | ||
// const location = `${path}`; | ||
|
||
console.log(`warning ${warningRuleName} ${description} ${path}`); | ||
} | ||
} | ||
} | ||
} | ||
} |