Flutter参数传递插件args_simple的使用

Flutter参数传递插件args_simple的使用

标题

Flutter参数传递插件args_simple的使用

内容

• 简介

  • args_simple 是一个简单的参数解析器和处理器，集成JSON和dart:io。
  • 可以通过命令行参数来解析配置文件、用户信息、系统配置目录等。

• API文档

  • 查看 API文档 获取完整函数、类和扩展列表。

• 使用示例

import 'dart:io';

import 'package:args_simple/args_simple_io.dart';

/// Examples of valid values for the parameter `args`:
///
/// - `/path/config.json --port 81 -verbose`
/// - `/path/config.json -verbose --sys-config /my/sys-config-dir`
/// - `/path/config.json root`
void main(List<String> argsOrig) {
  var args = ArgsSimple.parse(argsOrig);

  if (args.isEmpty) {
    print(
        'USAGE: [%configFile.json] [%user] [--port] [--sys-config %systemConfig] [-verbose]');
    exit(0);
  }

  // Argument #0 is a JSON `File`:
  var config = args.argumentMatches(0, RegExp(r'.json$'))
      ? args.argumentAsFileContentJSON(0)!
      : {};

  // Argument #1 is an optional `String`, with `guest` as default:
  var user = args.argumentAsString(1, 'guest');

  // Option `sys-config` is a `Directory`, with `/default/sys-config-dir` as default:
  var systemConfigDir = args.optionAsDirectory('sys-config', Directory('/default/sys-config-dir'))!;

  // Option `--port` is an `int`, with 8080 as default:
  var port = args.optionAsInt('port', 8080);

  // Check for flag `-verbose`:
  var verbose = args.flag('verbose');

  if (verbose) {
    print('-- Config: $config');
    print('-- User: $user');
    print('-- System Config Dir: $systemConfigDir');
    print('-- Port: $port');
    print('-- Verbose: $verbose');
    print(args);
  }
}

源代码链接

• 官方源代码托管在 GitHub 上：https://github.com/gmpassos/args_simple

特性与bug

• 提交功能请求和bug到 issue tracker

贡献

• 开源社区的帮助总是非常需要的：
  • 发现问题？请填写详细的bug报告。
  • 希望新功能？请提出功能请求并附上用例。
  • 使用并喜欢项目？宣传项目：撰写文章、发布帖子或捐款。
  • 是开发者？修复bug并提交pull request。实现新的功能，如其他训练算法和激活函数。
  • 已经帮助过？非常感谢你，贡献者和所有使用这个项目的其他人！

许可证

• Apache License - Version 2.0

示例代码

import 'dart:io';

import 'package:args_simple/args_simple_io.dart';

/// Examples of valid values for the parameter `args`:
///
/// - `/path/config.json --port 81 -verbose`
/// - `/path/config.json -verbose --sys-config /my/sys-config-dir`
/// - `/path/config.json root`
void main(List<String> argsOrig) {
  var args = ArgsSimple.parse(argsOrig);

  if (args.isEmpty) {
    print(
        'USAGE: [%configFile.json] [%user] [--port] [--sys-config %systemConfig] [-verbose]');
    exit(0);
  }

  // Argument #0 is a JSON `File`:
  var config = args.argumentMatches(0, RegExp(r'.json$'))
      ? args.argumentAsFileContentJSON(0)!
      : {};

  // Argument #1 is an optional `String`:
  var user = args.argumentAsString(1, 'guest');

  // Option `sys-config` is a `Directory`:
  var systemConfigDir = args.optionAsDirectory('sys-config', Directory('/default/sys-config-dir'))!;

  // Option `--port` is an `int`, with 8080 as default:
  var port = args.optionAsInt('port', 8080);

  // Check for flag `-verbose`:
  var verbose = args.flag('verbose');

  if (verbose) {
    print('-- Config: $config');
    print('-- User: $user');
    print('-- System Config Dir: $systemConfigDir');
    print('-- Port: $port');
    print('-- Verbose: $verbose');
    print(args);
  }
}