deprecate cd, up; add find-in (#4883)

* deprecate `cd`, `up`, hide `reset-root`, add `find-in`, hides unimplemented `update.builtins`
Co-authored-by: Chris Penner <christopher.penner@gmail.com>

Author: aryairani

parser-typechecker/src/Unison/Codebase/Path.hs

@@ -24,6 +24,7 @@ module Unison.Codebase.Path
     prefix,
     unprefix,
     prefixName,
+    prefixName2,
     unprefixName,
     HQSplit,
     Split,
@@ -192,6 +193,11 @@ prefix (Absolute (Path prefix)) = \case
   AbsolutePath' abs -> unabsolute abs
   RelativePath' rel -> Path $ prefix <> toSeq (unrelative rel)
 
+prefix2 :: Path -> Path' -> Path
+prefix2 (Path prefix) = \case
+  AbsolutePath' abs -> unabsolute abs
+  RelativePath' rel -> Path $ prefix <> toSeq (unrelative rel)
+
 -- | Finds the longest shared path prefix of two paths.
 -- Returns (shared prefix, path to first location from shared prefix, path to second location from shared prefix)
 --
@@ -273,6 +279,9 @@ unprefixName prefix = toName . unprefix prefix . fromName'
 prefixName :: Absolute -> Name -> Name
 prefixName p n = fromMaybe n . toName . prefix p . fromName' $ n
 
+prefixName2 :: Path -> Name -> Name
+prefixName2 p n = fromMaybe n . toName . prefix2 p . fromName' $ n
+
 singleton :: NameSegment -> Path
 singleton n = fromList [n]
 

scripts/check.sh

@@ -6,4 +6,4 @@ true \
   && stack exec transcripts \
   && stack exec unison transcript unison-src/transcripts-round-trip/main.md \
   && stack exec unison transcript unison-src/transcripts-manual/rewrites.md \
-  && stack exec integration-tests
+  && stack exec cli-integration-tests

unison-cli/src/Unison/Codebase/Editor/HandleInput.hs

@@ -1429,24 +1429,28 @@ handleFindI ::
   Cli ()
 handleFindI isVerbose fscope ws input = do
   Cli.Env {codebase} <- ask
-  currentBranch0 <- Cli.getCurrentBranch0
-  (pped, names) <- case fscope of
-    FindLocal -> do
-      let names = Branch.toNames (Branch.withoutLib currentBranch0)
+  (pped, names, searchRoot, branch0) <- case fscope of
+    FindLocal p -> do
+      searchRoot <- Cli.resolvePath p
+      branch0 <- Cli.getBranch0At searchRoot
+      let names = Branch.toNames (Branch.withoutLib branch0)
       -- Don't exclude anything from the pretty printer, since the type signatures we print for
       -- results may contain things in lib.
       pped <- Cli.currentPrettyPrintEnvDecl
-      pure (pped, names)
-    FindLocalAndDeps -> do
-      let names = Branch.toNames (Branch.withoutTransitiveLibs currentBranch0)
+      pure (pped, names, Just p, branch0)
+    FindLocalAndDeps p -> do
+      searchRoot <- Cli.resolvePath p
+      branch0 <- Cli.getBranch0At searchRoot
+      let names = Branch.toNames (Branch.withoutTransitiveLibs branch0)
       -- Don't exclude anything from the pretty printer, since the type signatures we print for
       -- results may contain things in lib.
       pped <- Cli.currentPrettyPrintEnvDecl
-      pure (pped, names)
+      pure (pped, names, Just p, branch0)
     FindGlobal -> do
       globalNames <- Names.makeAbsolute . Branch.toNames <$> Cli.getRootBranch0
       pped <- Cli.prettyPrintEnvDeclFromNames globalNames
-      pure (pped, globalNames)
+      currentBranch0 <- Cli.getCurrentBranch0
+      pure (pped, globalNames, Nothing, currentBranch0)
   let suffixifiedPPE = PPED.suffixifiedPPE pped
   let getResults :: Names -> Cli [SearchResult]
       getResults names =
@@ -1455,7 +1459,7 @@ handleFindI isVerbose fscope ws input = do
           -- type query
           ":" : ws -> do
             typ <- parseSearchType (show input) (unwords ws)
-            let keepNamed = Set.intersection (Branch.deepReferents currentBranch0)
+            let keepNamed = Set.intersection (Branch.deepReferents branch0)
             (noExactTypeMatches, matches) <- do
               Cli.runTransaction do
                 matches <- keepNamed <$> Codebase.termsOfType codebase typ
@@ -1481,16 +1485,16 @@ handleFindI isVerbose fscope ws input = do
                     (mapMaybe (HQ.parseTextWith anythingBeforeHash . Text.pack) qs)
             pure $ uniqueBy SR.toReferent srs
   let respondResults results = do
-        Cli.setNumberedArgs $ fmap searchResultToHQString results
+        Cli.setNumberedArgs $ fmap (searchResultToHQString searchRoot) results
         results' <- Cli.runTransaction (Backend.loadSearchResults codebase results)
         Cli.respond $ ListOfDefinitions fscope suffixifiedPPE isVerbose results'
   results <- getResults names
   case (results, fscope) of
-    ([], FindLocal) -> do
+    ([], FindLocal {}) -> do
       Cli.respond FindNoLocalMatches
       -- We've already searched everything else, so now we search JUST the
       -- names in lib.
-      let mayOnlyLibBranch = currentBranch0 & Branch.children %%~ \cs -> Map.singleton NameSegment.libSegment <$> Map.lookup NameSegment.libSegment cs
+      let mayOnlyLibBranch = branch0 & Branch.children %%~ \cs -> Map.singleton NameSegment.libSegment <$> Map.lookup NameSegment.libSegment cs
       case mayOnlyLibBranch of
         Nothing -> respondResults []
         Just onlyLibBranch -> do
@@ -1804,11 +1808,14 @@ confirmedCommand i = do
   pure $ Just i == (loopState ^. #lastInput)
 
 -- | restores the full hash to these search results, for _numberedArgs purposes
-searchResultToHQString :: SearchResult -> String
-searchResultToHQString = \case
-  SR.Tm' n r _ -> Text.unpack $ HQ.toText $ HQ.requalify n r
-  SR.Tp' n r _ -> Text.unpack $ HQ.toText $ HQ.requalify n (Referent.Ref r)
+searchResultToHQString :: Maybe Path -> SearchResult -> String
+searchResultToHQString oprefix = \case
+  SR.Tm' n r _ -> Text.unpack $ HQ.toText $ HQ.requalify (addPrefix <$> n) r
+  SR.Tp' n r _ -> Text.unpack $ HQ.toText $ HQ.requalify (addPrefix <$> n) (Referent.Ref r)
   _ -> error "impossible match failure"
+  where
+    addPrefix :: Name -> Name
+    addPrefix = maybe id Path.prefixName2 oprefix
 
 -- return `name` and `name.<everything>...`
 _searchBranchPrefix :: Branch m -> Name -> [SearchResult]

unison-cli/src/Unison/Codebase/Editor/Input.hs

@@ -35,7 +35,7 @@ import Data.These (These)
 import U.Codebase.HashTags (CausalHash)
 import Unison.Codebase.Branch.Merge qualified as Branch
 import Unison.Codebase.Editor.RemoteRepo (ReadRemoteNamespace, WriteGitRepo, WriteRemoteNamespace)
-import Unison.Codebase.Path (Path')
+import Unison.Codebase.Path (Path, Path')
 import Unison.Codebase.Path qualified as Path
 import Unison.Codebase.Path.Parse qualified as Path
 import Unison.Codebase.PushBehavior (PushBehavior)
@@ -313,8 +313,8 @@ data OutputLocation
   deriving (Eq, Show)
 
 data FindScope
-  = FindLocal
-  | FindLocalAndDeps
+  = FindLocal Path
+  | FindLocalAndDeps Path
   | FindGlobal
   deriving stock (Eq, Show)
 

unison-cli/src/Unison/CommandLine/InputPatterns.hs

@@ -124,7 +124,7 @@ updateBuiltins =
   InputPattern
     "builtins.update"
     []
-    I.Visible
+    I.Hidden
     []
     ( "Adds all the builtins that are missing from this namespace, "
         <> "and deprecate the ones that don't exist in this version of Unison."
@@ -531,7 +531,7 @@ sfind :: InputPattern
 sfind =
   InputPattern "rewrite.find" ["sfind"] I.Visible [("rewrite-rule definition", Required, definitionQueryArg)] msg parse
   where
-    parse [q] = Input.StructuredFindI Input.FindLocal <$> parseHashQualifiedName q
+    parse [q] = Input.StructuredFindI (Input.FindLocal Path.empty) <$> parseHashQualifiedName q
     parse _ = Left "expected exactly one argument"
     msg =
       P.lines
@@ -589,40 +589,76 @@ sfindReplace =
         ]
 
 find :: InputPattern
-find = find' "find" Input.FindLocal
+find = find' "find" (Input.FindLocal Path.empty)
 
 findAll :: InputPattern
-findAll = find' "find.all" Input.FindLocalAndDeps
+findAll = find' "find.all" (Input.FindLocalAndDeps Path.empty)
 
 findGlobal :: InputPattern
 findGlobal = find' "find.global" Input.FindGlobal
 
+findIn, findInAll :: InputPattern
+findIn = findIn' "find-in" Input.FindLocal
+findInAll = findIn' "find-in.all" Input.FindLocalAndDeps
+
+findIn' :: String -> (Path.Path -> Input.FindScope) -> InputPattern
+findIn' cmd mkfscope =
+  InputPattern
+    cmd
+    []
+    I.Visible
+    [("namespace", Required, namespaceArg), ("query", ZeroPlus, exactDefinitionArg)]
+    findHelp
+    \case
+      p : args -> first P.text do
+        p <- Path.parsePath p
+        pure (Input.FindI False (mkfscope p) args)
+      _ -> Left findHelp
+
+findHelp :: P.Pretty CT.ColorText
+findHelp =
+  ( P.wrapColumn2
+      [ ("`find`", "lists all definitions in the current namespace."),
+        ( "`find foo`",
+          "lists all definitions with a name similar to 'foo' in the current "
+            <> "namespace (excluding those under 'lib')."
+        ),
+        ( "`find foo bar`",
+          "lists all definitions with a name similar to 'foo' or 'bar' in the "
+            <> "current namespace (excluding those under 'lib')."
+        ),
+        ( "`find-in namespace`",
+          "lists all definitions in the specified subnamespace."
+        ),
+        ( "`find-in namespace foo bar`",
+          "lists all definitions with a name similar to 'foo' or 'bar' in the "
+            <> "specified subnamespace."
+        ),
+        ( "find.all foo",
+          "lists all definitions with a name similar to 'foo' in the current "
+            <> "namespace (including one level of 'lib')."
+        ),
+        ( "`find-in.all namespace`",
+          "lists all definitions in the specified subnamespace (including one level of its 'lib')."
+        ),
+        ( "`find-in.all namespace foo bar`",
+          "lists all definitions with a name similar to 'foo' or 'bar' in the "
+            <> "specified subnamespace (including one level of its 'lib')."
+        ),
+        ( "find.global foo",
+          "lists all definitions with a name similar to 'foo' in any namespace"
+        )
+      ]
+  )
+
 find' :: String -> Input.FindScope -> InputPattern
 find' cmd fscope =
   InputPattern
     cmd
     []
     I.Visible
     [("query", ZeroPlus, exactDefinitionArg)]
-    ( P.wrapColumn2
-        [ ("`find`", "lists all definitions in the current namespace."),
-          ( "`find foo`",
-            "lists all definitions with a name similar to 'foo' in the current "
-              <> "namespace (excluding those under 'lib')."
-          ),
-          ( "`find foo bar`",
-            "lists all definitions with a name similar to 'foo' or 'bar' in the "
-              <> "current namespace (excluding those under 'lib')."
-          ),
-          ( "find.all foo",
-            "lists all definitions with a name similar to 'foo' in the current "
-              <> "namespace (including one level of 'lib')."
-          ),
-          ( "find.global foo",
-            "lists all definitions with a name similar to 'foo' in any namespace"
-          )
-        ]
-    )
+    findHelp
     (pure . Input.FindI False fscope)
 
 findShallow :: InputPattern
@@ -656,7 +692,7 @@ findVerbose =
     ( "`find.verbose` searches for definitions like `find`, but includes hashes "
         <> "and aliases in the results."
     )
-    (pure . Input.FindI True Input.FindLocal)
+    (pure . Input.FindI True (Input.FindLocal Path.empty))
 
 findVerboseAll :: InputPattern
 findVerboseAll =
@@ -668,7 +704,7 @@ findVerboseAll =
     ( "`find.all.verbose` searches for definitions like `find.all`, but includes hashes "
         <> "and aliases in the results."
     )
-    (pure . Input.FindI True Input.FindLocalAndDeps)
+    (pure . Input.FindI True (Input.FindLocalAndDeps Path.empty))
 
 findPatch :: InputPattern
 findPatch =
@@ -968,11 +1004,11 @@ aliasMany =
 up :: InputPattern
 up =
   InputPattern
-    "up"
+    "deprecated.up"
     []
-    I.Visible
+    I.Hidden
     []
-    (P.wrapColumn2 [(makeExample up [], "move current path up one level")])
+    (P.wrapColumn2 [(makeExample up [], "move current path up one level (deprecated)")])
     ( \case
         [] -> Right Input.UpI
         _ -> Left (I.help up)
@@ -981,12 +1017,12 @@ up =
 cd :: InputPattern
 cd =
   InputPattern
-    "namespace"
-    ["cd", "j"]
+    "deprecated.cd"
+    ["deprecated.namespace"]
     I.Visible
     [("namespace", Required, namespaceArg)]
     ( P.lines
-        [ "Moves your perspective to a different namespace.",
+        [ "Moves your perspective to a different namespace. Deprecated for now because too many important things depend on your perspective selection.",
           "",
           P.wrapColumn2
             [ ( makeExample cd ["foo.bar"],
@@ -1020,7 +1056,7 @@ back =
     []
     ( P.wrapColumn2
         [ ( makeExample back [],
-            "undoes the last" <> makeExample' cd <> "command."
+            "undoes the last" <> makeExample' projectSwitch <> "command."
           )
         ]
     )
@@ -1233,15 +1269,18 @@ resetRoot =
   InputPattern
     "reset-root"
     []
-    I.Visible
+    I.Hidden
     [("namespace or hash to reset to", Required, namespaceArg)]
-    ( P.wrapColumn2
-        [ ( makeExample resetRoot [".foo"],
-            "Reset the root namespace (along with its history) to that of the `.foo` namespace."
-          ),
-          ( makeExample resetRoot ["#9dndk3kbsk13nbpeu"],
-            "Reset the root namespace (along with its history) to that of the namespace with hash `#9dndk3kbsk13nbpeu`."
-          )
+    ( P.lines
+        [ "Deprecated because it's incompatible with projects. ⚠️ Warning, this command can cause codebase corruption.",
+          P.wrapColumn2
+            [ ( makeExample resetRoot [".foo"],
+                "Reset the root namespace (along with its history) to that of the `.foo` namespace. Deprecated"
+              ),
+              ( makeExample resetRoot ["#9dndk3kbsk13nbpeu"],
+                "Reset the root namespace (along with its history) to that of the namespace with hash `#9dndk3kbsk13nbpeu`."
+              )
+            ]
         ]
     )
     \case
@@ -2982,7 +3021,9 @@ validInputs =
       editNamespace,
       execute,
       find,
+      findIn,
       findAll,
+      findInAll,
       findGlobal,
       findPatch,
       findShallow,

unison-cli/src/Unison/CommandLine/OutputMessages.hs

@@ -971,8 +971,8 @@ notifyUser dir = \case
     pure . P.warnCallout . P.lines $
       [ "Are you sure you want to clear away everything?",
         "You could use "
-          <> IP.makeExample' IP.cd
-          <> " to switch to a new namespace instead."
+          <> IP.makeExample' IP.projectCreate
+          <> " to switch to a new project instead."
       ]
   DeleteBranchConfirmation _uniqueDeletions -> error "todo"
   -- let

unison-src/transcripts-using-base/_base.md

@@ -12,7 +12,6 @@ transcripts which contain less boilerplate.
 ```ucm:hide
 .> builtins.merge
 .> builtins.mergeio
-.> cd builtin
 .> load unison-src/transcripts-using-base/base.u
 .> add
 ```
@@ -55,4 +54,3 @@ testAutoClean _ =
 .> add
 .> io.test testAutoClean
 ```
-

unison-src/transcripts-using-base/binary-encoding-nats.md

@@ -2,7 +2,6 @@
 ```ucm:hide
 .> builtins.merge
 .> builtins.mergeio
-.> cd builtin
 .> load unison-src/transcripts-using-base/base.u
 .> add
 .> find