Merge pull request #11829 from DeterminateSystems/revert-10980

Revert "Merge pull request #10980 from kjeremy/flake-show-description"

doc/manual/rl-next/nix-flake-show-description.md

@@ -1,25 +0,0 @@
----
-synopsis: Show package descriptions with `nix flake show`
-issues: [10977]
-prs: [10980]
----
-
-`nix flake show` will now display a package's `meta.description` if it exists. If the description does not fit in the terminal it will be truncated to fit the terminal width. If the size of the terminal width is unknown the description will be capped at 80 characters.
-
-```
-$ nix flake show
-└───packages
-    └───x86_64-linux
-        ├───builderImage: package 'docker-image-ara-builder-image.tar.gz' - 'Docker image hosting the nix build environment'
-        └───runnerImage: package 'docker-image-gitlab-runner.tar.gz' - 'Docker image hosting the gitlab-runner executable'
-```
-
-In a narrower terminal:
-
-```
-$ nix flake show
-└───packages
-    └───x86_64-linux
-        ├───builderImage: package 'docker-image-ara-builder-image.tar.gz' - 'Docker image hosting the nix b...
-        └───runnerImage: package 'docker-image-gitlab-runner.tar.gz' - 'Docker image hosting the gitlab-run...
-```

src/nix/flake.cc

@@ -17,7 +17,6 @@
 #include "eval-cache.hh"
 #include "markdown.hh"
 #include "users.hh"
-#include "terminal.hh"
 
 #include <filesystem>
 #include <nlohmann/json.hpp>
@@ -1275,97 +1274,25 @@ struct CmdFlakeShow : FlakeCommand, MixJSON
                 auto showDerivation = [&]()
                 {
                     auto name = visitor.getAttr(state->sName)->getString();
-                    std::optional<std::string> description;
-                    if (auto aMeta = visitor.maybeGetAttr(state->sMeta)) {
-                        if (auto aDescription = aMeta->maybeGetAttr(state->sDescription))
-                            description = aDescription->getString();
-                    }
 
                     if (json) {
+                        std::optional<std::string> description;
+                        if (auto aMeta = visitor.maybeGetAttr(state->sMeta)) {
+                            if (auto aDescription = aMeta->maybeGetAttr(state->sDescription))
+                                description = aDescription->getString();
+                        }
                         j.emplace("type", "derivation");
                         j.emplace("name", name);
                         j.emplace("description", description ? *description : "");
                     } else {
-                        auto type =
+                        logger->cout("%s: %s '%s'",
+                            headerPrefix,
                             attrPath.size() == 2 && attrPathS[0] == "devShell" ? "development environment" :
                             attrPath.size() >= 2 && attrPathS[0] == "devShells" ? "development environment" :
                             attrPath.size() == 3 && attrPathS[0] == "checks" ? "derivation" :
                             attrPath.size() >= 1 && attrPathS[0] == "hydraJobs" ? "derivation" :
-                            "package";
+                            "package",
-                        if (description && !description->empty()) {
+                            name);
-
-                            // Takes a string and returns the # of characters displayed
-                            auto columnLengthOfString = [](std::string_view s) -> unsigned int {
-                                unsigned int columnCount = 0;
-                                for (auto i = s.begin(); i < s.end();) {
-                                    // Test first character to determine if it is one of
-                                    // treeConn, treeLast, treeLine
-                                    if (*i == -30) {
-                                        i += 3;
-                                        ++columnCount;
-                                    }
-                                    // Escape sequences
-                                    // https://en.wikipedia.org/wiki/ANSI_escape_code
-                                    else if (*i == '\e') {
-                                        // Eat '['
-                                        if (*(++i) == '[') {
-                                            ++i;
-                                            // Eat parameter bytes
-                                            while(*i >= 0x30 && *i <= 0x3f) ++i;
-
-                                            // Eat intermediate bytes
-                                            while(*i >= 0x20 && *i <= 0x2f) ++i;
-
-                                            // Eat final byte
-                                            if(*i >= 0x40 && *i <= 0x73) ++i;
-                                        }
-                                        else {
-                                            // Eat Fe Escape sequence
-                                            if (*i >= 0x40 && *i <= 0x5f) ++i;
-                                        }
-                                    }
-                                    else {
-                                        ++i;
-                                        ++columnCount;
-                                    }
-                                }
-
-                                return columnCount;
-                            };
-
-                            // Maximum length to print
-                            size_t maxLength = getWindowSize().second > 0 ? getWindowSize().second : 80;
-
-                            // Trim the description and only use the first line
-                            auto trimmed = trim(*description);
-                            auto newLinePos = trimmed.find('\n');
-                            auto length = newLinePos != std::string::npos ? newLinePos : trimmed.length();
-
-                            auto beginningOfLine = fmt("%s: %s '%s'", headerPrefix, type, name);
-                            auto line = fmt("%s: %s '%s' - '%s'", headerPrefix, type, name, trimmed.substr(0, length));
-
-                            // If we are already over the maximum length then do not trim
-                            // and don't print the description (preserves existing behavior)
-                            if (columnLengthOfString(beginningOfLine) >= maxLength) {
-                                logger->cout("%s", beginningOfLine);
-                            }
-                            // If the entire line fits then print that
-                            else if (columnLengthOfString(line) < maxLength) {
-                                logger->cout("%s", line);
-                            }
-                            // Otherwise we need to truncate
-                            else {
-                                auto lineLength = columnLengthOfString(line);
-                                auto chopOff = lineLength - maxLength;
-                                line.resize(line.length() - chopOff);
-                                line = line.replace(line.length() - 3, 3, "...");
-
-                                logger->cout("%s", line);
-                            }
-                        }
-                        else {
-                            logger->cout("%s: %s '%s'", headerPrefix, type, name);
-                        }
                     }
                 };
 

tests/functional/flakes/show.sh

@@ -87,28 +87,3 @@ assert show_output.legacyPackages.${builtins.currentSystem}.AAAAAASomeThingsFail
 assert show_output.legacyPackages.${builtins.currentSystem}.simple.name == "simple";
 true
 '
-
-cat >flake.nix<<EOF
-{
-  outputs = inputs: {
-    packages.$system = {
-      aNoDescription = import ./simple.nix;
-      bOneLineDescription = import ./simple.nix // { meta.description = "one line"; };
-      cMultiLineDescription = import ./simple.nix // { meta.description = ''
-         line one
-        line two
-      ''; };
-      dLongDescription = import ./simple.nix // { meta.description = ''
-        01234567890123456789012345678901234567890123456789012345678901234567890123456789abcdefg
-      ''; };
-      eEmptyDescription = import ./simple.nix // { meta.description = ""; };
-    };
-  };
-}
-EOF
-nix flake show > ./show-output.txt
-test "$(awk -F '[:] ' '/aNoDescription/{print $NF}' ./show-output.txt)" = "package 'simple'"
-test "$(awk -F '[:] ' '/bOneLineDescription/{print $NF}' ./show-output.txt)" = "package 'simple' - 'one line'"
-test "$(awk -F '[:] ' '/cMultiLineDescription/{print $NF}' ./show-output.txt)" = "package 'simple' - 'line one'"
-test "$(awk -F '[:] ' '/dLongDescription/{print $NF}' ./show-output.txt)" = "package 'simple' - '012345678901234567890123456..."
-test "$(awk -F '[:] ' '/eEmptyDescription/{print $NF}' ./show-output.txt)" = "package 'simple'"