outline: Make reading source from stdin uniform across operating systems #760
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Let's say that there is an IDE plugin that calls `gingko outline`. It will
likely pipe the document contents via stdin. And the IDE will likely run on
multiple operating systems. With the `-` alias for stdin, the plugin can use
the same ginkgo command on every operating system. This alias is common, but
not ubiquituous. Users can continue to use operating system-specific filenames
for stdin.
Example:
```shell
> cat outline/_testdata/normal_test.go | ./ginkgo outline -format=indent -
```
```shell
Name,Text,Start,End,Spec,Focused,Pending
Describe,NormalFixture,116,605,false,false,false
Describe,normal,152,244,false,false,false
It,normal,182,240,true,false,false
By,step 1,207,219,false,false,false
By,step 2,223,235,false,false,false
Context,normal,247,307,false,false,false
It,normal,276,303,true,false,false
When,normal,310,367,false,false,false
It,normal,336,363,true,false,false
It,normal,370,396,true,false,false
Specify,normal,399,430,true,false,false
Measure,normal,433,480,true,false,false
DescribeTable,normal,483,541,false,false,false
Entry,normal,522,537,true,false,false
DescribeTable,normal,544,602,false,false,false
Entry,normal,583,598,true,false,false
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Let's say that there is an IDE plugin that calls
gingko outline. It willlikely pipe the document contents via stdin. And the IDE will likely run onmultiple operating systems. With the-alias for stdin, the plugin can usethe same ginkgo command on every operating system. This alias is common, butnot ubiquituous. Users can continue to use operating system-specific filenamesfor stdin.Example:
Name,Text,Start,End,Spec,Focused,Pending Describe,NormalFixture,116,605,false,false,false Describe,normal,152,244,false,false,false It,normal,182,240,true,false,false By,step 1,207,219,false,false,false By,step 2,223,235,false,false,false Context,normal,247,307,false,false,false It,normal,276,303,true,false,false When,normal,310,367,false,false,false It,normal,336,363,true,false,false It,normal,370,396,true,false,false Specify,normal,399,430,true,false,false Measure,normal,433,480,true,false,false DescribeTable,normal,483,541,false,false,false Entry,normal,522,537,true,false,false DescribeTable,normal,544,602,false,false,false Entry,normal,583,598,true,false,false