org.sonar.plugins.javascript.bridge.BridgeServer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-javascript-plugin Show documentation
Show all versions of sonar-javascript-plugin Show documentation
Code Analyzer for JavaScript/TypeScript/CSS
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.plugins.javascript.bridge;
import static org.sonarsource.api.sonarlint.SonarLintSide.INSTANCE;
import java.io.IOException;
import java.util.List;
import javax.annotation.Nullable;
import org.sonar.api.Startable;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.TextRange;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.api.scanner.ScannerSide;
import org.sonar.css.StylelintRule;
import org.sonarsource.api.sonarlint.SonarLintSide;
@ScannerSide
@SonarLintSide(lifespan = INSTANCE)
public interface BridgeServer extends Startable {
void startServerLazily(SensorContext context) throws IOException;
void initLinter(
List rules,
List environments,
List globals,
AnalysisMode analysisMode,
String baseDir,
List exclusions
) throws IOException;
AnalysisResponse analyzeJavaScript(JsAnalysisRequest request) throws IOException;
AnalysisResponse analyzeTypeScript(JsAnalysisRequest request) throws IOException;
AnalysisResponse analyzeCss(CssAnalysisRequest request) throws IOException;
AnalysisResponse analyzeYaml(JsAnalysisRequest request) throws IOException;
AnalysisResponse analyzeHtml(JsAnalysisRequest request) throws IOException;
void clean();
String getCommandInfo();
boolean isAlive();
boolean newTsConfig();
TsConfigFile loadTsConfig(String tsConfigAbsolutePath);
TsProgram createProgram(TsProgramRequest tsProgramRequest) throws IOException;
boolean deleteProgram(TsProgram tsProgram) throws IOException;
TsConfigFile createTsConfigFile(String content) throws IOException;
class JsAnalysisRequest {
final String filePath;
final String fileContent;
final String fileType;
final boolean ignoreHeaderComments;
final List tsConfigs;
final String programId;
final String linterId;
final String language;
JsAnalysisRequest(
String filePath,
String fileType,
String language,
@Nullable String fileContent,
boolean ignoreHeaderComments,
@Nullable List tsConfigs,
@Nullable String programId,
String linterId
) {
this.filePath = filePath;
this.fileType = fileType;
this.language = language;
this.fileContent = fileContent;
this.ignoreHeaderComments = ignoreHeaderComments;
this.tsConfigs = tsConfigs;
this.programId = programId;
this.linterId = linterId;
}
}
class CssAnalysisRequest {
final String filePath;
final String fileContent;
final List rules;
CssAnalysisRequest(String filePath, @Nullable String fileContent, List rules) {
this.filePath = filePath;
this.fileContent = fileContent;
this.rules = rules;
}
}
class AnalysisResponse {
ParsingError parsingError;
List issues = List.of();
Highlight[] highlights = {};
HighlightedSymbol[] highlightedSymbols = {};
Metrics metrics = new Metrics();
CpdToken[] cpdTokens = {};
Perf perf;
List ucfgPaths = List.of();
}
class ParsingError {
String message;
Integer line;
ParsingErrorCode code;
}
enum ParsingErrorCode {
PARSING,
FAILING_TYPESCRIPT,
GENERAL_ERROR,
}
class Issue {
Integer line;
Integer column;
Integer endLine;
Integer endColumn;
String message;
String ruleId;
List secondaryLocations;
Double cost;
List quickFixes;
}
class QuickFix {
String message;
List edits;
}
class QuickFixEdit {
String text;
IssueLocation loc;
}
class IssueLocation {
Integer line;
Integer column;
Integer endLine;
Integer endColumn;
String message;
}
class Highlight {
Location location;
String textType;
}
class HighlightedSymbol {
Location declaration;
Location[] references;
}
class Location {
int startLine;
int startCol;
int endLine;
int endCol;
public Location() {}
Location(int startLine, int startCol, int endLine, int endCol) {
this.startLine = startLine;
this.startCol = startCol;
this.endLine = endLine;
this.endCol = endCol;
}
public int getStartLine() {
return startLine;
}
public int getStartCol() {
return startCol;
}
public int getEndLine() {
return endLine;
}
public int getEndCol() {
return endCol;
}
public void setStartLine(int startLine) {
this.startLine = startLine;
}
public void setStartCol(int startCol) {
this.startCol = startCol;
}
public void setEndLine(int endLine) {
this.endLine = endLine;
}
public void setEndCol(int endCol) {
this.endCol = endCol;
}
TextRange toTextRange(InputFile inputFile) {
return inputFile.newRange(this.startLine, this.startCol, this.endLine, this.endCol);
}
@Override
public String toString() {
return String.format("%d:%d-%d:%d", startLine, startCol, endLine, endCol);
}
}
class Metrics {
int[] ncloc = {};
int[] commentLines = {};
int[] nosonarLines = {};
int[] executableLines = {};
int functions;
int statements;
int classes;
int complexity;
int cognitiveComplexity;
}
class CpdToken {
Location location;
String image;
public void setLocation(Location location) {
this.location = location;
}
public void setImage(String image) {
this.image = image;
}
public Location getLocation() {
return location;
}
public String getImage() {
return image;
}
}
class Perf {
int parseTime;
int analysisTime;
}
class TsConfigResponse {
final List files;
final List projectReferences;
final String error;
final ParsingErrorCode errorCode;
TsConfigResponse(
List files,
List projectReferences,
@Nullable String error,
@Nullable ParsingErrorCode errorCode
) {
this.files = files;
this.projectReferences = projectReferences;
this.error = error;
this.errorCode = errorCode;
}
}
class TsProgram {
final String programId;
final List files;
final List projectReferences;
final String error;
final boolean missingTsConfig;
TsProgram(
@Nullable String programId,
@Nullable List files,
@Nullable List projectReferences,
boolean missingTsConfig,
@Nullable String error
) {
this.programId = programId;
this.files = files;
this.projectReferences = projectReferences;
this.missingTsConfig = missingTsConfig;
this.error = error;
}
TsProgram(
String programId,
@Nullable List files,
@Nullable List projectReferences
) {
this(programId, files, projectReferences, false, null);
}
TsProgram(
String programId,
List files,
List projectReferences,
boolean missingTsConfig
) {
this(programId, files, projectReferences, missingTsConfig, null);
}
TsProgram(String error) {
this(null, null, null, false, error);
}
@Override
public String toString() {
if (error == null) {
return (
"TsProgram{" +
"programId='" +
programId +
'\'' +
", files=" +
files +
", projectReferences=" +
projectReferences +
'}'
);
} else {
return "TsProgram{ error='" + error + "'}";
}
}
}
class TsProgramRequest {
final String tsConfig;
public TsProgramRequest(String tsConfig) {
this.tsConfig = tsConfig;
}
}
}