From d0f774312fb1b54159257515d9f9dca4c9c20443 Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Tue, 30 May 2023 09:11:43 +0200 Subject: [PATCH] Fix new lint errors & warnings --- .eslintrc | 5 +++++ .../src/app/media/local/useContextValueProvider.js | 2 +- .../story-editor/src/app/media/media3p/api/apiFetcher.js | 4 ++-- .../src/app/media/media3p/useContextValueProvider.js | 2 +- packages/story-editor/src/app/media/useMedia.js | 4 ++-- packages/story-editor/src/app/media/utils/useFFmpeg.ts | 1 - 6 files changed, 11 insertions(+), 7 deletions(-) diff --git a/.eslintrc b/.eslintrc index 70e7e5322c17..3f08c05c3ecd 100644 --- a/.eslintrc +++ b/.eslintrc @@ -238,6 +238,11 @@ }], "jsdoc/require-returns": "error", "jsdoc/require-param-description": "error", + "jsdoc/tag-lines": [ + "error", + "any", + { "startLines": 1 } + ], "jsdoc/valid-types": "error", "eslint-comments/no-unused-disable": "error", "eslint-comments/require-description": "error", diff --git a/packages/story-editor/src/app/media/local/useContextValueProvider.js b/packages/story-editor/src/app/media/local/useContextValueProvider.js index 90bf2eb57e77..d79db7534e42 100644 --- a/packages/story-editor/src/app/media/local/useContextValueProvider.js +++ b/packages/story-editor/src/app/media/local/useContextValueProvider.js @@ -42,7 +42,7 @@ import { LOCAL_MEDIA_TYPE_ALL } from './types'; /** * Context fragment provider for local media. - * This is called from {@link MediaProvider} to provide the media global state. + * This is called from MediaProvider to provide the media global state. * * @param {LocalMediaReducerState} reducerState The 'local' fragment of the * state returned from `useMediaReducer` diff --git a/packages/story-editor/src/app/media/media3p/api/apiFetcher.js b/packages/story-editor/src/app/media/media3p/api/apiFetcher.js index 9f7603fdfe6c..e7752793ff35 100644 --- a/packages/story-editor/src/app/media/media3p/api/apiFetcher.js +++ b/packages/story-editor/src/app/media/media3p/api/apiFetcher.js @@ -29,7 +29,7 @@ export const Paths = { }; /** - * The supported order_by values for {@link listMedia}. + * The supported order_by values for listMedia. * * @enum {string} */ @@ -39,7 +39,7 @@ const ListMediaOrderBy = { }; /** - * The supported order_by values for {@link listCategories}. + * The supported order_by values for listCategories. * * @enum {string} */ diff --git a/packages/story-editor/src/app/media/media3p/useContextValueProvider.js b/packages/story-editor/src/app/media/media3p/useContextValueProvider.js index 4d3881aaf1f5..05514be70701 100644 --- a/packages/story-editor/src/app/media/media3p/useContextValueProvider.js +++ b/packages/story-editor/src/app/media/media3p/useContextValueProvider.js @@ -42,7 +42,7 @@ function useProviderSetContextValueProvider(reducerState, reducerActions) { /** * Context fragment provider for 3rd party media (Unsplash, Coverr, etc). - * This is called from {@link MediaProvider} to provide the media global state. + * This is called from MediaProvider to provide the media global state. * * @param {Media3pReducerState} reducerState The 'media3p' * fragment of the state returned from `useMediaReducer` diff --git a/packages/story-editor/src/app/media/useMedia.js b/packages/story-editor/src/app/media/useMedia.js index b05fd63531ec..1dc30775dd76 100644 --- a/packages/story-editor/src/app/media/useMedia.js +++ b/packages/story-editor/src/app/media/useMedia.js @@ -29,8 +29,8 @@ import Context from './context'; */ /** - * Context value consumer to select a fragment of the enire media context value - * (local and media3p) that's provided from {@link MediaProvider}. + * Context value consumer to select a fragment of the entire media context value + * (local and media3p) that's provided from MediaProvider. * * @param {function(MediaContext):Object?} selector Returns a fragment of the * media context value that the caller is interested in. If no selector is diff --git a/packages/story-editor/src/app/media/utils/useFFmpeg.ts b/packages/story-editor/src/app/media/utils/useFFmpeg.ts index 6ac8e195faf8..d717f93ae3a1 100644 --- a/packages/story-editor/src/app/media/utils/useFFmpeg.ts +++ b/packages/story-editor/src/app/media/utils/useFFmpeg.ts @@ -143,7 +143,6 @@ function useFFmpeg() { /** * Whether the video optimization feature is enabled. * - * * @type {boolean} Whether the feature flag is enabled. */ const isCrossOriginIsolationEnabled = Boolean(window?.crossOriginIsolated);