Skip to content

Conversation

@ChunkyProgrammer
Copy link
Member

Add some missing jsdoc comments, add jsdoc eslint plugin

Pull Request Type

  • Other - code quality improvement

Description

This PR does the following:

  • adds some basic jsdoc rules for the jsdoc eslint plugin
  • fixes some errors from the eslint plugin
  • adds some missing jsdoc comments

Additional Info

The typescript eslint plugin is able to convert jsdoc comment annotations to typescript so it should make it easier to switch to typescript whenever we start migrating some of our code to typescript.

Desktop

  • OS: Linux Mint
  • OS Version: 22
  • FreeTube version: 0.22.0

@github-actions github-actions bot added PR: dependencies Pull requests that update a dependency file PR: waiting for review For PRs that are complete, tested, and ready for review labels Oct 31, 2024
@FreeTubeBot FreeTubeBot enabled auto-merge (squash) October 31, 2024 03:43
absidue
absidue previously approved these changes Oct 31, 2024
Copy link
Member

@PikachuEXE PikachuEXE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mainly for remove unnecessary semicolon

@FreeTubeBot FreeTubeBot merged commit a28bb3f into FreeTubeApp:development Nov 2, 2024
@github-actions github-actions bot removed the PR: waiting for review For PRs that are complete, tested, and ready for review label Nov 2, 2024
Comment on lines +725 to +726
/** @type {import('youtubei.js/dist/src/parser/classes/PlayerStoryboardSpec').StoryboardData[]} */
let source = result.storyboardSpec.boards
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ChunkyProgrammer
This blows up
image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, didnt mean to change this from storyboards to storyboardSpec

PikachuEXE added a commit to PikachuEXE/FreeTube that referenced this pull request Nov 4, 2024
* development: (153 commits)
  Migrate FtTimestampCatcher to the composition API (FreeTubeApp#6064)
  Translated using Weblate (Polish)
  Added functionality to export a single playlist (FreeTubeApp#5779)
  Fix video player displaying a vertical scrollbar when context menu outside player container (FreeTubeApp#6075)
  Fix use of deprecated Invidious route on the videos subscription tab (FreeTubeApp#6057)
  Apply active FreeTube theme to shaka-player menus (FreeTubeApp#5986)
  Bump sass from 1.80.4 to 1.80.6 (FreeTubeApp#6071)
  Bump mini-css-extract-plugin from 2.9.1 to 2.9.2 (FreeTubeApp#6068)
  Translated using Weblate (Vietnamese)
  Bump webpack from 5.95.0 to 5.96.1 (FreeTubeApp#6069)
  Translated using Weblate (Vietnamese)
  Bump sass-loader from 16.0.2 to 16.0.3 (FreeTubeApp#6070)
  Bump lefthook from 1.8.1 to 1.8.2 (FreeTubeApp#6067)
  Bump the eslint group with 2 updates (FreeTubeApp#6066)
  Bump youtubei.js from 11.0.0 to 11.0.1 (FreeTubeApp#6072)
  Migrate PasswordSettings and PasswordDialog to the composition API (FreeTubeApp#6036)
  Add some missing jsdoc comments, add jsdoc eslint plugin (FreeTubeApp#6048)
  Fix shortcut for macOS setting shortcut in video page (FreeTubeApp#6054)
  Use decodingInfo's powerEfficient property when picking streams (FreeTubeApp#6061)
  Translated using Weblate (Afrikaans)
  ...
@ChunkyProgrammer ChunkyProgrammer deleted the add-some-missing-jsdoc-comments branch November 4, 2024 19:34
Soham456 pushed a commit to Soham456/FreeTube that referenced this pull request Dec 5, 2024
…#6048)

* Add some missing jsdoc comments, add jsdoc eslint plugin

* remove left over addition

Co-authored-by: absidue <[email protected]>

* move jsdoc eslint rule configuration

* use dash for list instead

* Enable some additional rules

* Apply suggestions from code review

Co-authored-by: PikachuEXE <[email protected]>

---------

Co-authored-by: absidue <[email protected]>
Co-authored-by: PikachuEXE <[email protected]>
SuperAKWA pushed a commit to SuperAKWA/FreeTube that referenced this pull request Jan 24, 2025
…#6048)

* Add some missing jsdoc comments, add jsdoc eslint plugin

* remove left over addition

Co-authored-by: absidue <[email protected]>

* move jsdoc eslint rule configuration

* use dash for list instead

* Enable some additional rules

* Apply suggestions from code review

Co-authored-by: PikachuEXE <[email protected]>

---------

Co-authored-by: absidue <[email protected]>
Co-authored-by: PikachuEXE <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants