optparse

KO | EN

gitlite — search

#javascript #python #react #golang #go #rust #nodejs #windows #awesome #kubernetes #vue #security #ios #openai

(★ 20)

Parse and process command-line options http://gvvaughan.github.io/optparse

optparse 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Parse and Process Command Line Options
======================================

[![License](http://img.shields.io/:license-mit-blue.svg)](http://mit-license.org)
[![workflow status](https://github.com/gvvaughan/optparse/actions/workflows/spec.yml/badge.svg?branch=master)](https://github.com/gvvaughan/optparse/actions)
[![codecov.io](https://codecov.io/gh/gvvaughan/optparse/branch/master/graph/badge.svg)](https://codecov.io/gh/gvvaughan/optparse)

In the common case, you can write the long-form help output typical of
a modern command line program, and let this module generate a custom
parser that collects and diagnoses the options it describes.

The parser is actually an object instance which can then be tweaked for
the uncommon case, by hand, or by using the "on" method to tie your
custom handlers to options that are not handled quite the way you'd
like.

This is a pure Lua library compatible with [LuaJIT][], [Lua][] 5.1,
5.2, 5.3, 5.4 and 5.5.

[github]: https://github.com/gvvaughan/optparse/ "Github repository"
[lua]: https://www.lua.org "The Lua Project"
[luajit]: https://luajit.org "The LuaJIT Project"

Installation
------------

The simplest and best way to install optparse is with [LuaRocks][]. To
install the latest release (recommended):

```bash
luarocks install optparse
```

To install current git master (for testing, before submitting a bug
report for example):

```bash
luarocks install http://raw.githubusercontent.com/gvvaughan/optparse/master/optparse-git-1.rockspec
```

The best way to install without [LuaRocks][] is to copy the
`optparse.lua` file into a directory in your package search path.

[luarocks]: https://www.luarocks.org "Lua package manager"

Use
---

The optparse package returns a parser factory when loaded:

```lua
local OptionParser = require "optparse"

local help = [[
parseme (optparse spec) 0α1

Copyright © 2026 Gary V. Vaughan
This test program comes with ABSOLUTELY NO WARRANTY.

Usage: parseme [<options>] <file>...

Banner text.

Long description.

Options:

-h, --help               display this help, then exit
      --version            display version information, then exit
  -b                       a short option with no long option
      --long               a long option with no short option
      --another-long       a long option with internal hypen
      --true               a Lua keyword as an option name
  -v, --verbose            a combined short and long option
  -n, --dryrun, --dry-run  several spellings of the same option
  -u, --name=USER          require an argument
  -o, --output=[FILE]      accept an optional argument
  --                       end of options

Footer text.

Please report bugs at <http://github.com/gvvaughan/optparse/issues>.
]]

local parser = OptionParser (help)
local arg, opts = parser:parse (_G.arg)
```

Documentation
-------------

The latest release is [documented with LDoc][github.io].
Pre-built HTML files are included in the [release][] tarball.

[github.io]: https://gvvaughan.github.io/optparse
[release]: https://github.com/gvvaughan/optparse/releases

Bug reports and code contributions
----------------------------------

Please make bug reports and suggestions as [GitHub Issues][issues].
Pull requests are especially appreciated.

But first, please check that your issue has not already been reported by
someone else, and that it is not already fixed by [master][github] in
preparation for the next release (see Installation section above for how
to temporarily install master with [LuaRocks][]).

There is no strict coding style, but please bear in mind the following
points when proposing changes:

0. Follow existing code. There are a lot of useful patterns and avoided
   traps there.

1. 3-character indentation using SPACES in Lua sources: It makes rogue
   TABs easier to see, and lines up nicely with 'if' and 'end' keywords.

2. Simple strings are easiest to type using single-quote delimiters,
   saving double-quotes for where a string contains apostrophes.

3. Save horizontal space by only using SPACEs where the parser requires
   them.

4. Use vertical space to separate out compound statements to help the
   coverage reports discover untested lines.

5. Prefer explicit string function calls over object methods, to mitigate
   issues with monkey-patching in caller environment.

[issues]: https://github.com/gvvaughan/optparse/issues

optparse

optparse 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

optparse

optparse 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README