ArgumentParser adoption thread

nnnnnnnn · February 29, 2020, 7:26pm

It's terrific to see people already integrating ArgumentParser into their projects! Seeing examples of how people are using the library is extremely valuable for evaluating the design so far and looking at where we might need to fill out features or documentation.

If you'd like to share your adoption in an open-source command-line tool, please add a link to your project in this thread!

kaan · February 29, 2020, 11:28pm

I've migrated to ArgumentParser here. I really really like @OptionGroup to automatically get the arguments in a separate struct that could be passed around

One thing I would like is the ability to give custom names to @Argument values just like @Flag and @Option, I know they are positional so there's no prefix name but they still show on the auto generated help message, as well as on the parameters missing message.

nnnnnnnn · March 1, 2020, 12:28am

Looks great, @kaan!

You can override the value name when passing a full ArgumentHelp instance instead of a string literal. Take a look here for an example:

github.com/apple/swift-argument-parser

Examples/roll/main.swift

main

//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//

import ArgumentParser

struct RollOptions: ParsableArguments {
    @Option(help: ArgumentHelp("Rolls the dice <n> times.", valueName: "n"))
    var times = 1

    @Option(help: ArgumentHelp(
        "Rolls an <m>-sided dice.",
        discussion: "Use this option to override the default value of a six-sided die.",

This file has been truncated. show original

duan · March 2, 2020, 5:59am

DrString migrating from swift-tools-support-core to swift-argument-parser: Migrate CLI to ArgumentParser by dduan · Pull Request #179 · dduan/DrString · GitHub

Victor_Guerra · March 4, 2020, 9:56pm

Swift for TensorFlow related project swift-models migrating from Commander to ArgumentParser: https://github.com/tensorflow/swift-models/pull/357

NSExceptional · March 16, 2020, 3:02am

@nnnnnnnn is there a way to pass arguments/options/flags in one ParsableCommand down to its subcommands, which accept their own arguments? i.e., where the subcommand needs to see what bar is here:

mycommand foo [--bar <value>] <subcommand>

griffin-stewie · March 21, 2020, 10:21am

I updated my tool. Trash my command parser written by Objective-C, use ArgumentParser!

griffin-stewie/clg: Supports generate clr file or code from ASE file a.k.a. "Adobe Swatch Exchange" etc.

SlaunchaMan · April 19, 2020, 1:24pm

I’ve written a very important piece of software that uses ArgumentParser to fetch dad jokes: GitHub - SlaunchaMan/DadJokes: A command-line utility for macOS to display a dad joke.

adam-fowler · April 19, 2020, 9:48pm

I have a website that displays swift package dependency graphs. I migrated to using swift-argument-parser in the tool that generates the data for this website. Maybe you can use it to find other packages that are using the argument parser in more interesting ways than I have.

Iain_Smith · April 21, 2020, 2:48pm

I'm using ArgumentParser for swift-docker-cli.

In my unit tests, I wanted a way to test some computed properties on my options type, without having to setup all the temporary directory & files required to pass validation. I've raised a pull request on the repo proposing to add this functionality.

nnnnnnnn · April 24, 2020, 3:59am

This is really cool, Adam — thanks for sharing!

bdrelling · May 14, 2020, 7:03am

This project is so wonderful! What a wonderful use of Property Wrappers. When I first wrote Zinc as an internal tool for my company, I ended up attempting to use the SPM utilities and ditching it because it was too opinionated in some ways and not opinionated enough in others. I wrote my own ArgumentParser logic that did things in a similar way but before the use of Property Wrappers came around.

It was so so so simple to update to ArgumentParser from within my project. Feel free to check out the PR where I just did it in <10 minutes here. (All those deleted files? Those are now defunct because your library does everything mine was doing only better, safer, and more efficiently!)

I'm already adding some proposals and following the tool, hoping to make some contributions back to continue to support this. Wonderful work Nate, can't wait to see where it goes!