Repository Structure and Documentation - AdamIskandarAI/VueTube-Extractor GitHub Wiki
Repository Structure and Documentation
Under the path of src/extractors/
, there consists of two directories, youtube
and youtube-new
. Due to the current rewrite, the youtube
directory is deprecated with youtube-new
superseding it once completed.
Rewrite Plans
The rewrite will consist of two parts — the requester, and the parser. The parser will handle traversing a given JSON object following "rules" defined in separate files with the aim of identifying the most common patterns in the YouTube API and creating a set of rules that can be applied to each given pattern.
The requester, on the other hand, will handle all interactions with APIs. This includes Innertube, RYD, Sponsorblock, etc.
To run
Prerequisites
- NodeJS 16.x or greater
Setup
- via Yarn (recommended)
yarn
- via NPM
npm i
Testing & Building
VueTube Extractor uses Jest to test its code. To run tests, you may use the following command:
yarn test
You should also lint your code before building. To lint, you may use the following command:
yarn lint
Once all tests have passed, you may use the following command to build the library from TypeScript to JavaScript:
yarn build