From cc0a842a69c74f32f3d77fe431ec292f17d4e871 Mon Sep 17 00:00:00 2001
From: Petri-Johan Last <petri.last@sourcegraph.com>
Date: Mon, 31 Oct 2022 12:14:42 +0200
Subject: [PATCH] Re-enable prettier format checking. Disable with flag
 (#43548)

---
 .../web/src/components/time/Timestamp.test.tsx | 11 ++++++++++-
 .../extensions/components/ActionItemsBar.tsx   |  4 +---
 .../repo/blob/actions/ToggleHistoryPanel.tsx   |  6 +-----
 .../web/src/search/home/LoggedOutHomepage.tsx  |  7 ++-----
 client/web/src/tour/data/index.tsx             |  2 +-
 .../src/components/Tooltip/Tooltip.tsx         |  4 ++--
 dev/scaletesting/README.md                     |  2 +-
 dev/scaletesting/bulkreposettings/README.md    | 10 +++++-----
 dev/sg/internal/check/runner.go                |  2 +-
 dev/sg/linters/linters.go                      | 10 ++++++++--
 dev/sg/linters/prettier.go                     |  3 +--
 dev/sg/sg_lint.go                              | 15 ++++++++++++++-
 doc/dev/background-information/sg/reference.md | 10 ++++++++++
 enterprise/dev/ci/internal/ci/operations.go    | 18 +++++++++++++++++-
 14 files changed, 74 insertions(+), 30 deletions(-)

diff --git a/client/web/src/components/time/Timestamp.test.tsx b/client/web/src/components/time/Timestamp.test.tsx
index f026026580f..81393610e75 100644
--- a/client/web/src/components/time/Timestamp.test.tsx
+++ b/client/web/src/components/time/Timestamp.test.tsx
@@ -10,5 +10,14 @@ describe('Timestamp', () => {
 
     test('noAbout', () => expect(render(<Timestamp date="2006-01-02" noAbout={true} />).asFragment()).toMatchSnapshot())
 
-    test('absolute time with formatting', () => expect(render(<Timestamp date="2006-01-02T01:02:00Z" timestampFormat={TimestampFormat.FULL_TIME} preferAbsolute={true} />).asFragment()).toMatchSnapshot())
+    test('absolute time with formatting', () =>
+        expect(
+            render(
+                <Timestamp
+                    date="2006-01-02T01:02:00Z"
+                    timestampFormat={TimestampFormat.FULL_TIME}
+                    preferAbsolute={true}
+                />
+            ).asFragment()
+        ).toMatchSnapshot())
 })
diff --git a/client/web/src/extensions/components/ActionItemsBar.tsx b/client/web/src/extensions/components/ActionItemsBar.tsx
index 7b6f08704aa..1f244e2d4ca 100644
--- a/client/web/src/extensions/components/ActionItemsBar.tsx
+++ b/client/web/src/extensions/components/ActionItemsBar.tsx
@@ -414,9 +414,7 @@ export const ActionItemsToggle: React.FunctionComponent<React.PropsWithChildren<
                                 <Icon
                                     aria-hidden={true}
                                     svgPath={
-                                        window.context.enableLegacyExtensions
-                                            ? mdiPuzzleOutline
-                                            : mdiChevronDoubleDown
+                                        window.context.enableLegacyExtensions ? mdiPuzzleOutline : mdiChevronDoubleDown
                                     }
                                 />
                             )}
diff --git a/client/web/src/repo/blob/actions/ToggleHistoryPanel.tsx b/client/web/src/repo/blob/actions/ToggleHistoryPanel.tsx
index 2e9429ba5db..487f55cfb57 100644
--- a/client/web/src/repo/blob/actions/ToggleHistoryPanel.tsx
+++ b/client/web/src/repo/blob/actions/ToggleHistoryPanel.tsx
@@ -96,11 +96,7 @@ export class ToggleHistoryPanel extends React.PureComponent<
         }
         return (
             <Tooltip content={`${visible ? 'Hide' : 'Show'} history (Alt+H/Opt+H)`}>
-                <RepoHeaderActionButtonLink
-                    aria-label={visible ? 'Hide' : 'Show'}
-                    file={false}
-                    onSelect={this.onClick}
-                >
+                <RepoHeaderActionButtonLink aria-label={visible ? 'Hide' : 'Show'} file={false} onSelect={this.onClick}>
                     <Icon aria-hidden={true} svgPath={mdiHistory} />
                 </RepoHeaderActionButtonLink>
             </Tooltip>
diff --git a/client/web/src/search/home/LoggedOutHomepage.tsx b/client/web/src/search/home/LoggedOutHomepage.tsx
index 99603863d74..5fa760b9b1a 100644
--- a/client/web/src/search/home/LoggedOutHomepage.tsx
+++ b/client/web/src/search/home/LoggedOutHomepage.tsx
@@ -30,13 +30,10 @@ export const LoggedOutHomepage: React.FunctionComponent<React.PropsWithChildren<
                     {...props}
                 />
             </div>
-            
+
             <div className="d-flex align-items-center justify-content-lg-center my-5">
                 <H4 className={classNames('mr-2 mb-0 pr-2', styles.proTipTitle)}>Pro Tip</H4>
-                <Link
-                    to="https://signup.sourcegraph.com/"
-                    onClick={() => eventLogger.log('ClickedOnCloudCTA')}
-                >
+                <Link to="https://signup.sourcegraph.com/" onClick={() => eventLogger.log('ClickedOnCloudCTA')}>
                     Use Sourcegraph to search across your team's code.
                 </Link>
             </div>
diff --git a/client/web/src/tour/data/index.tsx b/client/web/src/tour/data/index.tsx
index dbb0884b16b..133f2ce6d38 100644
--- a/client/web/src/tour/data/index.tsx
+++ b/client/web/src/tour/data/index.tsx
@@ -198,7 +198,7 @@ export const visitorsTasks: TourTaskType[] = [
                 },
                 // This is done to mimic user creating an account, and signed in there is a different tour
                 completeAfterEvents: ['non-existing-event'],
-            }
+            },
         ],
     },
 ]
diff --git a/client/wildcard/src/components/Tooltip/Tooltip.tsx b/client/wildcard/src/components/Tooltip/Tooltip.tsx
index 293fd93e46c..40a5a92b066 100644
--- a/client/wildcard/src/components/Tooltip/Tooltip.tsx
+++ b/client/wildcard/src/components/Tooltip/Tooltip.tsx
@@ -112,7 +112,7 @@ export const Tooltip: FC<TooltipProps> = props => {
         }
     }
 
-    const isOpen =  useDebounce(open, 100)
+    const isOpen = useDebounce(open, 100)
 
     return (
         <>
@@ -120,7 +120,7 @@ export const Tooltip: FC<TooltipProps> = props => {
                 {children}
             </TooltipTarget>
 
-            {content && target && isOpen &&(
+            {content && target && isOpen && (
                 <>
                     <PopoverContent
                         role="tooltip"
diff --git a/dev/scaletesting/README.md b/dev/scaletesting/README.md
index c9ecbc9bbf2..d5c7954798b 100644
--- a/dev/scaletesting/README.md
+++ b/dev/scaletesting/README.md
@@ -4,6 +4,6 @@ This package is a collection of CLI tools to perform various operations in batch
 
 - `bulkrepocreate`: generates blank repositories in large numbers on a codehost within an organization.
 - `bulkreposettings`: updates the settings of all repositories of an organization all at once.
-- `codehostcopy`: copies repositories from one codehost to another. 
+- `codehostcopy`: copies repositories from one codehost to another.
 
 Please see the individual READMEs for how to use these tools.
diff --git a/dev/scaletesting/bulkreposettings/README.md b/dev/scaletesting/bulkreposettings/README.md
index 436069594a9..30ba88cca93 100644
--- a/dev/scaletesting/bulkreposettings/README.md
+++ b/dev/scaletesting/bulkreposettings/README.md
@@ -1,8 +1,8 @@
 # Bulkreposettings
 
-A CLI tool to update an organization repositories settings in batch. 
+A CLI tool to update an organization repositories settings in batch.
 
-Supported operations: 
+Supported operations:
 
 - set visibility to _private_.
 
@@ -10,13 +10,13 @@ Supported codehosts:
 
 - GitHub and GitHub enterprise.
 
-## Usage 
+## Usage
 
 `go run ./dev/scaletesting/bulkreposettings [flags...]`
 
-Flags: 
+Flags:
 
-- Authenticating: 
+- Authenticating:
   - `github.token`: GHE Token to create the repositories (required).
   - `github.url`: Base URL to the GHE instance (ex: `https://ghe.sgdev.org`) (required).
   - `github.org`: Existing organization to create the repositories in (required).
diff --git a/dev/sg/internal/check/runner.go b/dev/sg/internal/check/runner.go
index ba8ee474097..1d7807d056b 100644
--- a/dev/sg/internal/check/runner.go
+++ b/dev/sg/internal/check/runner.go
@@ -430,7 +430,7 @@ func (r *Runner[Args]) runAllCategoryChecks(ctx context.Context, args Args) *run
 					}
 
 					// Write the terminal summary to an indented block
-					var style = output.CombineStyles(output.StyleBold, output.StyleFailure)
+					style := output.CombineStyles(output.StyleBold, output.StyleFailure)
 					block := r.Output.Block(output.Linef(output.EmojiFailure, style, check.Name))
 					block.Writef("%s\n", check.cachedCheckErr)
 					if check.cachedCheckOutput != "" {
diff --git a/dev/sg/linters/linters.go b/dev/sg/linters/linters.go
index de7e6478488..a9ed4270fc2 100644
--- a/dev/sg/linters/linters.go
+++ b/dev/sg/linters/linters.go
@@ -52,7 +52,6 @@ var Targets = []Target{
 		Description: "Documentation checks",
 		Checks: []*linter{
 			runScript("Docsite lint", "dev/docsite.sh check"),
-			prettier,
 		},
 	},
 	{
@@ -71,7 +70,6 @@ var Targets = []Target{
 			inlineTemplates,
 			runScript("Yarn duplicate", "dev/check/yarn-deduplicate.sh"),
 			checkUnversionedDocsLinks(),
-			prettier,
 		},
 	},
 	{
@@ -93,6 +91,14 @@ var Targets = []Target{
 	},
 }
 
+var FormattingTarget = Target{
+	Name:        "format",
+	Description: "Check client code and docs for formatting errors",
+	Checks: []*linter{
+		prettier,
+	},
+}
+
 // runScript creates check that runs the given script from the root of sourcegraph/sourcegraph.
 func runScript(name string, script string) *linter {
 	return &linter{
diff --git a/dev/sg/linters/prettier.go b/dev/sg/linters/prettier.go
index eeb9365381e..0300a655d1b 100644
--- a/dev/sg/linters/prettier.go
+++ b/dev/sg/linters/prettier.go
@@ -12,8 +12,7 @@ import (
 )
 
 var prettier = &linter{
-	Name:    "Prettier",
-	Enabled: disabled("Temporarily disabled to figure out unknown failure"),
+	Name: "Prettier",
 	// TODO unfortunate that we have to use 'dev/ci/yarn-run.sh'
 	Check: func(ctx context.Context, out *std.Output, args *repo.State) error {
 		return root.Run(run.Cmd(ctx, "dev/ci/yarn-run.sh format:check")).
diff --git a/dev/sg/sg_lint.go b/dev/sg/sg_lint.go
index 65bb009bf9e..0dce2b045cc 100644
--- a/dev/sg/sg_lint.go
+++ b/dev/sg/sg_lint.go
@@ -31,6 +31,13 @@ var lintFailFast = &cli.BoolFlag{
 	Value:   true,
 }
 
+var lintNoFormatCheck = &cli.BoolFlag{
+	Name:    "no-format-check",
+	Aliases: []string{"nfc"},
+	Usage:   "Don't check file formatting",
+	Value:   false,
+}
+
 var lintCommand = &cli.Command{
 	Name:        "lint",
 	ArgsUsage:   "[targets...]",
@@ -57,6 +64,7 @@ sg lint --help
 		generateAnnotations,
 		lintFix,
 		lintFailFast,
+		lintNoFormatCheck,
 	},
 	Before: func(cmd *cli.Context) error {
 		// If more than 1 target is requested, hijack subcommands by setting it to nil
@@ -97,6 +105,11 @@ sg lint --help
 			return errors.Wrap(err, "repo.GetState")
 		}
 
+		if !lintNoFormatCheck.Get(cmd) {
+			lintTargets = append(lintTargets, linters.FormattingTarget)
+			targets = append(targets, linters.FormattingTarget.Name)
+		}
+
 		runner := linters.NewRunner(std.Out, generateAnnotations.Get(cmd), lintTargets...)
 		if cmd.Bool("fix") {
 			std.Out.WriteNoticef("Fixing checks from targets: %s", strings.Join(targets, ", "))
@@ -106,7 +119,7 @@ sg lint --help
 		std.Out.WriteNoticef("Running checks from targets: %s", strings.Join(targets, ", "))
 		return runner.Check(cmd.Context, repoState)
 	},
-	Subcommands: lintTargets(linters.Targets).Commands(),
+	Subcommands: lintTargets(append(linters.Targets, linters.FormattingTarget)).Commands(),
 }
 
 type lintTargets []linters.Target
diff --git a/doc/dev/background-information/sg/reference.md b/doc/dev/background-information/sg/reference.md
index b36666bd259..405f32d327d 100644
--- a/doc/dev/background-information/sg/reference.md
+++ b/doc/dev/background-information/sg/reference.md
@@ -386,6 +386,7 @@ Flags:
 * `--fail-fast, --ff`: Exit immediately if an issue is encountered (not available with '-fix')
 * `--feedback`: provide feedback about this command by opening up a GitHub discussion
 * `--fix, -f`: Try to fix any lint issues
+* `--no-format-check, --nfc`: Don't check file formatting
 
 ### sg lint urls
 
@@ -446,6 +447,15 @@ Flags:
 Check shell code for linting errors, formatting, etc.
 
 
+Flags:
+
+* `--feedback`: provide feedback about this command by opening up a GitHub discussion
+
+### sg lint format
+
+Check client code and docs for formatting errors.
+
+
 Flags:
 
 * `--feedback`: provide feedback about this command by opening up a GitHub discussion
diff --git a/enterprise/dev/ci/internal/ci/operations.go b/enterprise/dev/ci/internal/ci/operations.go
index ab43ee480be..06b5690cd3b 100644
--- a/enterprise/dev/ci/internal/ci/operations.go
+++ b/enterprise/dev/ci/internal/ci/operations.go
@@ -109,7 +109,23 @@ func addSgLints(targets []string) func(pipeline *bk.Pipeline) {
 		cmd = cmd + "-v "
 	}
 
-	cmd = cmd + "lint -annotations -fail-fast=false " + strings.Join(targets, " ")
+	var (
+		branch = os.Getenv("BUILDKITE_BRANCH")
+		tag    = os.Getenv("BUILDKITE_TAG")
+		// evaluates what type of pipeline run this is
+		runType = runtype.Compute(tag, branch, map[string]string{
+			"BEXT_NIGHTLY":    os.Getenv("BEXT_NIGHTLY"),
+			"RELEASE_NIGHTLY": os.Getenv("RELEASE_NIGHTLY"),
+			"VSCE_NIGHTLY":    os.Getenv("VSCE_NIGHTLY"),
+		})
+	)
+
+	formatCheck := ""
+	if runType.Is(runtype.MainBranch) || runType.Is(runtype.MainDryRun) {
+		formatCheck = "--no-format-check "
+	}
+
+	cmd = cmd + "lint -annotations -fail-fast=false " + formatCheck + strings.Join(targets, " ")
 
 	return func(pipeline *bk.Pipeline) {
 		pipeline.AddStep(":pineapple::lint-roller: Run sg lint",