diff --git a/.eslintrc b/.eslintrc index c31ab5210..6f0585da2 100644 --- a/.eslintrc +++ b/.eslintrc @@ -135,6 +135,7 @@ "error", { "code": 240, + "comments": 120, "ignoreComments": false, "ignoreUrls": true } diff --git a/src/components/README.md b/src/components/README.md index e889f61ed..5682d3e82 100644 --- a/src/components/README.md +++ b/src/components/README.md @@ -512,7 +512,7 @@ Set application messages for banner display - messagesArray.<{id: string, message: string, title: string, variant: string}> | Object + messagesArray | Object @@ -2279,7 +2279,8 @@ Get daily and monthly totals from a data set. A metric totals helper. params.dataSetobject - params.isCurrentboolean

Is the current value the "current month". A proxy value passed through "graphCardMetricTotals"

+ params.isCurrentboolean

Is the current value the "current month". A proxy value passed through + "graphCardMetricTotals"

@@ -2324,7 +2325,8 @@ Get a remaining capacity from data sets. A metric totals helper. params.tallyDataArray - params.isCurrentboolean

Is the current value the "current month". A proxy value passed through "graphCardMetricTotals"

+ params.isCurrentboolean

Is the current value the "current month". A proxy value passed + through "graphCardMetricTotals"

@@ -2349,7 +2351,8 @@ Get a remaining overage from data sets. A metric totals helper. params.tallyDataArray - params.isCurrentboolean

Is the current value the "current month". A proxy value passed through "graphCardMetricTotals"

+ params.isCurrentboolean

Is the current value the "current month". A proxy value passed through + "graphCardMetricTotals"

@@ -2817,7 +2820,8 @@ See, https://react.i18next.com/ - componentsArray

An array of HTML/React nodes used to replace string tokens. i.e. "[, <React.Fragment />]"

+ componentsArray

An array of HTML/React nodes used to replace string tokens. + i.e. "[, <React.Fragment />]"

settingsobject diff --git a/src/components/bannerMessages/bannerMessagesContext.js b/src/components/bannerMessages/bannerMessagesContext.js index fc2d86a52..cabd9a5e0 100644 --- a/src/components/bannerMessages/bannerMessagesContext.js +++ b/src/components/bannerMessages/bannerMessagesContext.js @@ -86,7 +86,7 @@ const useSetBannerMessages = ({ * Set application messages for banner display * * @callback setBannerMessages - * @param {Array<{ id: string, message: string, title: string, variant: string }>|{ id: string, message: string, title: string, variant: string }} messages + * @param {Array|{ id: string, message: string, title: string, variant: string }} messages */ return useCallback( messages => { diff --git a/src/components/chart/chart.js b/src/components/chart/chart.js index b9475f9a8..fbdfc007b 100644 --- a/src/components/chart/chart.js +++ b/src/components/chart/chart.js @@ -172,10 +172,10 @@ const Chart = ({ /** * Prop types. * - * @type {{chartTooltip: React.ReactNode|Function, xValueFormat: Function, padding: {top: number, left: number, bottom: number, - * right: number}, xAxisTickFormat: Function, themeColor: string, chartLegend: React.ReactNode|Function, - * yAxisTickFormat: Function, dataSets: Array, xAxisFixLabelOverlap: boolean, xAxisLabelIncrement: number, - * yValueFormat: Function}} + * @type {{chartTooltip: React.ReactNode|Function, xValueFormat: Function, padding: {top: number, left: number, + * bottom: number, right: number}, xAxisTickFormat: Function, themeColor: string, chartLegend: + * React.ReactNode|Function, yAxisTickFormat: Function, dataSets: Array, xAxisFixLabelOverlap: boolean, + * xAxisLabelIncrement: number, yValueFormat: Function}} */ Chart.propTypes = { chartLegend: PropTypes.oneOfType([PropTypes.node, PropTypes.func]), @@ -227,10 +227,10 @@ Chart.propTypes = { /** * Default props. * - * @type {{chartTooltip: React.ReactNode|Function, xValueFormat: Function, padding: {top: number, left: number, bottom: number, - * right: number}, xAxisTickFormat: Function, themeColor: string, chartLegend: React.ReactNode|Function, - * yAxisTickFormat: Function, dataSets: Array, xAxisFixLabelOverlap: boolean, xAxisLabelIncrement: number, - * yValueFormat: Function}} + * @type {{chartTooltip: React.ReactNode|Function, xValueFormat: Function, padding: {top: number, left: number, + * bottom: number, right: number}, xAxisTickFormat: Function, themeColor: string, chartLegend: + * React.ReactNode|Function, yAxisTickFormat: Function, dataSets: Array, xAxisFixLabelOverlap: boolean, + * xAxisLabelIncrement: number, yValueFormat: Function}} */ Chart.defaultProps = { chartLegend: null, diff --git a/src/components/graphCard/graphCardChartLegend.js b/src/components/graphCard/graphCardChartLegend.js index d00ecb48c..13a3cf056 100644 --- a/src/components/graphCard/graphCardChartLegend.js +++ b/src/components/graphCard/graphCardChartLegend.js @@ -192,8 +192,8 @@ GraphCardChartLegend.propTypes = { /** * Default props. * - * @type {{datum: {dataSets: Array}, useProduct: Function, t: Function, useGraphCardContext: Function, useDispatch: Function, - * useSelectors: Function, chart: {hide: Function, toggle: Function, isToggled: Function}}} + * @type {{datum: {dataSets: Array}, useProduct: Function, t: Function, useGraphCardContext: Function, + * useDispatch: Function, useSelectors: Function, chart: {hide: Function, toggle: Function, isToggled: Function}}} */ GraphCardChartLegend.defaultProps = { chart: { diff --git a/src/components/graphCard/graphCardHelpers.js b/src/components/graphCard/graphCardHelpers.js index a529f4aa4..c5fee7881 100644 --- a/src/components/graphCard/graphCardHelpers.js +++ b/src/components/graphCard/graphCardHelpers.js @@ -364,7 +364,8 @@ const getMetricTotalCurrentOrLastData = helpers.memo( * * @param {object} params * @param {object} params.dataSet - * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed through "graphCardMetricTotals" + * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed through + * "graphCardMetricTotals" * @returns {{chartId: string, metricId: string, monthlyHasData: boolean, dailyValue: number, dailyDate: string, * monthlyValue: number, monthlyDate: string, dailyHasData: boolean}} */ @@ -416,7 +417,8 @@ const getPrepaidTallyCapacity = helpers.memo( * @param {object} params * @param {Array} params.capacityData * @param {Array} params.tallyData - * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed through "graphCardMetricTotals" + * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed + * through "graphCardMetricTotals" * @returns {{remainingCapacityHasData: boolean, remainingCapacity: number}} */ const getRemainingCapacity = helpers.memo( @@ -453,7 +455,8 @@ const getRemainingCapacity = helpers.memo( * @param {object} params * @param {Array} params.capacityData * @param {Array} params.tallyData - * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed through "graphCardMetricTotals" + * @param {boolean} params.isCurrent Is the current value the "current month". A proxy value passed through + * "graphCardMetricTotals" * @returns {{remainingOverage: number, remainingOverageHasData: boolean}} */ const getRemainingOverage = helpers.memo( diff --git a/src/components/i18n/i18nHelpers.js b/src/components/i18n/i18nHelpers.js index 269fba1ab..6db35aa9d 100644 --- a/src/components/i18n/i18nHelpers.js +++ b/src/components/i18n/i18nHelpers.js @@ -171,7 +171,8 @@ const setI18nTestElement = ({ defaultTestId, testId }) => { * - A default string if the key can't be found. * - An object with i18next settings. i.e. "{ context: Array|string, testId: boolean|string|React.ReactNode }" * - An array of objects (key/value) pairs used to replace string tokens. i.e. "[{ hello: 'world' }]" - * @param {Array} components An array of HTML/React nodes used to replace string tokens. i.e. "[, ]" + * @param {Array} components An array of HTML/React nodes used to replace string tokens. + * i.e. "[, ]" * @param {object} settings * @param {*} settings.i18next * @param {Function} settings.isDebug diff --git a/src/components/inventoryCard/inventoryCardHelpers.js b/src/components/inventoryCard/inventoryCardHelpers.js index d0324ae3d..9635dee7f 100644 --- a/src/components/inventoryCard/inventoryCardHelpers.js +++ b/src/components/inventoryCard/inventoryCardHelpers.js @@ -83,7 +83,8 @@ const normalizeInventorySettings = ({ filters = [], guestFilters = [], settings * @param {object} params.query * @param {object} params.session * @param {object} params.settings - * @returns {{dataSetColumnHeaders: Array, resultsPerPage: number, resultsOffset: number, dataSetRows: Array, resultsCount: number}} + * @returns {{dataSetColumnHeaders: Array, resultsPerPage: number, resultsOffset: number, dataSetRows: Array, + * resultsCount: number}} */ const parseInventoryResponse = ({ data = {}, diff --git a/src/components/messageView/messageView.js b/src/components/messageView/messageView.js index 21b82f310..5e9d1fb4a 100644 --- a/src/components/messageView/messageView.js +++ b/src/components/messageView/messageView.js @@ -47,7 +47,8 @@ const MessageView = ({ children, icon, message, pageTitle, title }) => ( /** * Prop types. * - * @type {{children: React.ReactNode, icon: React.ReactNode|Function, message: string, pageTitle: string, title: string}} + * @type {{children: React.ReactNode, icon: React.ReactNode|Function, message: string, pageTitle: string, + * title: string}} */ MessageView.propTypes = { children: PropTypes.node, diff --git a/src/components/optinView/optinView.js b/src/components/optinView/optinView.js index 659adab07..9a9f43ebd 100644 --- a/src/components/optinView/optinView.js +++ b/src/components/optinView/optinView.js @@ -202,7 +202,8 @@ const OptinView = ({ /** * Prop types. * - * @type {{useSession: Function, t: Function, updateAccountOptIn: Function, useDispatch: Function, useSelectorsResponse: Function}} + * @type {{useSession: Function, t: Function, updateAccountOptIn: Function, useDispatch: Function, + * useSelectorsResponse: Function}} */ OptinView.propTypes = { t: PropTypes.func, @@ -215,7 +216,8 @@ OptinView.propTypes = { /** * Default props. * - * @type {{useSession: Function, t: Function, updateAccountOptIn: Function, useDispatch: Function, useSelectorsResponse: Function}} + * @type {{useSession: Function, t: Function, updateAccountOptIn: Function, useDispatch: Function, + * useSelectorsResponse: Function}} */ OptinView.defaultProps = { t: translate, diff --git a/src/components/table/tableHelpers.js b/src/components/table/tableHelpers.js index a335aca2b..c670aba6a 100644 --- a/src/components/table/tableHelpers.js +++ b/src/components/table/tableHelpers.js @@ -144,7 +144,8 @@ const tableHeader = ({ * @param {Function} params.onExpand * @param {Function} params.onSelect * @param {Array} params.rows - * @returns {{isExpandableCell: boolean, isSelectTable: boolean, isExpandableRow: boolean, isAllSelected: boolean, rows: any[]}} + * @returns {{isExpandableCell: boolean, isSelectTable: boolean, isExpandableRow: boolean, isAllSelected: boolean, + * rows: any[]}} */ const tableRows = ({ onExpand, onSelect, rows = [] } = {}) => { const updatedRows = []; diff --git a/src/redux/README.md b/src/redux/README.md index 699533318..d2994f57d 100644 --- a/src/redux/README.md +++ b/src/redux/README.md @@ -187,7 +187,8 @@ Get a RHSM response from multiple Tally, or Capacity, IDs and metrics. - idMetricobject | Array

An object, or an Array of objects, in the form of { id: PRODUCT_ID, metric: METRIC_ID, isCapacity: boolean }

+ idMetricobject | Array

An object, or an Array of objects, in the form of { id: PRODUCT_ID, metric: METRIC_ID, + isCapacity: boolean }

queryobject diff --git a/src/redux/actions/rhsmActions.js b/src/redux/actions/rhsmActions.js index dfadb3c92..d50f3f03b 100644 --- a/src/redux/actions/rhsmActions.js +++ b/src/redux/actions/rhsmActions.js @@ -12,7 +12,8 @@ import { generateChartIds } from '../../components/graphCard/graphCardHelpers'; /** * Get a RHSM response from multiple Tally, or Capacity, IDs and metrics. * - * @param {object|Array} idMetric An object, or an Array of objects, in the form of { id: PRODUCT_ID, metric: METRIC_ID, isCapacity: boolean } + * @param {object|Array} idMetric An object, or an Array of objects, in the form of { id: PRODUCT_ID, metric: METRIC_ID, + * isCapacity: boolean } * @param {object} query * @param {object} options * @param {string} options.cancelId diff --git a/src/redux/types/rhsmTypes.js b/src/redux/types/rhsmTypes.js index 3caeac505..215160c24 100644 --- a/src/redux/types/rhsmTypes.js +++ b/src/redux/types/rhsmTypes.js @@ -13,8 +13,9 @@ const GET_SUBSCRIPTIONS_INVENTORY_RHSM = 'GET_SUBSCRIPTIONS_INVENTORY_RHSM'; /** * RHSM API action, reducer types. * - * @type {{GET_GRAPH_REPORT_CAPACITY_RHSM: string, GET_GRAPH_CAPACITY_RHSM: string, GET_INSTANCES_INVENTORY_GUESTS_RHSM: string, - * GET_SUBSCRIPTIONS_INVENTORY_RHSM: string, GET_INSTANCES_INVENTORY_RHSM: string, GET_GRAPH_TALLY_RHSM: string}} + * @type {{GET_GRAPH_REPORT_CAPACITY_RHSM: string, GET_GRAPH_CAPACITY_RHSM: string, GET_INSTANCES_INVENTORY_GUESTS_RHSM: + * string, GET_SUBSCRIPTIONS_INVENTORY_RHSM: string, GET_INSTANCES_INVENTORY_RHSM: string, GET_GRAPH_TALLY_RHSM: + * string}} */ const rhsmTypes = { GET_GRAPH_CAPACITY_RHSM, diff --git a/src/services/README.md b/src/services/README.md index daff1c331..a142a769c 100644 --- a/src/services/README.md +++ b/src/services/README.md @@ -892,10 +892,12 @@ Get RHSM API instances table/inventory guests data. options.cancelIdstring - options.schemaArray

An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA]

+ options.schemaArray

An array of callbacks used to transform the response, + ie. [SUCCESS SCHEMA, ERROR SCHEMA]

- options.transformArray

An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

+ options.transformArray

An array of callbacks used to transform the response, + ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

@@ -928,10 +930,12 @@ Get RHSM API instances data. options.cancelIdstring - options.schemaArray

An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA]

+ options.schemaArray

An array of callbacks used to transform the response, + ie. [SUCCESS SCHEMA, ERROR SCHEMA]

- options.transformArray

An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

+ options.transformArray

An array of callbacks used to transform the response, + ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

@@ -964,10 +968,12 @@ Get RHSM API subscriptions data. options.cancelIdstring - options.schemaArray

An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA]

+ options.schemaArray

An array of callbacks used to transform the response, + ie. [SUCCESS SCHEMA, ERROR SCHEMA]

- options.transformArray

An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

+ options.transformArray

An array of callbacks used to transform the response, + ie. [SUCCESS TRANSFORM, ERROR TRANSFORM]

diff --git a/src/services/rhsm/rhsmServices.js b/src/services/rhsm/rhsmServices.js index 022704bb1..9ee76cf8c 100644 --- a/src/services/rhsm/rhsmServices.js +++ b/src/services/rhsm/rhsmServices.js @@ -1194,8 +1194,10 @@ const getApiVersion = (options = {}) => { * @param {boolean} options.cache * @param {boolean} options.cancel * @param {string} options.cancelId - * @param {Array} options.schema An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA] - * @param {Array} options.transform An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] + * @param {Array} options.schema An array of callbacks used to transform the response, + * ie. [SUCCESS SCHEMA, ERROR SCHEMA] + * @param {Array} options.transform An array of callbacks used to transform the response, + * ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] * @returns {Promise<*>} */ const getGraphTally = (id, params = {}, options = {}) => { @@ -1225,7 +1227,8 @@ const getGraphTally = (id, params = {}, options = {}) => { }; /** - * @api {get} /api/rhsm-subscriptions/v1/capacity/products/:product_id/:metric_id Get RHSM graph capacity data, i.e. thresholds + * @api {get} /api/rhsm-subscriptions/v1/capacity/products/:product_id/:metric_id Get RHSM graph capacity data, + * i.e. thresholds * @apiDescription Retrieve graph capacity data, such as thresholds. * * Reference [RHSM for capacity params and commands](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) @@ -1510,7 +1513,8 @@ const getGraphCapacity = (id, params = {}, options = {}) => { /** * @apiMock {DelayResponse} 250 - * @api {get} /api/rhsm-subscriptions/v1/instances/:instance_id/guests Get RHSM instances/systems table/inventory guests data + * @api {get} /api/rhsm-subscriptions/v1/instances/:instance_id/guests Get RHSM instances/systems + * table/inventory guests data * @apiDescription Retrieve instances/systems table/inventory guests data. * * Reference [RHSM for instances guests](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) @@ -1624,8 +1628,10 @@ const getGraphCapacity = (id, params = {}, options = {}) => { * @param {boolean} options.cache * @param {boolean} options.cancel * @param {string} options.cancelId - * @param {Array} options.schema An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA] - * @param {Array} options.transform An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] + * @param {Array} options.schema An array of callbacks used to transform the response, + * ie. [SUCCESS SCHEMA, ERROR SCHEMA] + * @param {Array} options.transform An array of callbacks used to transform the response, + * ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] * @returns {Promise<*>} */ const getInstancesInventoryGuests = (id, params = {}, options = {}) => { @@ -1772,8 +1778,10 @@ const getInstancesInventoryGuests = (id, params = {}, options = {}) => { * @param {boolean} options.cache * @param {boolean} options.cancel * @param {string} options.cancelId - * @param {Array} options.schema An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA] - * @param {Array} options.transform An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] + * @param {Array} options.schema An array of callbacks used to transform the response, + * ie. [SUCCESS SCHEMA, ERROR SCHEMA] + * @param {Array} options.transform An array of callbacks used to transform the response, + * ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] * @returns {Promise<*>} */ const getInstancesInventory = (id, params = {}, options = {}) => { @@ -1891,8 +1899,10 @@ const getInstancesInventory = (id, params = {}, options = {}) => { * @param {boolean} options.cache * @param {boolean} options.cancel * @param {string} options.cancelId - * @param {Array} options.schema An array of callbacks used to transform the response, ie. [SUCCESS SCHEMA, ERROR SCHEMA] - * @param {Array} options.transform An array of callbacks used to transform the response, ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] + * @param {Array} options.schema An array of callbacks used to transform the response, + * ie. [SUCCESS SCHEMA, ERROR SCHEMA] + * @param {Array} options.transform An array of callbacks used to transform the response, + * ie. [SUCCESS TRANSFORM, ERROR TRANSFORM] * @returns {Promise<*>} */ const getSubscriptionsInventory = (id, params = {}, options = {}) => {