- getEndColumnIndex() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData
-
Returns the column number where the highlighted portion of code ends
- getEndLine() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData
-
Returns the line number where the highlighted portion of code ends
- getFileSuffixes() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.languages.ShellLanguage
-
Returns the file suffixes (.sh and .ksh by default) that identify Shell scripts
- getHighlightingData() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellHighlighting
-
Returns the list of highlighting data found for the Shell script
- getLineCountData() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.measures.LineCountParser
-
Returns the LineCountData describing the passed Shell script
- getProperties() - Static method in class com.github.sbaudoin.sonar.plugins.shellcheck.settings.ShellCheckSettings
-
- getRuleKey(String) - Static method in class com.github.sbaudoin.sonar.plugins.shellcheck.checks.CheckRepository
-
Returns the RuleKey of the rule identified by its Id as a string
- getRuleKey(SensorContext, String) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor
-
Returns the RuleKey identified as the passed ruleId or null if no corresponding active
rule has been found
- getRuleKeys() - Static method in class com.github.sbaudoin.sonar.plugins.shellcheck.checks.CheckRepository
-
Returns the keys of all rules supported by this plugin
- getShellCheckPath(SensorContext) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor
-
Returns the plugin configuration parameter (settings) that defines the path to the command shellcheck
- getStartColumnIndex() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData
-
Returns the column number where the highlighted portion of code starts
- getStartLine() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData
-
Returns the line number where the highlighted portion of code starts
- getToken() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexer
-
- getToken() - Method in interface com.github.sbaudoin.sonar.plugins.shellcheck.lexer.ShellLexer
-
- getTypeOfText() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData
-
Returns the type of text
- goToState(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Goes to the given state and stores the previous state on the stack of states.
- incOpenParenthesisCount() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Increments the open parenthesis counter
- isBash4() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the lexer is applying the Bash 4 syntax to analyze the code
- isEmpty() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.HeredocLexingState
-
Tells if the state stack is empty or not
- isEmptyConditionalCommand() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if an empty conditional command ([ ]) was met or not
- isEvaluatingMarker(String) - Static method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.HeredocSharedImpl
-
Tells if the passed string is an evaluating marker.
- isInCaseBody() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the lexer is currently in a case statement
- isInHereStringContent() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the lexer is currently analyzing a in-here string
- isInState(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the current lexical state is the passed state (possibly nesting/parent stated)
- isParamExpansionHash() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the lexer is currently considering a parameter expansion based on # (e.g.
- isParamExpansionOther() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the current token is a parameter expansion marker other than # (e.g.
- isParamExpansionWord() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Tells if the current lexer token is a parameter expansion word
- isSameAs(ShellLocation) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellLocation
-
Tells if the passed ShellLocation has the same offset or not (this is a kind of shallow version of the
equals method)
- S_ARITH - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_ARITH_ARRAY_MODE - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_ARITH_SQUARE_MODE - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_ARRAY - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_ASSIGNMENT_LIST - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_BACKQUOTE - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_CASE - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_CASE_PATTERN - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_DOLLAR_PREFIXED - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_PARAM_EXPANSION - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_PARAM_EXPANSION_DELIMITER - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_PARAM_EXPANSION_PATTERN - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_PARAM_EXPANSION_REPLACEMENT - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_SUBSHELL - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_TEST - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- S_TEST_COMMAND - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- saveIssue(SensorContext, InputFile, int, String, String) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor
-
Saves the found issues in SonarQube
- saveIssues(InputFile, String, SensorContext) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor
-
Saves in SonarQube all the issues found in the passed JSON output.
- scan() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexer
-
- scan() - Method in interface com.github.sbaudoin.sonar.plugins.shellcheck.lexer.ShellLexer
-
Returns all non-overlapping found tokens for each recognized token in the stream set by the constructor.
- setEmptyConditionalCommand(boolean) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Sets the flag that tracks empty conditional commands
- setInCaseBody(boolean) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Sets the flag that tells if the lexer is in a case statement
- setParamExpansionHash(boolean) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Sets the flag that tracks parameter expansion based on #
- setParamExpansionOther(boolean) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Sets the flag that tracks parameter expansion marker other than #
- setParamExpansionWord(boolean) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Sets the flag that tracks parameter expansion words
- SHELLCHECK_PATH_DEFAULT_VALUE - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.settings.ShellCheckSettings
-
- SHELLCHECK_PATH_KEY - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.settings.ShellCheckSettings
-
- ShellCheckPlugin - Class in com.github.sbaudoin.sonar.plugins.shellcheck
-
- ShellCheckPlugin() - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.ShellCheckPlugin
-
- ShellCheckRulesDefinition - Class in com.github.sbaudoin.sonar.plugins.shellcheck.rules
-
- ShellCheckRulesDefinition() - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckRulesDefinition
-
- ShellCheckSensor - Class in com.github.sbaudoin.sonar.plugins.shellcheck.rules
-
SonarQube sensor class responsible for analyzing Shell scripts with ShellCheck
- ShellCheckSensor(FileSystem, FileLinesContextFactory) - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor
-
Constructor
- ShellCheckSensor.UnexpectedCommandOutputException - Exception in com.github.sbaudoin.sonar.plugins.shellcheck.rules
-
Class thrown when the executed command does not return the expected output
- ShellCheckSettings - Class in com.github.sbaudoin.sonar.plugins.shellcheck.settings
-
- ShellHighlighting - Class in com.github.sbaudoin.sonar.plugins.shellcheck.highlighting
-
Class in charge of Shell code highlighting in SonarQube
- ShellHighlighting(String) - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellHighlighting
-
Constructor
- ShellLanguage - Class in com.github.sbaudoin.sonar.plugins.shellcheck.languages
-
Describes the Shell language and tells when it applies
- ShellLanguage(Configuration) - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.languages.ShellLanguage
-
Constructor
- ShellLexer - Interface in com.github.sbaudoin.sonar.plugins.shellcheck.lexer
-
Shell lexers should implement this interface.
- ShellLocation - Class in com.github.sbaudoin.sonar.plugins.shellcheck.highlighting
-
Wrapper class used to locate tokens in Shell scripts and help highlight them
- ShellLocation(String, Token) - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellLocation
-
Constructor
- ShellLocation(String, int, int, int) - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellLocation
-
Constructor
- ShellQualityProfile - Class in com.github.sbaudoin.sonar.plugins.shellcheck.languages
-
Default, built-in quality profile for the projects having Shell scripts
- ShellQualityProfile() - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.languages.ShellQualityProfile
-
- shift(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.ShellLocation
-
Returns a ShellLocation that corresponds to this instance + line, column and offset parameters moved
forward of the passed number of characters
- start - Variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.Token
-
The offset (in characters) at which the token was identified in the source Shell code
- startMarkerTextOffset(String, boolean) - Static method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.HeredocSharedImpl
-
Returns the start offset of the passed marker text
- StringLexingstate - Class in com.github.sbaudoin.sonar.plugins.shellcheck.lexer
-
Class to store information about the current parsing of strings.
- StringLexingstate() - Constructor for class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.StringLexingstate
-
- stringParsingState() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the StringLexingState object used by the lexer to deal with strings
- yybegin(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Enters a new lexical state.
- yybegin(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Enters a new lexical state
- yychar() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the char number from beginning of input stream.
- yychar() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- yycharat(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the character at position pos from the
matched text.
- yycharat(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Returns the character at position pos from the
matched text.
- yyclose() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Closes the input stream
- yycolumn() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the column number from beginning of the line (starting from 0).
- yycolumn() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- YYEOF - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
This character denotes the end of file
- YYINITIAL - Static variable in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
lexical states
- yylength() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the length of the matched text region.
- yylength() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Returns the length of the matched text region.
- yylex() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
This is called to return the next Token from the input
Reader
- yylex() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Resumes scanning until the next regular expression is matched,
the end of input is encountered or an I/O-Error occurs.
- yyline() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the start line number from beginning of input stream (starting from 0).
- yyline() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
- yypushback(int) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Pushes the specified amount of characters back into the input stream.
- yyreset(Reader) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
This will be called to reset the the lexer.
- yyreset(Reader) - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Resets the scanner to read from a new input stream.
- yystate() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the current lexical state
- yystate() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Returns the current lexical state.
- yytext() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
-
Returns the text matched by the current regular expression.
- yytext() - Method in class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase
-
Returns the text matched by the current regular expression.