Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix indentation and JSDoc comments that eslint is warning about #36177

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cms/static/cms/js/require-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -355,9 +355,9 @@
}
},
config: {
text: {
useXhr: () => true
}
text: {
useXhr: () => true
}
}
});
}).call(this, require, define);
214 changes: 86 additions & 128 deletions cms/static/js/models/xblock_info.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,180 +15,138 @@ define(
category: null,
data: null,
metadata: null,
/**
* The Studio URL for this xblock, or null if it doesn't have one.
*/
/** The Studio URL for this xblock, or null if it doesn't have one. */
studio_url: null,
/**
* An optional object with information about the children as well as about
* the primary xblock type that is supported as a child.
*/
* An optional object with information about the children as well as about
* the primary xblock type that is supported as a child.
*/
child_info: null,
/**
* An optional object with information about each of the ancestors.
*/
/** An optional object with information about each of the ancestors. */
ancestor_info: null,
/**
* Date of the last edit to this xblock or any of its descendants.
*/
/** Date of the last edit to this xblock or any of its descendants. */
edited_on: null,
/**
* User who last edited the xblock or any of its descendants. Will only be present if
* publishing info was explicitly requested.
*/
* User who last edited the xblock or any of its descendants. Will only be present if
* publishing info was explicitly requested.
*/
edited_by: null,
/**
* True iff a published version of the xblock exists.
*/
/** True iff a published version of the xblock exists. */
published: null,
/**
* Date of the last publish of this xblock, or null if never published.
*/
/** Date of the last publish of this xblock, or null if never published. */
published_on: null,
/**
* User who last published the xblock, or null if never published. Will only be present if
* publishing info was explicitly requested.
*/
* User who last published the xblock, or null if never published. Will only be present if
* publishing info was explicitly requested.
*/
published_by: null,
/**
* True if the xblock is a parentable xblock.
*/
/** True if the xblock is a parentable xblock. */
has_children: null,
/**
* True if the xblock has changes.
* Note: this is not always provided as a performance optimization. It is only provided for
* verticals functioning as units.
*/
* True if the xblock has changes.
* Note: this is not always provided as a performance optimization. It is only provided for
* verticals functioning as units.
*/
has_changes: null,
/**
* Represents the possible publish states for an xblock. See the documentation
* for XBlockVisibility to see a comprehensive enumeration of the states.
*/
* Represents the possible publish states for an xblock. See the documentation
* for XBlockVisibility to see a comprehensive enumeration of the states.
*/
visibility_state: null,
/**
* True if the release date of the xblock is in the past.
*/
* True if the release date of the xblock is in the past.
*/
released_to_students: null,
/**
* If the xblock is published, the date on which it will be released to students.
* This can be null if the release date is unscheduled.
*/
* If the xblock is published, the date on which it will be released to students.
* This can be null if the release date is unscheduled.
*/
release_date: null,
/**
* The xblock which is determining the release date. For instance, for a unit,
* this will either be the parent subsection or the grandparent section.
* This can be null if the release date is unscheduled. Will only be present if
* publishing info was explicitly requested.
*/
* The xblock which is determining the release date. For instance, for a unit,
* this will either be the parent subsection or the grandparent section.
* This can be null if the release date is unscheduled. Will only be present if
* publishing info was explicitly requested.
*/
release_date_from: null,
/**
* True if this xblock is currently visible to students. This is computed server-side
* so that the logic isn't duplicated on the client. Will only be present if
* publishing info was explicitly requested.
*/
* True if this xblock is currently visible to students. This is computed server-side
* so that the logic isn't duplicated on the client. Will only be present if
* publishing info was explicitly requested.
*/
currently_visible_to_students: null,
/**
* If xblock is graded, the date after which student assessment will be evaluated.
* It has same format as release date, for example: 'Jan 02, 2015 at 00:00 UTC'.
*/
* If xblock is graded, the date after which student assessment will be evaluated.
* It has same format as release date, for example: 'Jan 02, 2015 at 00:00 UTC'.
*/
due_date: null,
/**
* Grading policy for xblock.
*/
/** Grading policy for xblock. */
format: null,
/**
* List of course graders names.
*/
/** List of course graders names. */
course_graders: null,
/**
* True if this xblock contributes to the final course grade.
*/
/** True if this xblock contributes to the final course grade. */
graded: null,
/**
* The same as `release_date` but as an ISO-formatted date string.
*/
/** The same as `release_date` but as an ISO-formatted date string. */
start: null,
/**
* The same as `due_date` but as an ISO-formatted date string.
*/
/** The same as `due_date` but as an ISO-formatted date string. */
due: null,
/**
* True iff this xblock is explicitly staff locked.
*/
/** True iff this xblock is explicitly staff locked. */
has_explicit_staff_lock: null,
/**
* True iff this any of this xblock's ancestors are staff locked.
*/
/** True iff this any of this xblock's ancestors are staff locked. */
ancestor_has_staff_lock: null,
/**
* The xblock which is determining the staff lock value. For instance, for a unit,
* this will either be the parent subsection or the grandparent section.
* This can be null if the xblock has no inherited staff lock. Will only be present if
* publishing info was explicitly requested.
*/
* The xblock which is determining the staff lock value. For instance, for a unit,
* this will either be the parent subsection or the grandparent section.
* This can be null if the xblock has no inherited staff lock. Will only be present if
* publishing info was explicitly requested.
*/
staff_lock_from: null,
/**
* True iff this xblock should display a "Contains staff only content" message.
*/
/** True iff this xblock should display a "Contains staff only content" message. */
staff_only_message: null,
/**
* True iff this xblock is a unit, and it has children that are only visible to certain
* user partition groups. Note that this is not a recursive property. Will only be present if
* publishing info was explicitly requested.
*/
* True iff this xblock is a unit, and it has children that are only visible to certain
* user partition groups. Note that this is not a recursive property. Will only be present if
* publishing info was explicitly requested.
*/
has_partition_group_components: null,
/**
* actions defines the state of delete, drag and child add functionality for a xblock.
* currently, each xblock has default value of 'True' for keys: deletable, draggable and childAddable.
*/
* actions defines the state of delete, drag and child add functionality for a xblock.
* currently, each xblock has default value of 'True' for keys: deletable, draggable and childAddable.
*/
actions: null,
/**
* Header visible to UI.
*/
/** Header visible to UI. */
is_header_visible: null,
/**
* Optional explanatory message about the xblock.
*/
/** Optional explanatory message about the xblock. */
explanatory_message: null,
/**
* The XBlock's group access rules. This is a dictionary keyed to user partition IDs,
* where the values are lists of group IDs.
*/
* The XBlock's group access rules. This is a dictionary keyed to user partition IDs,
* where the values are lists of group IDs.
*/
group_access: null,
/**
* User partition dictionary. This is pre-processed by Studio, so it contains
* some additional fields that are not stored in the course descriptor
* (for example, which groups are selected for this particular XBlock).
*/
* User partition dictionary. This is pre-processed by Studio, so it contains
* some additional fields that are not stored in the course descriptor
* (for example, which groups are selected for this particular XBlock).
*/
user_partitions: null,
/**
* This xBlock's Highlights to message to learners.
*/
/** This xBlock's Highlights to message to learners. */
highlights: [],
highlights_enabled: false,
highlights_enabled_for_messaging: false,
highlights_preview_only: true,
highlights_doc_url: '',
/**
* True if summary configuration is enabled.
*/
/** True if summary configuration is enabled. */
summary_configuration_enabled: null,
/**
* List of tags of the unit. This list is managed by the content_tagging module.
*/
tags: null,
/**
* True if the xblock is not visible to students only via links.
*/
hide_from_toc: null,
/**
* True iff this xblock should display a "Contains staff only content" message.
*/
hide_from_toc_message: null,
/** List of tags of the unit. This list is managed by the content_tagging module. */
tags: null,
/** True if the xblock is not visible to students only via links. */
hide_from_toc: null,
/** True iff this xblock should display a "Contains staff only content" message. */
hide_from_toc_message: null,
},

initialize: function() {
// Extend our Model by helper methods.
// Extend our Model by helper methods.
_.extend(this, this.getCategoryHelpers());
},

Expand Down Expand Up @@ -245,9 +203,9 @@ define(
},

/**
* Return true if action is required e.g. delete, drag, add new child etc or if given key is not present.
* @return {boolean}
*/
* Return true if action is required e.g. delete, drag, add new child etc or if given key is not present.
* @return {boolean}
*/
isActionRequired: function(actionName) {
var actions = this.get('actions');
if (actions !== null) {
Expand All @@ -259,9 +217,9 @@ define(
},

/**
* Return a list of convenience methods to check affiliation to the category.
* @return {Array}
*/
* Return a list of convenience methods to check affiliation to the category.
* @return {Array}
*/
getCategoryHelpers: function() {
var categories = ['course', 'chapter', 'sequential', 'vertical'],
helpers = {};
Expand All @@ -276,9 +234,9 @@ define(
},

/**
* Check if we can edit current XBlock or not on Course Outline page.
* @return {Boolean}
*/
* Check if we can edit current XBlock or not on Course Outline page.
* @return {Boolean}
*/
isEditableOnCourseOutline: function() {
return this.isSequential() || this.isChapter() || this.isVertical();
}
Expand Down
1 change: 0 additions & 1 deletion cms/static/js/spec/views/pages/container_subviews_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,6 @@ describe('Container Subviews', function() {
});
});


describe('Message Area', function() {
var messageSelector = '.container-message .warning',
warningMessage = 'Caution: The last published version of this unit is live. '
Expand Down
2 changes: 1 addition & 1 deletion cms/static/js/spec/views/pages/course_outline_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -2540,7 +2540,7 @@ describe('CourseOutlinePage', function() {
hide_from_toc: null
}
});
})
});
});

verifyTypePublishable('unit', function(options) {
Expand Down
53 changes: 27 additions & 26 deletions cms/static/js/utils/copy_to_clipboard.js
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
define(["jquery"], function ($) {
"use strict";
function copyToClipboard(id, textToCopy) {
if (navigator.clipboard) {
navigator.clipboard.writeText(textToCopy);
changeButtonText(id);
return;
define(['jquery'], function($) {
'use strict';

function copyToClipboard(id, textToCopy) {
if (navigator.clipboard) {
navigator.clipboard.writeText(textToCopy);
changeButtonText(id);
return;
}
const textArea = document.createElement('textarea');
textArea.value = textToCopy;
document.body.appendChild(textArea);
textArea.select();
document.execCommand('copy');
document.body.removeChild(textArea);
changeButtonText(id);
}
const textArea = document.createElement("textarea");
textArea.value = textToCopy;
document.body.appendChild(textArea);
textArea.select();
document.execCommand("copy");
document.body.removeChild(textArea);
changeButtonText(id);
}

function changeButtonText(id, delay = 2000) {
const buttonId = `#${id}`;
const textClass = ".copy-link-button-text";
function changeButtonText(id, delay = 2000) {
const buttonId = `#${id}`;
const textClass = '.copy-link-button-text';

const previewShareLinkText = $(buttonId).find(textClass).html();
const shareLinkCopiedText = gettext("Copied");
$(buttonId).find(textClass).text(shareLinkCopiedText);
const previewShareLinkText = $(buttonId).find(textClass).html();
const shareLinkCopiedText = gettext('Copied');
$(buttonId).find(textClass).text(shareLinkCopiedText);

setTimeout(() => {
$(buttonId).find(textClass).text(previewShareLinkText);
}, delay);
}
return { copyToClipboard };
setTimeout(() => {
$(buttonId).find(textClass).text(previewShareLinkText);
}, delay);
}
return {copyToClipboard};
});
Loading
Loading