feat: cli (#6)

Author: yinyanfr

package-lock.json

@@ -2,7 +2,8 @@
   "name": "bili-pc-mp4",
   "version": "0.0.1",
   "description": "MP4 convertor for videos downloaded by the Bilibili pc application.",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "bin": "dist/cli/index.js",
   "scripts": {
     "lint": "eslint --ext .ts,.tsx ./src",
     "build": "npm run lint && tsc",
@@ -40,8 +41,10 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
+    "@types/args": "^5.0.0",
+    "args": "^5.0.3",
     "eloquent-ffmpeg": "^0.14.0",
     "ora": "^5.4.1",
     "sanitize-filename": "^1.6.3"
   }
-}
+}

package.json

@@ -0,0 +1,42 @@
+import { listVideos, processFolder } from '../core';
+
+interface CliOptions {
+  input: string;
+  output?: string;
+  pageNumber?: boolean;
+  silence?: boolean;
+  bufferSize?: string;
+}
+
+type CliCommand = (
+  name?: string,
+  subs?: string[],
+  options?: Partial<CliOptions>,
+) => Promise<void>;
+
+export const listCommand: CliCommand = async (_, subs = [], options = {}) => {
+  const folderPath = subs[0] ?? options.input;
+
+  if (!folderPath) {
+    throw new Error('Please specify the video folder path.');
+  }
+  await listVideos(folderPath);
+};
+
+export const convertCommand: CliCommand = async (
+  _,
+  subs = [],
+  options = {},
+) => {
+  const folderPath = subs[0] ?? options.input;
+  if (!folderPath) {
+    throw new Error('Please specify the video folder path.');
+  }
+  const { output, pageNumber, silence, bufferSize } = options;
+  await processFolder(folderPath, {
+    output,
+    pageNumber,
+    silence,
+    bufferSize: bufferSize ? parseInt(bufferSize) : undefined,
+  });
+};

src/cli/commands.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import args from 'args';
+import { convertCommand, listCommand } from './commands';
+
+args
+  .option(
+    'input',
+    'The folder that contains videos downloaded by the Bilibili desktop app.',
+  )
+  .option(
+    'output',
+    'Optional: The path where the output will be saved, default to the current folder.',
+  )
+  .option(
+    'page-number',
+    'Optional: Whether to include the indexed page number in the output filename.',
+  )
+  .option(
+    'silence',
+    'Optional: Whether to suppress console output during processing.',
+  )
+  .option(
+    'bufferSize',
+    'Optional: The size of the buffer chunk when processing video files, default to 64MB.',
+  )
+  .command('convert', 'Convert downloaded videos.', convertCommand as any)
+  .command('list', 'List all videos.', listCommand as any)
+  .example(
+    'npx bili-pc-mp4 ~/Movies/bilibili',
+    'A simple command to convert all videos to mp4 and save to the current folder.',
+  )
+  .example(
+    'npx bili-pc-mp4 convert -i ~/Movies/bilibili -o ~/Movies/converted -p',
+    'A complete example that converts all videos and save to specified location, naming videos with the page number.',
+  )
+  .example('npx bili-pc-mp4 list ~/Movies/bilibili', 'List all videos.');
+
+const flags = args.parse(process.argv);
+const subs = args.sub;
+
+if (subs.length === 1) {
+  convertCommand('convert', subs, flags);
+}

src/cli/index.ts

@@ -7,53 +7,6 @@ import { createFolder } from '../lib';
 import sanitize from 'sanitize-filename';
 import ora from 'ora';
 
-/**
- * Represents the structure of a task.
- * @interface Task
- * @property {string} groupTitle - The group title of the task.
- * @property {string} title - The title of the task.
- * @property {number} p - The priority of the task.
- * @property {string} uname - The username associated with the task.
- * @property {string} status - The status of the task.
- * @property {string[]} videoFiles - An array of video file names.
- * @property {string[]} danmuFiles - An array of danmu file names.
- * @property {string[]} dirPath - The path to the folder.
- */
-interface Task {
-  id: string;
-  groupTitle?: string;
-  title?: string;
-  p?: number;
-  uname?: string;
-  status?: 'completed' | string;
-  videoFiles: string[];
-  danmuFiles: string[];
-  dirPath: string;
-}
-
-/**
- * Options for processing a task.
- * @interface TaskOptions
- * @property {string} [outputPath] - The path where the output will be saved.
- * @property {boolean} [indexedP] - Whether to include the indexed priority in the output filename.
- * @property {boolean} [silence] - Whether to suppress console output during processing.
- * @property {boolean} [withDanmu] - Whether to include danmu (WIP: danmu implementation) in the processing.
- * @property {number} [bufferSize] - The size of the buffer used during decryption.
- */
-interface TaskOptions {
-  outputPath?: string;
-  indexedP?: boolean;
-  silence?: boolean;
-  withDanmu?: boolean;
-  bufferSize?: number;
-}
-
-interface TaskOptions {
-  outputPath?: string;
-  indexedP?: boolean;
-  withDanmu?: boolean; // WIP: danmu implementation
-}
-
 const TMPDIR = join(__dirname, '..', 'tmp');
 
 /**
@@ -186,19 +139,16 @@ async function processVideo(
  */
 async function processTask(task: Task, options: TaskOptions = {}) {
   const { id, groupTitle, title, p, videoFiles, dirPath } = task;
-  const { outputPath = '.', indexedP, silence } = options;
+  const { output = '.', pageNumber, silence } = options;
   const spinner = ora();
 
-  const outputDirPath = join(
-    outputPath,
-    groupTitle ? sanitize(groupTitle) : id,
-  );
+  const outputDirPath = join(output, groupTitle ? sanitize(groupTitle) : id);
   await createFolder(outputDirPath);
 
   if (!silence) {
     spinner.start(`Decrypting and combining ${title ?? id}...`);
   }
-  const filename = `${indexedP ? p : ''}${title ? sanitize(title) : id}.mp4`;
+  const filename = `${pageNumber ? p : ''}${title ? sanitize(title) : id}.mp4`;
   const outputFilePath = join(outputDirPath, filename);
   await processVideo(
     videoFiles.map(e => join(dirPath, e)),

src/core/index.ts

@@ -1,3 +1,44 @@
+/**
+ * Represents the structure of a task.
+ * @interface Task
+ * @property {string} groupTitle - The group title of the task.
+ * @property {string} title - The title of the task.
+ * @property {number} p - The priority of the task.
+ * @property {string} uname - The username associated with the task.
+ * @property {string} status - The status of the task.
+ * @property {string[]} videoFiles - An array of video file names.
+ * @property {string[]} danmuFiles - An array of danmu file names.
+ * @property {string[]} dirPath - The path to the folder.
+ */
+interface Task {
+  id: string;
+  groupTitle?: string;
+  title?: string;
+  p?: number;
+  uname?: string;
+  status?: 'completed' | string;
+  videoFiles: string[];
+  danmuFiles: string[];
+  dirPath: string;
+}
+
+/**
+ * Options for processing a task.
+ * @interface TaskOptions
+ * @property {string} [output] - The path where the output will be saved.
+ * @property {boolean} [pageNumber] - Whether to include the indexed page number in the output filename.
+ * @property {boolean} [silence] - Whether to suppress console output during processing.
+ * @property {boolean} [withDanmu] - Whether to include danmu (WIP: danmu implementation) in the processing.
+ * @property {number} [bufferSize] - The size of the buffer chunk when processing video files.
+ */
+interface TaskOptions {
+  output?: string;
+  pageNumber?: boolean;
+  silence?: boolean;
+  withDanmu?: boolean;
+  bufferSize?: number;
+}
+
 interface VideoInfo {
   type: string;
   codecid: number;