Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
669 Commits 10 Branches 0 Tags
041cb30eb01f8a9712690b4a1ad4adfb034b67f1
Commit Graph

63 Commits

Author SHA1 Message Date
Janne Valkealahti
5e0c79cb2a Update docs copyright year 2023-03-18 16:51:49 +00:00
Simon Verhoeven
3c090848bf Rename setMaskCharater to setMaskCharacter 
- Backport #686
- Fixes #689
 2023-03-12 16:12:28 +00:00
Janne Valkealahti
d72627443c Rename command registration doc files 2023-02-23 09:57:33 +00:00
Janne Valkealahti
545a735dd9 Move command registration under same section 2023-02-23 09:28:48 +00:00
Janne Valkealahti
78da071e86 Document String array option type 
- Backport #558 as it brings missing option type docs
- Backport #628
- Fixes #629
 2023-01-19 11:59:53 +00:00
Janne Valkealahti
7c91782841 Revisit positional arguments 
- Add better mapping logic
- Add better type conversion
- More docs for arity and positional option configuration
- Backport #616
- Fixes #617
 2023-01-13 17:56:24 +00:00
Janne Valkealahti
e70ea6b555 Register option without prefix 
- While option should be defined i.e. using "--arg", discover
  prefix from ShellMethod#prefix and use that if just "arg"
  is defined.
- Backport #575
- Fixes #577
 2022-11-26 15:09:25 +00:00
Janne Valkealahti
2cf712328c Fix next handling in ComponentFlow 
- This fixes a bug where returning null from a next()
  didn't stop a flow.
- Backport #510
- Fixes #513

(cherry picked from commit 7c4700b7b5)
 2022-08-22 16:30:52 +01:00
Janne Valkealahti
6e007fbf5f Split builtin command docs 
- Fixes #505
- Backport #504

(cherry picked from commit 57b9259701)
 2022-08-17 17:40:17 +01:00
Janne Valkealahti
690d1d2e62 Add commands as list in help templating 
- Add getNames method.
- Add docs for templating info and fields to help.
- Fixes #480
 2022-07-21 21:24:41 +01:00
Drevsh
2862cc855e Add default selection to MultiItemSelector 
- Added default selection to items
- Added correct styling for disabled but default selected item
- Added missing license header
- Added missing javadoc
- Added default selection to sample/doc code
 2022-07-20 08:17:24 +01:00
Leszek Jasek
0edc9ada38 Fix typos in using-shell-options-optional.adoc 2022-07-14 19:18:50 +03:00
Janne Valkealahti
932e9d5d75 Update docs 
- Completion docs
- Relates #433
 2022-07-07 08:09:23 +01:00
Janne Valkealahti
03a02a0615 Flatten docs structure 
- Essentially remove "Using Spring Shell" and move
  its content one level up.
- Fixes #433
 2022-07-06 09:36:36 +01:00
Janne Valkealahti
8fc3ff9c6d Update docs 
- Some new docs for theming.
- Relates #433
 2022-07-04 09:47:39 +01:00
Janne Valkealahti
a019934169 Update docs 
- Document option label
- Relates #433
 2022-06-14 21:25:01 +01:00
Janne Valkealahti
088c4267b5 Update docs 
- Polish getting started
- Relates #433
 2022-06-14 21:07:17 +01:00
Janne Valkealahti
189794b0ef Update docs 
- Remove and fix content with wrong links.
- Relates #433
 2022-06-14 20:01:52 +01:00
Janne Valkealahti
3891a8b375 Add support for exit codes 
- New configurations to CommandRegistration
- Re-using exit code concepts from boot
- Handling exit codes only in non-interactive mode
- Adding e2e commands and tests for better coverage
- Fixes #431
 2022-05-31 07:49:50 +01:00
Jay Bryant
2af4e86925 Editing pass 
for a bunch of new content to support the new version.
 2022-05-28 08:27:36 +01:00
Janne Valkealahti
bd9ab62013 Rework help command 
- Change help command output to get templated using
  model classes.
- Remove things around ParameterDescription as those are
  replaced with template classes.
- Fixes for native configs.
- For now availability and aliases are removed from
  help to get back in better form.
- Aliases has been partly introduced to structure.
- Fixes #422
 2022-05-26 07:45:35 +01:00
Janne Valkealahti
eed1d84653 Update docs 2022-05-18 09:44:26 +01:00
Janne Valkealahti
c7d3eb15b4 Expose CommandRegistration in CommandContext 
- Fixes #420
 2022-05-18 08:18:38 +01:00
Janne Valkealahti
0f655a03ce Add missing headers to snippets 2022-05-15 16:46:42 +01:00
Janne Valkealahti
ee21619885 Update docs 2022-05-15 16:29:23 +01:00
Janne Valkealahti
60e63f87ae Update docs 2022-05-14 17:08:09 +01:00
Janne Valkealahti
ab476345fa Update docs 2022-05-14 16:36:53 +01:00
Janne Valkealahti
3599182536 Update docs 2022-05-14 09:02:37 +01:00
Janne Valkealahti
751c9e213e Update docs 2022-05-13 17:28:32 +01:00
Janne Valkealahti
8477a5ac4c Update docs 
- Add docs for component flow
- Relates #383
 2022-05-11 15:36:10 +01:00
Janne Valkealahti
bed8457ff2 Update docs 
- Split some adoc files
- Shuffle to reorg structure
- Relates #383
 2022-05-11 10:18:11 +01:00
Janne Valkealahti
8a23518b84 Rework command subsystem 
- Focus of these changes are to introduce a new command system based on
  real registrations (new way) instead of continuously (old way) resolve
  methods and its parameters via reflection.
- There's a lot of changes as this resolution via reflection had its
  hooks almost everywhere and thus most changes are just refactorings.
- Order to understand real changes I'd start to look classes under
  `org.springframework.shell.command` package as it defines new registration,
  catalog and parser classes. Also samples contain new classes to demonstrate
  new functionality.
- Fixes #380
 2022-05-06 08:32:53 +01:00
Janne Valkealahti
942108e612 Update docs 
- Split adoc files
- Relates #383
 2022-04-23 08:36:10 +01:00
Janne Valkealahti
8920db699d Update component docs 
- Relates #361
 2022-02-24 09:25:38 +00:00
Janne Valkealahti
1593ee86d2 Update docs 
- Polish pom
- Version command
- Theming
- Templating
- Relates #354
 2022-02-03 09:51:13 +00:00
Janne Valkealahti
cde73ec2c0 Update docs 2022-01-21 09:28:22 +00:00
Janne Valkealahti
6c2e858534 Fix docs copyright year 2022-01-18 13:23:56 +00:00
Janne Valkealahti
d26f6d1a90 Update doc authors 2021-12-18 13:01:58 +00:00
Johnny Marnell
2b7a9b15e6 Clarify how to achieve varying arity in docs 
Add examples of how to achieve, with existing functionality, a varying amount of parameter arity (and favor this verbage over "infinite", which, though technically true, could be misleading for evoking neding a very large amount of a parameter, instead of the normal usecase of a few of any amount).
 2021-12-18 12:54:06 +00:00
Jay Bryant
012481ef63 Update document appearance 
Use Spring's standard styles for the ToC. Also added epub generation.
 2021-12-18 09:29:09 +00:00
Jay Bryant
7473c9ec5c Editing pass 
Edited for spelling, puncuation, grammar, usage, and corporate voice.
 2021-12-18 08:13:47 +00:00
Gao Liang
10fb9a8ed2 fix pom exclusions 2021-12-11 08:41:45 +00:00
Jay Bryant
eca0dd1572 Update doc appearance and link doc formats 
Updated the ToC, banner, highlighting, and CSS styles to the last Spring standard.
Linked the HTML output to the PDF output and vice-versa.
 2021-12-11 08:39:05 +00:00
onnadi-sa
296db93462 Fix typo 2019-10-02 12:02:13 +02:00
Spring Operator
23d99f45eb URL Cleanup 
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# HTTP URLs that Could Not Be Fixed
These URLs were unable to be fixed. Please review them to see if they can be manually resolved.

* http://jcommander.org/apidocs/ (200) with 1 occurrences could not be migrated:
   ([https](https://jcommander.org/apidocs/) result SSLHandshakeException).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* http://docs.spring.io/spring-framework/docs/current/javadoc-api/ with 1 occurrences migrated to:
  https://docs.spring.io/spring-framework/docs/current/javadoc-api/ ([https](https://docs.spring.io/spring-framework/docs/current/javadoc-api/) result 200).
* http://maven.apache.org/xsd/assembly-2.0.0.xsd with 1 occurrences migrated to:
  https://maven.apache.org/xsd/assembly-2.0.0.xsd ([https](https://maven.apache.org/xsd/assembly-2.0.0.xsd) result 200).
* http://maven.apache.org/xsd/maven-4.0.0.xsd with 12 occurrences migrated to:
  https://maven.apache.org/xsd/maven-4.0.0.xsd ([https](https://maven.apache.org/xsd/maven-4.0.0.xsd) result 200).
* http://repo.spring.io/libs-milestone-local with 2 occurrences migrated to:
  https://repo.spring.io/libs-milestone-local ([https](https://repo.spring.io/libs-milestone-local) result 302).
* http://repo.spring.io/libs-snapshot-local with 2 occurrences migrated to:
  https://repo.spring.io/libs-snapshot-local ([https](https://repo.spring.io/libs-snapshot-local) result 302).
* http://repo.spring.io/release with 1 occurrences migrated to:
  https://repo.spring.io/release ([https](https://repo.spring.io/release) result 302).

# Ignored
These URLs were intentionally ignored.

* http://maven.apache.org/ASSEMBLY/2.0.0 with 2 occurrences
* http://maven.apache.org/POM/4.0.0 with 24 occurrences
* http://www.w3.org/2001/XMLSchema-instance with 13 occurrences
 2019-03-26 11:55:46 +01:00
Spring Operator
7176450689 URL Cleanup 
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://beanvalidation.org/ with 1 occurrences migrated to:
  https://beanvalidation.org/ ([https](https://beanvalidation.org/) result 200).
* [ ] http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ with 1 occurrences migrated to:
  https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ ([https](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/) result 200).
* [ ] http://github.com/spring-projects/spring-shell with 1 occurrences migrated to:
  https://github.com/spring-projects/spring-shell ([https](https://github.com/spring-projects/spring-shell) result 200).
* [ ] http://start.spring.io with 2 occurrences migrated to:
  https://start.spring.io ([https](https://start.spring.io) result 200).
* [ ] http://www.java.com/en/download/help/error_hotspot.xml with 1 occurrences migrated to:
  https://www.java.com/en/download/help/error_hotspot.xml ([https](https://www.java.com/en/download/help/error_hotspot.xml) result 200).
* [ ] http://contributor-covenant.org with 1 occurrences migrated to:
  https://contributor-covenant.org ([https](https://contributor-covenant.org) result 301).
* [ ] http://contributor-covenant.org/version/1/3/0/ with 1 occurrences migrated to:
  https://contributor-covenant.org/version/1/3/0/ ([https](https://contributor-covenant.org/version/1/3/0/) result 301).
 2019-03-26 11:48:55 +01:00
Florian Waibel
793eaa6fe7 Fix method annotation in some reference documentation snippets 
Somehow `@ShellCommand` found its way into the snippets. This commit
replaces it with the correct annotation `@ShellMethod`.
 2018-01-17 21:31:07 +01:00
Eric Bottard
f90edd42c4 Make ResultHandlers configuration more explicit 
Handle exit as a dedicated case (prevents eg 'exit' commands in scripts to make script quit)
Add an example of custom ApplicationRunner

Fixes #187
Fixes #183

Decouple ApplicationRunners

Make ThrowableResultHandler behave differently in non-interactive mode
 2018-01-15 15:59:01 +01:00
Eric Bottard
2ef0610f81 Added an example of full class dynamic availability toggle 
Fixes #175
 2017-11-06 15:12:46 +01:00
Eric Bottard
7d50c0813f Qualify the Spring Shell provided ConversionService 
Fixes #173
 2017-11-06 14:52:50 +01:00