melahn / user-story-generator Goto Github PK

Improve the help by showing defaults

It would be useful to have a way of generating user stories in some other language than English.

Provide an option to print stories from random selections. This could be useful for statistical based testing or just for fun

See https://central.sonatype.org/pages/requirements.html

When building the shaded jar, observe this warning:

SparseBitSet-1.2.jar, commons-cli-1.4.jar, commons-codec-1.13.jar, commons-collections4-4.4.jar, commons-compress-1.19.jar, commons-math3-3.6.1.jar, curvesapi-1.06.jar, hamcrest-core-1.3.jar, junit-4.13.jar, poi-4.1.2.jar, poi-ooxml-4.1.2.jar, poi-ooxml-schemas-4.1.2.jar, user-story-generator-1.0.0.jar, xmlbeans-3.1.0.jar define 1 overlapping resources:

• META-INF/MANIFEST.MF
  commons-cli-1.4.jar, commons-codec-1.13.jar, commons-collections4-4.4.jar, commons-compress-1.19.jar, commons-math3-3.6.1.jar define 2 overlapping resources:
• META-INF/LICENSE.txt
• META-INF/NOTICE.txt
  hamcrest-core-1.3.jar, xmlbeans-3.1.0.jar define 1 overlapping resources:
• LICENSE.txt
  poi-4.1.2.jar, poi-ooxml-4.1.2.jar, poi-ooxml-schemas-4.1.2.jar define 2 overlapping resources:
• META-INF/LICENSE
• META-INF/NOTICE
  maven-shade-plugin has detected that some class files are
  present in two or more JARs. When this happens, only one
  single version of the class is copied to the uber jar.
  Usually this is not harmful and you can skip these warnings,
  otherwise try to manually exclude artifacts based on
  mvn dependency:tree -Ddetail=true and the above output.
  See http://maven.apache.org/plugins/maven-shade-plugin/

Try to eliminate it.

java -jar user-story-generator-1.0.0.jar -d "./resource/example/user-story-denormalized-data.xlsx" -o "./user-story-generated-denormalized.txt"
-->
java -jar "./resource/jar/user-story-generator-1.0.0.jar" -d "./resource/example/user-story-denormalized-data.xlsx" -o "./user-story-generated-denormalized.txt"

java -jar user-story-generator-1.0.0.jar -d "./resource/example/user-story-normalized-data.xlsx" -o "./user-story-generated-normalized.txt -s "./resource/example/user-story-normalized-data.csv"
-->
java -jar "./resource/jar/user-story-generator-1.0.0.jar" -d "./resource/example/user-story-normalized-data.xlsx" -o "./user-story-generated-normalized.txt" -s "./resource/example/user-story-normalized-data.csv"

The project does not force the specification of acceptance criteria. Many (most?) user stories won’t have acceptance criteria specified in detail at the early stages. That detail will be added later when the story is being discussed with the team, and sized. But the project does still print the header. It’s just clutter to even bother to print “Acceptance Criteria: \n None Specified” so suppress it when there is no acceptance criteria specified.

Maybe these issues should be written as user stories ;-)

Filtering is not needed in the generated jar file and should be removed

2 warnings
[WARNING] Javadoc Warnings
[WARNING] /Users/melahn/IdeaProjects/user-story-generator/src/main/java/com/melahn/util/agile/StorySheetsHandler.java:65: warning: no description for @param
[WARNING] * @param selectionsFilename
[WARNING] ^
[WARNING] /Users/melahn/IdeaProjects/user-story-generator/src/main/java/com/melahn/util/agile/StoryPrinter.java:131: warning: no description for @throws
[WARNING] * @throws Exception
[WARNING] ^