jheim76283 / unix4j Goto Github PK

See sort notes / sort.xml for options which are not implemented

New command - cat

Better add javadoc to all public & protected members as well, but the minimum 
requirement for 1.0 is class level javadoc for every type.

What steps will reproduce the problem?
Unix4j.from(input).cat().xargs().echo(Arg.$all).sort().toStdOut()

What is the expected output? What do you see instead?
expected output is the sorted output of the cat.

Please use labels and text to provide additional information.
The sort breaks the chain. Reason is XargsCommand.join(..) which should now 
produce a joined command.

Simple page showing how to get started.
How to build.
Simple example.

Request to implement the unix2dos command in Unix4j

Add cd command and introduce an env object with environment state such as 
current working dir etc.

This should include an overview and some examples.

Grep is pretty powerful on the command line.  It would be nice if you could add 
more of the features.

Here is a set that I typically use.
 grep -A 10 -B 10 -H FILE *.txt

Add 10 lines after context and 10 lines before.  Print the name of the file as 
a prefix to the output.

What version of the product are you using? On what operating system?

0.3

Request to implement the paste command in Unix4j

1. Which objects form the command API? 
2. Which are generated, in particular, is the main command class (Ls, Echo, 
...) generated?
3. Are the API objects (a) used in final runtime code or (b) copied to impl 
project?

Write unit tests for xargs

Convert "xargs" command description into new standard format

Simple FAQ.  Please note all initial FAQ questions in this issue.

1. Will there be more commands coming?
2. How are line endings handled in Unix4j.

What steps will reproduce the problem?
1. Run a test case in Java
2. Unix4j.grep(Grep.Options.lineNumber, "sql", "QueryLog.Fri").toStdOut();

What is the expected output? What do you see instead?

It is expected to have a line number next to the output of each line

What version of the product are you using? On what operating system?
0.3
Please provide any additional information below.

Convert "Cut" command description into new standard format

Branch name: bens.argument.refactor

Hey dude. Could you please have a look at my changes.  See what you think.

You looooooove it!

Request to implement the diff command in Unix4j

Convert "Echo" command description into new standard format

What steps will reproduce the problem?
1. use jdk6 load class Unix4j

What is the expected output? What do you see instead?
run correctly, but outputs: 
{{{
Exception in thread "main" java.lang.UnsupportedClassVersionError: 
org/unix4j/Unix4j : Unsupported major.minor version 51.0
}}}

What version of the product are you using? On what operating system?
mac 10.6 + jdk6

Please provide any additional information below.
--

I don't if unix4j supports j2se 6, if supports you can assign the compile fit 
j2se 6.

Branch name: marco-args

When reviewing my code changes, please focus on:
...args package

After the review, I'll merge this branch into:
yours, then master

cheers,
marco

Convert "grep" command description into new standard format

* Change Unix4j to become generated
* Every no-input command method should appear as static entry method in Unix4j

Request to implement the join command in Unix4j

Add unit tests for command base classes.

Currently, javadoc text for generated classes must be provided through the 
@Javadoc annotation. However, this is not very convenient and looks not nice in 
the javadoc of the API class itself.

This enhancement adds support to write javadoc directly instead of via @Javadoc 
annotation. The source file must then be parsed during code generation and 
added to the data model for codegen.

Convert "sort" command description into new standard format

With the new @Acronym annotation, only the long name option exists in the 
option enum for a command. As a consequence, the command's toString() 
representation always prints the long option names.

It would be nice to provide a way to print short option names if they are 
passed to the command through the acronym, e.g. for the "ls" command, if one 
writes

ls(Ls.Options.l.a)

the command to string should be

ls -la

instead of 

ls --longFormat --allFiles

One way to achieve this is by adding a new method  to OptionSet:
boolean useOptionAcronym()

This flag should then be set in the generated OptionSet. There are different 
possibilities to do this
(a) when the first chosen option is an acronym
(b) when the last chosen option is an acronym
(c) when any chosen option is an acronym

Note: it is not very practical to distinguish between acronym and long option 
name on a per-option basis.

Request to implement the dos2unix command in Unix4j

Request to implement the fmt command in Unix4j

Bring sort and uniq in line
- and comparator to uniq
- possibly also: add sort options to uniq (check man page for options)

Request to implement the "find" command.

To distribute as a "getting started" application.

As well as to maybe show on the quick-start page.

Known issues

Request to implement the awk command in Unix4j

1. create a resource directory for the "ls" unit tests, asserted tests refer to 
this directory
2. add asserts to the tests
3. test/assert each option at least once

Currently, the command javadoc starts with <b>NAME</b> with the consequence 
that only NAME is visible in the command list e.g. on the package page in 
javadoc. We have to make sure that a short command description makes up the 
first javadoc sentence.

Write some tests which test various chaining combinations.