@lppx/nlearn 1.1.0

package/dist/src/demo/yargs/01-/345/237/272/347/241/200/346/246/202/345/277/265.js

@@ -0,0 +1,142 @@
+"use strict";
+/**
+ * yargs 基础概念
+ * ================
+ * yargs 是一个强大的命令行参数解析库，用于构建交互式命令行工具
+ * 适用版本: yargs ^17.0.0 或 ^18.0.0
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+// #region 示例1: 最简单的参数解析
+function demoSimpleArgumentParsing() {
+    console.log('\n=== 示例1: 最简单的参数解析 ===');
+    // 解析命令行参数
+    // 运行: ts-node 01-基础概念.ts --name=张三 --age=25
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv)).parseSync();
+    console.log('解析的参数:', argv);
+    console.log('name:', argv.name);
+    console.log('age:', argv.age);
+}
+// #endregion
+// #region 示例2: 定义选项类型
+function demoOptionTypes() {
+    console.log('\n=== 示例2: 定义选项类型 ===');
+    // 使用 .option() 定义参数的类型和描述
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .option('name', {
+        alias: 'n', // 别名，可以用 -n 代替 --name
+        type: 'string', // 参数类型
+        description: '用户名称',
+        demandOption: true // 必填参数
+    })
+        .option('age', {
+        alias: 'a',
+        type: 'number',
+        description: '用户年龄',
+        default: 18 // 默认值
+    })
+        .parseSync();
+    console.log(`姓名: ${argv.name}, 年龄: ${argv.age}`);
+}
+// #endregion
+// #region 示例3: 布尔类型参数
+function demoBooleanOptions() {
+    console.log('\n=== 示例3: 布尔类型参数 ===');
+    // 布尔参数不需要值，存在即为 true
+    // 运行: ts-node 01-基础概念.ts --verbose --debug
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .option('verbose', {
+        alias: 'v',
+        type: 'boolean',
+        description: '显示详细信息',
+        default: false
+        // demandOption: true    // 必填参数
+    })
+        .option('debug', {
+        alias: 'd',
+        type: 'boolean',
+        description: '调试模式',
+        default: false
+    })
+        .parseSync();
+    console.log('详细模式:', argv.verbose);
+    console.log('调试模式:', argv.debug);
+    if (argv.verbose) {
+        console.log('正在执行详细输出...');
+    }
+}
+// #endregion
+// #region 示例4: 数组类型参数
+function demoArrayOptions() {
+    console.log('\n=== 示例4: 数组类型参数 ===');
+    // 数组参数可以接收多个值
+    // 运行: ts-node 01-基础概念.ts --tags=nodejs --tags=typescript --tags=yargs
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .option('tags', {
+        alias: 't',
+        type: 'array',
+        description: '标签列表',
+        default: []
+    })
+        .parseSync();
+    console.log('标签列表:', argv.tags);
+    console.log('标签数量:', argv.tags?.length);
+}
+// #endregion
+// #region 示例5: 帮助信息
+function demoHelpInfo() {
+    console.log('\n=== 示例5: 帮助信息 ===');
+    // yargs 自动生成帮助信息
+    // 运行: ts-node 01-基础概念.ts --help
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .option('name', {
+        alias: 'n',
+        type: 'string',
+        description: '用户名称',
+        demandOption: true
+    })
+        .option('age', {
+        alias: 'a',
+        type: 'number',
+        description: '用户年龄',
+        default: 18
+    })
+        .help() // 启用 --help 选项
+        .alias('help', 'h') // 添加 -h 别名
+        .parseSync();
+    console.log('帮助信息已显示（如果使用了 --help）');
+}
+// #endregion
+if (require.main === module) {
+    const exampleNum = process.argv[2];
+    switch (exampleNum) {
+        case '1':
+            demoSimpleArgumentParsing();
+            break;
+        case '2':
+            demoOptionTypes();
+            break;
+        case '3':
+            demoBooleanOptions();
+            break;
+        case '4':
+            demoArrayOptions();
+            break;
+        case '5':
+            demoHelpInfo();
+            break;
+        default:
+            console.log('请指定示例编号 (1-5)');
+            console.log('用法: ts-node 01-基础概念.ts <示例编号> [参数...]');
+            console.log('\n可用示例:');
+            console.log('  1 - 最简单的参数解析');
+            console.log('  2 - 定义选项类型');
+            console.log('  3 - 布尔类型参数');
+            console.log('  4 - 数组类型参数');
+            console.log('  5 - 帮助信息');
+    }
+}

package/dist/src/demo/yargs/02-/345/221/275/344/273/244/347/263/273/347/273/237.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * yargs 命令系统
+ * ================
+ * 学习如何使用 yargs 构建多命令 CLI 工具（类似 git、npm 等）
+ * 适用版本: yargs ^17.0.0 或 ^18.0.0
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+// #region 示例1: 基础命令定义
+function demoBasicCommand() {
+    console.log('\n=== 示例1: 基础命令定义 ===');
+    // 定义一个简单的命令
+    // 运行: ts-node 02-命令系统.ts 1 greet --name=张三
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1))) // slice(1) 跳过示例编号
+        .command('greet', // 命令名称
+    '打招呼', // 命令描述
+    (yargs) => {
+        // 配置命令的选项
+        return yargs.option('name', {
+            alias: 'n',
+            type: 'string',
+            description: '名字',
+            demandOption: true
+        });
+    }, (argv) => {
+        // 命令处理函数
+        console.log(`你好, ${argv.name}!`);
+    })
+        .demandCommand(1, '请指定一个命令')
+        .help()
+        .argv;
+}
+// #endregion
+// #region 示例2: 多个命令
+function demoMultipleCommands() {
+    console.log('\n=== 示例2: 多个命令 ===');
+    // 定义多个命令，类似 git add、git commit
+    // 运行: ts-node 02-命令系统.ts 2 add --file=test.ts
+    // 运行: ts-node 02-命令系统.ts 2 remove --file=test.ts
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .command('add', '添加文件', (yargs) => {
+        return yargs.option('file', {
+            alias: 'f',
+            type: 'string',
+            description: '文件路径',
+            demandOption: true
+        });
+    }, (argv) => {
+        console.log(`✓ 已添加文件: ${argv.file}`);
+    })
+        .command('remove', '删除文件', (yargs) => {
+        return yargs.option('file', {
+            alias: 'f',
+            type: 'string',
+            description: '文件路径',
+            demandOption: true
+        });
+    }, (argv) => {
+        console.log(`✓ 已删除文件: ${argv.file}`);
+    })
+        .demandCommand(1, '请指定一个命令 (add 或 remove)')
+        .help()
+        .argv;
+}
+// #endregion
+// #region 示例3: 位置参数
+function demoPositionalArguments() {
+    console.log('\n=== 示例3: 位置参数 ===');
+    // 使用位置参数（不需要 -- 前缀）
+    // 运行: ts-node 02-命令系统.ts 3 copy source.txt dest.txt
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .command('copy <source> <destination>', // <> 表示必需的位置参数
+    '复制文件', (yargs) => {
+        return yargs
+            .positional('source', {
+            describe: '源文件路径',
+            type: 'string'
+        })
+            .positional('destination', {
+            describe: '目标文件路径',
+            type: 'string'
+        });
+    }, (argv) => {
+        console.log(`复制 ${argv.source} 到 ${argv.destination}`);
+    })
+        .demandCommand(1)
+        .help()
+        .argv;
+}
+// #endregion
+// #region 示例4: 可选位置参数
+function demoOptionalPositionalArgs() {
+    console.log('\n=== 示例4: 可选位置参数 ===');
+    // 使用可选位置参数
+    // 运行: ts-node 02-命令系统.ts 4 list
+    // 运行: ts-node 02-命令系统.ts 4 list /home/user
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .command('list [directory]', // [] 表示可选的位置参数
+    '列出目录内容', (yargs) => {
+        return yargs.positional('directory', {
+            describe: '目录路径',
+            type: 'string',
+            default: '.'
+        });
+    }, (argv) => {
+        console.log(`列出目录: ${argv.directory}`);
+    })
+        .demandCommand(1)
+        .help()
+        .argv;
+}
+// #endregion
+// #region 示例5: 子命令
+function demoSubcommands() {
+    console.log('\n=== 示例5: 子命令 ===');
+    // 创建嵌套的子命令结构
+    // 运行: ts-node 02-命令系统.ts 5 user create --name=张三 --email=zhangsan@example.com
+    // 运行: ts-node 02-命令系统.ts 5 user delete --id=123
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .command('user', '用户管理', (yargs) => {
+        return yargs
+            .command('create', '创建用户', (yargs) => {
+            return yargs
+                .option('name', {
+                type: 'string',
+                description: '用户名',
+                demandOption: true
+            })
+                .option('email', {
+                type: 'string',
+                description: '邮箱',
+                demandOption: true
+            });
+        }, (argv) => {
+            console.log(`✓ 创建用户: ${argv.name} (${argv.email})`);
+        })
+            .command('delete', '删除用户', (yargs) => {
+            return yargs.option('id', {
+                type: 'number',
+                description: '用户ID',
+                demandOption: true
+            });
+        }, (argv) => {
+            console.log(`✓ 删除用户 ID: ${argv.id}`);
+        })
+            .demandCommand(1, '请指定子命令 (create 或 delete)');
+    })
+        .demandCommand(1)
+        .help()
+        .argv;
+}
+// #endregion
+// #region 示例6: 命令别名
+function demoCommandAliases() {
+    console.log('\n=== 示例6: 命令别名 ===');
+    // 为命令设置别名
+    // 运行: ts-node 02-命令系统.ts 6 install express
+    // 运行: ts-node 02-命令系统.ts 6 i express (使用别名)
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .command(['install <package>', 'i <package>'], // 第二个是别名
+    '安装包', (yargs) => {
+        return yargs.positional('package', {
+            describe: '包名称',
+            type: 'string'
+        });
+    }, (argv) => {
+        console.log(`正在安装: ${argv.package}`);
+    })
+        .demandCommand(1)
+        .help()
+        .argv;
+}
+// #endregion
+if (require.main === module) {
+    const exampleNum = process.argv[2];
+    switch (exampleNum) {
+        case '1':
+            demoBasicCommand();
+            break;
+        case '2':
+            demoMultipleCommands();
+            break;
+        case '3':
+            demoPositionalArguments();
+            break;
+        case '4':
+            demoOptionalPositionalArgs();
+            break;
+        case '5':
+            demoSubcommands();
+            break;
+        case '6':
+            demoCommandAliases();
+            break;
+        default:
+            console.log('请指定示例编号 (1-6)');
+            console.log('用法: ts-node 02-命令系统.ts <示例编号> [命令] [参数...]');
+            console.log('\n可用示例:');
+            console.log('  1 - 基础命令定义');
+            console.log('  2 - 多个命令');
+            console.log('  3 - 位置参数');
+            console.log('  4 - 可选位置参数');
+            console.log('  5 - 子命令');
+            console.log('  6 - 命令别名');
+    }
+}

package/dist/src/demo/yargs/03-/351/253/230/347/272/247/347/211/271/346/200/247.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * yargs 高级特性
+ * ================
+ * 学习 yargs 的高级功能：验证、中间件、配置文件等
+ * 适用版本: yargs ^17.0.0 或 ^18.0.0
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+// #region 示例1: 参数验证
+function demoArgumentValidation() {
+    console.log('\n=== 示例1: 参数验证 ===');
+    // 使用 .check() 进行自定义验证
+    // 运行: ts-node 03-高级特性.ts 1 --age=25 --email=test@example.com
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .option('age', {
+        type: 'number',
+        description: '年龄',
+        demandOption: true
+    })
+        .option('email', {
+        type: 'string',
+        description: '邮箱',
+        demandOption: true
+    })
+        .check((argv) => {
+        // 验证年龄范围
+        if (argv.age < 0 || argv.age > 150) {
+            throw new Error('年龄必须在 0-150 之间');
+        }
+        // 验证邮箱格式
+        const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+        if (!emailRegex.test(argv.email)) {
+            throw new Error('邮箱格式不正确');
+        }
+        return true;
+    })
+        .argv;
+    console.log('✓ 参数验证通过');
+}
+// #endregion
+// #region 示例2: 参数冲突
+function demoArgumentConflicts() {
+    console.log('\n=== 示例2: 参数冲突 ===');
+    // 使用 .conflicts() 定义互斥的参数
+    // 运行: ts-node 03-高级特性.ts 2 --json (正确)
+    // 运行: ts-node 03-高级特性.ts 2 --json --xml (错误，会报冲突)
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .option('json', {
+        type: 'boolean',
+        description: '输出 JSON 格式'
+    })
+        .option('xml', {
+        type: 'boolean',
+        description: '输出 XML 格式'
+    })
+        .conflicts('json', 'xml') // json 和 xml 不能同时使用
+        .argv;
+    console.log('✓ 参数冲突检查通过');
+}
+// #endregion
+// #region 示例3: 参数依赖
+function demoArgumentDependencies() {
+    console.log('\n=== 示例3: 参数依赖 ===');
+    // 使用 .implies() 定义参数依赖关系
+    // 运行: ts-node 03-高级特性.ts 3 --ssl --cert=cert.pem --key=key.pem
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .option('ssl', {
+        type: 'boolean',
+        description: '启用 SSL'
+    })
+        .option('cert', {
+        type: 'string',
+        description: 'SSL 证书路径'
+    })
+        .option('key', {
+        type: 'string',
+        description: 'SSL 密钥路径'
+    })
+        .implies('ssl', ['cert', 'key']) // 如果使用 ssl，必须提供 cert 和 key
+        .argv;
+    console.log('✓ 参数依赖检查通过');
+}
+// #endregion
+// #region 示例4: 中间件
+function demoMiddleware() {
+    console.log('\n=== 示例4: 中间件 ===');
+    // 使用 .middleware() 在命令执行前处理参数
+    // 运行: ts-node 03-高级特性.ts 4 --name=张三
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .option('name', {
+        type: 'string',
+        description: '名字',
+        demandOption: true
+    })
+        .middleware((argv) => {
+        // 中间件：记录日志
+        console.log('[中间件] 接收到参数:', argv);
+        // 中间件：转换参数
+        argv.name = argv.name.toUpperCase();
+        console.log('[中间件] 转换后的名字:', argv.name);
+    })
+        .command('$0', '默认命令', () => { }, (argv) => {
+        console.log(`处理名字: ${argv.name}`);
+    })
+        .argv;
+}
+// #endregion
+// #region 示例5: 选项分组
+function demoOptionGrouping() {
+    console.log('\n=== 示例5: 选项分组 ===');
+    // 使用 .group() 将相关选项分组显示
+    // 运行: ts-node 03-高级特性.ts 5 --help
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .option('host', {
+        type: 'string',
+        description: '服务器地址',
+        default: 'localhost'
+    })
+        .option('port', {
+        type: 'number',
+        description: '端口号',
+        default: 3000
+    })
+        .option('verbose', {
+        type: 'boolean',
+        description: '详细输出'
+    })
+        .option('debug', {
+        type: 'boolean',
+        description: '调试模式'
+    })
+        .group(['host', 'port'], '服务器配置:')
+        .group(['verbose', 'debug'], '日志选项:')
+        .help()
+        .argv;
+    console.log('查看 --help 可以看到分组效果');
+}
+// #endregion
+// #region 示例6: 环境变量
+function demoEnvironmentVariables() {
+    console.log('\n=== 示例6: 环境变量 ===');
+    // 使用 .env() 从环境变量读取配置
+    // 运行: MY_APP_PORT=8080 MY_APP_HOST=0.0.0.0 ts-node 03-高级特性.ts 6
+    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .env('MY_APP') // 读取 MY_APP_ 前缀的环境变量
+        .option('port', {
+        type: 'number',
+        description: '端口号',
+        default: 3000
+    })
+        .option('host', {
+        type: 'string',
+        description: '主机地址',
+        default: 'localhost'
+    })
+        .argv;
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv.slice(1)))
+        .env('MY_APP')
+        .option('port', { type: 'number', default: 3000 })
+        .option('host', { type: 'string', default: 'localhost' })
+        .argv;
+    console.log('配置信息:');
+    console.log('  Host:', argv.host);
+    console.log('  Port:', argv.port);
+    console.log('\n提示: 可以设置环境变量 MY_APP_PORT 和 MY_APP_HOST');
+}
+// #endregion
+if (require.main === module) {
+    const exampleNum = process.argv[2];
+    switch (exampleNum) {
+        case '1':
+            demoArgumentValidation();
+            break;
+        case '2':
+            demoArgumentConflicts();
+            break;
+        case '3':
+            demoArgumentDependencies();
+            break;
+        case '4':
+            demoMiddleware();
+            break;
+        case '5':
+            demoOptionGrouping();
+            break;
+        case '6':
+            demoEnvironmentVariables();
+            break;
+        default:
+            console.log('请指定示例编号 (1-6)');
+            console.log('用法: ts-node 03-高级特性.ts <示例编号> [参数...]');
+            console.log('\n可用示例:');
+            console.log('  1 - 参数验证');
+            console.log('  2 - 参数冲突');
+            console.log('  3 - 参数依赖');
+            console.log('  4 - 中间件');
+            console.log('  5 - 选项分组');
+            console.log('  6 - 环境变量');
+    }
+}