+
Creator
-
+
+
+
Tags
@@ -60,6 +99,11 @@ import { format, parseISO } from "date-fns";
import { Services } from "@/components/Workflow/services";
+import {
+ bestPracticeWarningAnnotation,
+ bestPracticeWarningCreator,
+ bestPracticeWarningLicense,
+} from "./modules/linting";
import { UntypedParameters } from "./modules/parameters";
import LicenseSelector from "@/components/License/LicenseSelector.vue";
@@ -67,6 +111,8 @@ import ActivityPanel from "@/components/Panels/ActivityPanel.vue";
import CreatorEditor from "@/components/SchemaOrg/CreatorEditor.vue";
import StatelessTags from "@/components/TagsMultiselect/StatelessTags.vue";
+const bestPracticeHighlightTime = 10000;
+
export default {
name: "WorkflowAttributes",
components: {
@@ -84,6 +130,10 @@ export default {
type: String,
default: null,
},
+ highlight: {
+ type: String,
+ default: null,
+ },
tags: {
type: Array,
required: true,
@@ -115,11 +165,17 @@ export default {
},
data() {
return {
+ bestPracticeWarningAnnotation: bestPracticeWarningAnnotation,
+ bestPracticeWarningCreator: bestPracticeWarningCreator,
+ bestPracticeWarningLicense: bestPracticeWarningLicense,
message: null,
messageVariant: null,
versionCurrent: this.version,
annotationCurrent: this.annotation,
nameCurrent: this.name,
+ showAnnotationHightlight: false,
+ showLicenseHightlight: false,
+ showCreatorHightlight: false,
};
},
computed: {
@@ -179,6 +235,36 @@ export default {
name() {
this.nameCurrent = this.name;
},
+ highlight: {
+ immediate: true,
+ handler(newHighlight, oldHighlight) {
+ if (newHighlight == oldHighlight) {
+ return;
+ }
+ if (newHighlight == "annotation") {
+ this.showAnnotationHightlight = true;
+ this.showCreatorHightlight = false;
+ this.showLicenseHightlight = false;
+ setTimeout(() => {
+ this.showAnnotationHightlight = false;
+ }, bestPracticeHighlightTime);
+ } else if (newHighlight == "creator") {
+ this.showAnnotationHightlight = false;
+ this.showCreatorHightlight = true;
+ this.showLicenseHightlight = false;
+ setTimeout(() => {
+ this.showCreatorHightlight = false;
+ }, bestPracticeHighlightTime);
+ } else if (newHighlight == "license") {
+ this.showAnnotationHightlight = false;
+ this.showCreatorHightlight = false;
+ this.showLicenseHightlight = true;
+ setTimeout(() => {
+ this.showLicenseHightlight = false;
+ }, bestPracticeHighlightTime);
+ }
+ },
+ },
},
created() {
this.services = new Services();
@@ -211,3 +297,14 @@ export default {
},
};
+
+
diff --git a/client/src/components/Workflow/Editor/modules/linting.ts b/client/src/components/Workflow/Editor/modules/linting.ts
index 21d02cafff88..75a7c142ab43 100644
--- a/client/src/components/Workflow/Editor/modules/linting.ts
+++ b/client/src/components/Workflow/Editor/modules/linting.ts
@@ -15,6 +15,13 @@ interface LintState {
autofix?: boolean;
}
+export const bestPracticeWarningAnnotation =
+ "This workflow is not annotated. Providing an annotation helps workflow executors understand the purpose and usage of the workflow.";
+export const bestPracticeWarningCreator =
+ "This workflow does not specify creator(s). This is important metadata for workflows that will be published and/or shared to help workflow executors know how to cite the workflow authors.";
+export const bestPracticeWarningLicense =
+ "This workflow does not specify a license. This is important metadata for workflows that will be published and/or shared to help workflow executors understand how it may be used.";
+
export function getDisconnectedInputs(
steps: Steps = {},
datatypesMapper: DatatypesMapperModel,