Skip to content

The Unified and Autonomous Development Platform

Fix issue #248 - Render ESLint report and collect statistics

Robin Shen1ee94b42f33d
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java b/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
index 70739ee220..8b7c564cff 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
@@ -167,9 +167,8 @@ public class Job implements Serializable, Validatable {
return suggestions;
}
- @Editable(order=120, name="Commands", description="Specify content of Linux shell script or Windows command batch to execute in above image. "
- + "It will be executed under <a href='$docRoot/pages/concepts.md#job-workspace' target='_blank'>job workspace</a>, which may contain files of your repository and "
- + "dependency artifacts based on your configuration below")
+ @Editable(order=120, name="Commands", description="Specify content of Linux shell script or Windows command batch to execute "
+ + "in above image under the repository root")
@Interpolative
@Code(language = Code.SHELL, variableProvider="getVariables")
@Size(min=1, message="may not be empty")
@@ -214,8 +213,7 @@ public class Job implements Serializable, Validatable {
this.triggers = triggers;
}
- @Editable(order=9000, group="Source Retrieval", description="Whether or not to retrieve files under the repository "
- + "into <a href='$docRoot/pages/concepts.md#job-workspace' target='_blank'>job workspace</a>")
+ @Editable(order=9000, group="Source Retrieval", description="Whether or not to retrieve repository files")
public boolean isRetrieveSource() {
return retrieveSource;
}
@@ -285,8 +283,8 @@ public class Job implements Serializable, Validatable {
this.services = services;
}
- @Editable(order=9115, group="Artifacts & Reports", description="Optionally specify files to publish as job artifacts. "
- + "Artifact files are relative to <a href='$docRoot/pages/concepts.md#job-workspace' target='_blank'>job workspace</a>, and may use * or ? for pattern match")
+ @Editable(order=9115, group="Artifacts & Reports", description="Optionally specify files to publish as job artifacts relative to "
+ + "repository root. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NameOfEmptyValue("No artifacts")
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/JobDependency.java b/server-core/src/main/java/io/onedev/server/buildspec/job/JobDependency.java
index cca02f8967..99a03dec5d 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/JobDependency.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/JobDependency.java
@@ -69,7 +69,7 @@ public class JobDependency implements Serializable {
}
@Editable(order=300, name="Artifacts to Retrieve", description="Optionally specify artifacts to retrieve "
- + "from the dependency into <a href='$docRoot/pages/concepts.md#job-workspace' target='_blank'>job workspace</a>. Leave empty to do not retrieve any artifacts")
+ + "from the dependency into repository root. Leave empty to do not retrieve any artifacts")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NameOfEmptyValue("Do not retrieve")
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/JobReport.java b/server-core/src/main/java/io/onedev/server/buildspec/job/JobReport.java
index 0166b2a3bc..d8e4b6fc78 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/JobReport.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/JobReport.java
@@ -37,7 +37,7 @@ public abstract class JobReport implements Serializable {
this.reportName = reportName;
}
- @Editable(order=100, description="Specify files relative to OneDev workspace. Use * or ? for pattern match")
+ @Editable(order=100, description="Specify files relative to repository root. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NotEmpty
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/ProjectDependency.java b/server-core/src/main/java/io/onedev/server/buildspec/job/ProjectDependency.java
index 1f1023bdf8..4cc4dc0713 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/ProjectDependency.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/ProjectDependency.java
@@ -100,7 +100,7 @@ public class ProjectDependency implements Serializable {
return new ArrayList<>();
}
- @Editable(order=400, name="Artifacts to Retrieve", description="Specify artifacts to retrieve into <a href='$docRoot/pages/concepts.md#job-workspace' target='_blank'>job workspace</a>")
+ @Editable(order=400, name="Artifacts to Retrieve", description="Specify artifacts to retrieve into repository root")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(suggester="suggestArtifacts", path=true)
@NotEmpty
diff --git a/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/CheckstylePluginModule.java b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/CheckstylePluginModule.java
index e07a9e7551..8d9564e9e1 100644
--- a/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/CheckstylePluginModule.java
+++ b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/CheckstylePluginModule.java
@@ -58,7 +58,7 @@ public class CheckstylePluginModule extends AbstractPluginModule {
@Override
public Collection<Class<?>> getImplementations() {
- return Sets.newHashSet(JobCheckstyleReport.class);
+ return Sets.newHashSet(JobESLintReport.class, JobCheckstyleReport.class);
}
});
diff --git a/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobCheckstyleReport.java b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobCheckstyleReport.java
index 213cf2c31e..3c7f8837c8 100644
--- a/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobCheckstyleReport.java
+++ b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobCheckstyleReport.java
@@ -39,8 +39,8 @@ public class JobCheckstyleReport extends JobReport {
public static final String VIOLATION_FILES = "violation-files";
- @Editable(order=100, description="Specify checkstyle result xml file. This should be a "
- + "relative path under OneDev workspace. For instance, <tt>target/checkstyle-result.xml</tt>. "
+ @Editable(order=100, description="Specify checkstyle result xml file relative to repository root, "
+ + "for instance, <tt>target/checkstyle-result.xml</tt>. "
+ "Refer to <a href='https://checkstyle.org/'>checkstyle documentation</a> "
+ "on how to generate the result xml file. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
diff --git a/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobESLintReport.java b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobESLintReport.java
new file mode 100644
index 0000000000..da379372db
--- /dev/null
+++ b/server-plugin/server-plugin-report-checkstyle/src/main/java/org/server/plugin/report/checkstyle/JobESLintReport.java
@@ -0,0 +1,30 @@
+package org.server.plugin.report.checkstyle;
+
+import org.hibernate.validator.constraints.NotEmpty;
+
+import io.onedev.server.web.editable.annotation.Editable;
+import io.onedev.server.web.editable.annotation.Interpolative;
+import io.onedev.server.web.editable.annotation.Patterns;
+
+@Editable(name="ESLint Report")
+public class JobESLintReport extends JobCheckstyleReport {
+
+ private static final long serialVersionUID = 1L;
+
+ @Editable(order=100, description="Specify ESLint report file in checkstyle format relative to repository root. "
+ + "This file can be generated with ESLint option <tt>'-f checkstyle'</tt> and <tt>'-o'</tt>. "
+ + "Use * or ? for pattern match")
+ @Interpolative(variableSuggester="suggestVariables")
+ @Patterns(path=true)
+ @NotEmpty
+ @Override
+ public String getFilePatterns() {
+ return super.getFilePatterns();
+ }
+
+ @Override
+ public void setFilePatterns(String filePatterns) {
+ super.setFilePatterns(filePatterns);
+ }
+
+}
diff --git a/server-plugin/server-plugin-report-clover/src/main/java/org/server/plugin/report/clover/JobCloverReport.java b/server-plugin/server-plugin-report-clover/src/main/java/org/server/plugin/report/clover/JobCloverReport.java
index f4b92e2b34..360ec25d38 100644
--- a/server-plugin/server-plugin-report-clover/src/main/java/org/server/plugin/report/clover/JobCloverReport.java
+++ b/server-plugin/server-plugin-report-clover/src/main/java/org/server/plugin/report/clover/JobCloverReport.java
@@ -41,8 +41,8 @@ public class JobCloverReport extends JobReport {
public static final String TEST_COUNTS_DIR = "test-count";
- @Editable(order=100, description="Specify clover xml file containing coverage data. This should be a "
- + "relative path under OneDev workspace. For instance, <tt>target/site/clover/clover.xml</tt>. "
+ @Editable(order=100, description="Specify clover xml report file relative to repository root, "
+ + "for instance, <tt>target/site/clover/clover.xml</tt>. "
+ "Refer to <a href='https://openclover.org/documentation'>OpenClover documentation</a> "
+ "on how to generate clover xml file. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
diff --git a/server-plugin/server-plugin-report-jest/src/main/java/io/onedev/server/plugin/report/jest/JobJestReport.java b/server-plugin/server-plugin-report-jest/src/main/java/io/onedev/server/plugin/report/jest/JobJestReport.java
index 6dba083053..514942f33f 100644
--- a/server-plugin/server-plugin-report-jest/src/main/java/io/onedev/server/plugin/report/jest/JobJestReport.java
+++ b/server-plugin/server-plugin-report-jest/src/main/java/io/onedev/server/plugin/report/jest/JobJestReport.java
@@ -33,8 +33,8 @@ public class JobJestReport extends JobReport {
public static final String DIR = "jest-reports";
- @Editable(order=100, description="Specify json file containing Jest test results relative to OneDev workspace. "
- + "It can be generated via Jest option <tt>--json</tt> and <tt>--outputFile</tt>. Use * or ? for pattern match")
+ @Editable(order=100, description="Specify Jest test result file in json format relative to repository root. "
+ + "This file can be generated via Jest option <tt>'--json'</tt> and <tt>'--outputFile'</tt>. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NotEmpty