Merge pull request #2888 from Ma3oBblu/gist-view-raw-fix

remove gist description from single file raw view (#2886)

pkg/cmd/gist/view/view.go

@@ -49,9 +49,9 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
 		},
 	}
 
-	cmd.Flags().BoolVarP(&opts.Raw, "raw", "r", false, "do not try and render markdown")
-	cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "open gist in browser")
-	cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "display a single file of the gist")
+	cmd.Flags().BoolVarP(&opts.Raw, "raw", "r", false, "Print raw instead of rendered gist contents")
+	cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open gist in the browser")
+	cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "Display a single file from the gist")
 
 	return cmd
 }
@@ -89,48 +89,64 @@ func viewRun(opts *ViewOptions) error {
 		return err
 	}
 
-	cs := opts.IO.ColorScheme()
-	if gist.Description != "" {
-		fmt.Fprintf(opts.IO.Out, "%s\n", cs.Bold(gist.Description))
+	theme := opts.IO.DetectTerminalTheme()
+	markdownStyle := markdown.GetStyle(theme)
+	if err := opts.IO.StartPager(); err != nil {
+		fmt.Fprintf(opts.IO.ErrOut, "starting pager failed: %v\n", err)
+	}
+	defer opts.IO.StopPager()
+
+	render := func(gf *shared.GistFile) error {
+		if strings.Contains(gf.Type, "markdown") && !opts.Raw {
+			rendered, err := markdown.Render(gf.Content, markdownStyle, "")
+			if err != nil {
+				return err
+			}
+			_, err = fmt.Fprint(opts.IO.Out, rendered)
+			return err
+		}
+
+		if _, err := fmt.Fprint(opts.IO.Out, gf.Content); err != nil {
+			return err
+		}
+		if !strings.HasSuffix(gf.Content, "\n") {
+			_, err := fmt.Fprint(opts.IO.Out, "\n")
+			return err
+		}
+		return nil
 	}
 
 	if opts.Filename != "" {
 		gistFile, ok := gist.Files[opts.Filename]
 		if !ok {
-			return fmt.Errorf("gist has no such file %q", opts.Filename)
+			return fmt.Errorf("gist has no such file: %q", opts.Filename)
 		}
+		return render(gistFile)
+	}
 
-		gist.Files = map[string]*shared.GistFile{
-			opts.Filename: gistFile,
-		}
+	cs := opts.IO.ColorScheme()
+
+	if gist.Description != "" {
+		fmt.Fprintf(opts.IO.Out, "%s\n\n", cs.Bold(gist.Description))
 	}
 
 	showFilenames := len(gist.Files) > 1
-
-	outs := []string{} // to ensure consistent ordering
-
-	for filename, gistFile := range gist.Files {
-		out := ""
-		if showFilenames {
-			out += fmt.Sprintf("%s\n\n", cs.Gray(filename))
-		}
-		content := gistFile.Content
-		if strings.Contains(gistFile.Type, "markdown") && !opts.Raw {
-			style := markdown.GetStyle(opts.IO.DetectTerminalTheme())
-			rendered, err := markdown.Render(gistFile.Content, style, "")
-			if err == nil {
-				content = rendered
-			}
-		}
-		out += fmt.Sprintf("%s\n\n", content)
-
-		outs = append(outs, out)
+	filenames := make([]string, 0, len(gist.Files))
+	for fn := range gist.Files {
+		filenames = append(filenames, fn)
 	}
+	sort.Strings(filenames)
 
-	sort.Strings(outs)
-
-	for _, out := range outs {
-		fmt.Fprint(opts.IO.Out, out)
+	for i, fn := range filenames {
+		if showFilenames {
+			fmt.Fprintf(opts.IO.Out, "%s\n\n", cs.Gray(fn))
+		}
+		if err := render(gist.Files[fn]); err != nil {
+			return err
+		}
+		if i < len(filenames)-1 {
+			fmt.Fprint(opts.IO.Out, "\n")
+		}
 	}
 
 	return nil

pkg/cmd/gist/view/view_test.go

@@ -109,7 +109,7 @@ func Test_viewRun(t *testing.T) {
 					},
 				},
 			},
-			wantOut: "bwhiizzzbwhuiiizzzz\n\n",
+			wantOut: "bwhiizzzbwhuiiizzzz\n",
 		},
 		{
 			name: "filename selected",
@@ -129,7 +129,28 @@ func Test_viewRun(t *testing.T) {
 					},
 				},
 			},
-			wantOut: "bwhiizzzbwhuiiizzzz\n\n",
+			wantOut: "bwhiizzzbwhuiiizzzz\n",
+		},
+		{
+			name: "filename selected, raw",
+			opts: &ViewOptions{
+				Selector: "1234",
+				Filename: "cicada.txt",
+				Raw:      true,
+			},
+			gist: &shared.Gist{
+				Files: map[string]*shared.GistFile{
+					"cicada.txt": {
+						Content: "bwhiizzzbwhuiiizzzz",
+						Type:    "text/plain",
+					},
+					"foo.md": {
+						Content: "# foo",
+						Type:    "application/markdown",
+					},
+				},
+			},
+			wantOut: "bwhiizzzbwhuiiizzzz\n",
 		},
 		{
 			name: "multiple files, no description",
@@ -148,7 +169,26 @@ func Test_viewRun(t *testing.T) {
 					},
 				},
 			},
-			wantOut: "cicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n\n  # foo                                                                       \n\n\n\n",
+			wantOut: "cicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n\n  # foo                                                                       \n\n",
+		},
+		{
+			name: "multiple files, trailing newlines",
+			opts: &ViewOptions{
+				Selector: "1234",
+			},
+			gist: &shared.Gist{
+				Files: map[string]*shared.GistFile{
+					"cicada.txt": {
+						Content: "bwhiizzzbwhuiiizzzz\n",
+						Type:    "text/plain",
+					},
+					"foo.txt": {
+						Content: "bar\n",
+						Type:    "text/plain",
+					},
+				},
+			},
+			wantOut: "cicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.txt\n\nbar\n",
 		},
 		{
 			name: "multiple files, description",
@@ -168,10 +208,10 @@ func Test_viewRun(t *testing.T) {
 					},
 				},
 			},
-			wantOut: "some files\ncicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n\n                                                                              \n  • foo                                                                       \n\n\n\n",
+			wantOut: "some files\n\ncicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n\n                                                                              \n  • foo                                                                       \n\n",
 		},
 		{
-			name: "raw",
+			name: "multiple files, raw",
 			opts: &ViewOptions{
 				Selector: "1234",
 				Raw:      true,
@@ -189,7 +229,7 @@ func Test_viewRun(t *testing.T) {
 					},
 				},
 			},
-			wantOut: "some files\ncicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n- foo\n\n",
+			wantOut: "some files\n\ncicada.txt\n\nbwhiizzzbwhuiiizzzz\n\nfoo.md\n\n- foo\n",
 		},
 	}