Command line parser prerequisites (#853)

* Expected-ize read_lines.

* Introduce IReadLines as a smaller interface for things that just want to read lines.

* Extract HelpTableFormatter and consistently use -s in source file names.

* Rename IReadLines to ILineReader, as requested by Victor.

* Name the numbers in HelpTableFormatter::format as requested by Victor.

* Fix NPM authenticate.

.clang-format

@@ -55,7 +55,7 @@ BraceWrapping:
 
 IncludeBlocks: Regroup
 IncludeCategories:
-  - Regex: '^(<vcpkg/base/system_headers\.h>|"pch\.h")$'
+  - Regex: '^(<vcpkg/base/system-headers\.h>|"pch\.h")$'
     Priority: -1
   - Regex: '^<catch2/catch\.hpp>$'
     Priority: 1

.gitignore

@@ -18,6 +18,7 @@ node_modules/
 /ce/test/**/*.map
 /ce/test/**/*.js
 /ce/ce/vcpkg-ce.build.log
+/ce/common/config/rush/.npmrc
 /ce/common/config/rush/pnpm-lock.yaml
 /ce/test/vcpkg-ce.test.build.log
 /ce/common/temp

azure-pipelines/pipelines.yml

@@ -126,10 +126,31 @@ jobs:
           git -C "$env:VCPKG_ROOT" checkout $sha
     - task: CodeQL3000Init@0
       displayName: 'CodeQL Initialize'
+    - task: Powershell@2
+      displayName: 'Format C++'
+      inputs:
+        filePath: 'azure-pipelines/Format-CxxCode.ps1'
+        pwsh: true
+    - task: Powershell@2
+      displayName: 'Create Diff'
+      inputs:
+        filePath: azure-pipelines/Create-PRDiff.ps1
+        arguments: '-DiffFile $(DiffFile)'
+        pwsh: true
+    - task: PublishBuildArtifacts@1
+      condition: failed()
+      displayName: 'Publish Format and Messages File Diff'
+      inputs:
+        PathtoPublish: '$(DiffFile)'
+        ArtifactName: 'format.diff'
     - task: UseNode@1
       displayName: Use Node 16 or later
       inputs:
         version: "16.x"
+    - task: npmAuthenticate@0
+      inputs:
+        workingFile: 'ce\common\config\rush\.npmrc'
+      # The working directory change is to get the above .npmrc used when installing rush
     - script: npm install -g @microsoft/rush
       displayName: Install Rush
       workingDirectory: ce\common\config\rush
@@ -153,22 +174,5 @@ jobs:
         filePath: 'azure-pipelines/end-to-end-tests.ps1'
         workingDirectory: '$(Build.SourcesDirectory)/build.x86.debug'
         pwsh: true
-    - task: Powershell@2
-      displayName: 'Format C++'
-      inputs:
-        filePath: 'azure-pipelines/Format-CxxCode.ps1'
-        pwsh: true
-    - task: Powershell@2
-      displayName: 'Create Diff'
-      inputs:
-        filePath: azure-pipelines/Create-PRDiff.ps1
-        arguments: '-DiffFile $(DiffFile)'
-        pwsh: true
-    - task: PublishBuildArtifacts@1
-      condition: failed()
-      displayName: 'Publish Format and Messages File Diff'
-      inputs:
-        PathtoPublish: '$(DiffFile)'
-        ArtifactName: 'format.diff'
     - task: CodeQL3000Finalize@0
       displayName: 'CodeQL Finalize'

include/pch.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <vcpkg/base/system_headers.h>
+#include <vcpkg/base/system-headers.h>
 
 #if defined(_MSC_VER)
 // pch.h only is used for performance with MSVC

include/vcpkg-test/util.h

@@ -1,4 +1,4 @@
-#include <vcpkg/base/system_headers.h>
+#include <vcpkg/base/system-headers.h>
 
 #include <catch2/catch.hpp>
 

include/vcpkg/base/checks.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <vcpkg/base/basic_checks.h>
+#include <vcpkg/base/basic-checks.h>
 #include <vcpkg/base/messages.h>
 #include <vcpkg/base/strings.h>
 

include/vcpkg/base/cmd-parser.h

@@ -0,0 +1,26 @@
+#pragma once
+
+#include <vcpkg/base/fwd/cmd-parser.h>
+
+#include <vcpkg/base/stringview.h>
+
+#include <string>
+
+namespace vcpkg
+{
+    struct HelpTableFormatter
+    {
+        // Adds a table entry with a key `col1` and value `col2`
+        void format(StringView col1, StringView col2);
+        // Adds an example block; typically just the text with no indenting
+        void example(StringView example_text);
+        // Adds a header typically placed at the top of several table entries
+        void header(StringView name);
+        // Adds a blank line
+        void blank();
+        // Adds a line of text
+        void text(StringView text, int indent = 0);
+
+        std::string m_str;
+    };
+}

include/vcpkg/base/expected.h

@@ -6,7 +6,7 @@
 #include <vcpkg/base/checks.h>
 #include <vcpkg/base/lineinfo.h>
 #include <vcpkg/base/stringview.h>
-#include <vcpkg/base/to_string.h>
+#include <vcpkg/base/to-string.h>
 
 #include <functional>
 #include <system_error>

include/vcpkg/base/files.h

@@ -156,14 +156,19 @@ namespace vcpkg
 
     uint64_t get_filesystem_stats();
 
-    struct Filesystem
+    struct ILineReader
+    {
+        virtual ExpectedL<std::vector<std::string>> read_lines(const Path& file_path) const = 0;
+
+    protected:
+        ~ILineReader();
+    };
+
+    struct Filesystem : ILineReader
     {
         virtual std::string read_contents(const Path& file_path, std::error_code& ec) const = 0;
         std::string read_contents(const Path& file_path, LineInfo li) const;
 
-        virtual std::vector<std::string> read_lines(const Path& file_path, std::error_code& ec) const = 0;
-        std::vector<std::string> read_lines(const Path& file_path, LineInfo li) const;
-
         virtual Path find_file_recursively_up(const Path& starting_dir,
                                               const Path& filename,
                                               std::error_code& ec) const = 0;

include/vcpkg/base/fwd/cmd-parser.h

@@ -0,0 +1,5 @@
+#pragma once
+namespace vcpkg
+{
+    struct HelpTableFormatter;
+}

include/vcpkg/base/fwd/files.h

@@ -34,6 +34,7 @@ namespace vcpkg
     struct ReadFilePointer;
     struct WriteFilePointer;
     struct IExclusiveFileLock;
+    struct ILineReader;
     struct Filesystem;
     struct NotExtensionCaseSensitive;
     struct NotExtensionCaseInsensitive;

include/vcpkg/base/lineinfo.h

@@ -10,4 +10,7 @@ namespace vcpkg
 }
 
 #define VCPKG_LINE_INFO                                                                                                \
-    vcpkg::LineInfo { __LINE__, __FILE__ }
+    vcpkg::LineInfo                                                                                                    \
+    {                                                                                                                  \
+        __LINE__, __FILE__                                                                                             \
+    }

include/vcpkg/base/optional.h

@@ -2,7 +2,7 @@
 
 #include <vcpkg/base/fwd/optional.h>
 
-#include <vcpkg/base/basic_checks.h>
+#include <vcpkg/base/basic-checks.h>
 #include <vcpkg/base/lineinfo.h>
 #include <vcpkg/base/pragmas.h>
 

include/vcpkg/base/strings.h

@@ -3,7 +3,7 @@
 #include <vcpkg/base/lineinfo.h>
 #include <vcpkg/base/optional.h>
 #include <vcpkg/base/stringview.h>
-#include <vcpkg/base/to_string.h>
+#include <vcpkg/base/to-string.h>
 
 #include <errno.h>
 #include <inttypes.h>

include/vcpkg/vcpkgcmdarguments.h

@@ -5,6 +5,7 @@
 #include <vcpkg/fwd/vcpkgcmdarguments.h>
 #include <vcpkg/fwd/vcpkgpaths.h>
 
+#include <vcpkg/base/cmd-parser.h>
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/optional.h>
 #include <vcpkg/base/span.h>
@@ -74,17 +75,6 @@ namespace vcpkg
 
     std::string create_example_string(const std::string& command_and_arguments);
 
-    struct HelpTableFormatter
-    {
-        void format(StringView col1, StringView col2);
-        void example(StringView example_text);
-        void header(StringView name);
-        void blank();
-        void text(StringView text, int indent = 0);
-
-        std::string m_str;
-    };
-
     struct FeatureFlagSettings
     {
         bool registries;
@@ -95,7 +85,7 @@ namespace vcpkg
 
     struct VcpkgCmdArguments
     {
-        static VcpkgCmdArguments create_from_command_line(const Filesystem& fs,
+        static VcpkgCmdArguments create_from_command_line(const ILineReader& fs,
                                                           const int argc,
                                                           const CommandLineCharType* const* const argv);
         static VcpkgCmdArguments create_from_arg_sequence(const std::string* arg_begin, const std::string* arg_end);

src/vcpkg-test/catch.cpp

@@ -1,7 +1,7 @@
 #define CATCH_CONFIG_RUNNER
 #include <catch2/catch.hpp>
 
-#include <vcpkg/base/basic_checks.h>
+#include <vcpkg/base/basic-checks.h>
 #include <vcpkg/base/messages.h>
 #include <vcpkg/base/system.debug.h>
 #include <vcpkg/base/system.h>

src/vcpkg-test/ci-baseline.cpp

@@ -1,6 +1,6 @@
 #include <catch2/catch.hpp>
 
-#include <vcpkg/base/basic_checks.h>
+#include <vcpkg/base/basic-checks.h>
 #include <vcpkg/base/parse.h>
 
 #include <vcpkg/build.h>

src/vcpkg-test/cmd-parser.cpp

@@ -0,0 +1,40 @@
+#include <catch2/catch.hpp>
+
+#include <vcpkg/base/cmd-parser.h>
+
+using namespace vcpkg;
+
+TEST_CASE ("Smoke test help table formatter", "[cmd_parser]")
+{
+    HelpTableFormatter uut;
+
+    uut.header("This is a header");
+    uut.format("short-arg", "short help text");
+    uut.format("a-really-long-arg-that-does-not-fit-in-the-first-column-and-keeps-going", "shorty");
+    uut.format("short-arg",
+               "some really long help text that does not fit on the same line because we have a 100 character line "
+               "limit and oh god it keeps going and going");
+    uut.format("a-really-long-arg-combined-with-some-really-long-help-text",
+               "another instance of that really long help text goes here to demonstrate that the worst case combo can "
+               "be accommodated");
+
+    uut.blank();
+    uut.example("some example command");
+    uut.text("this is some text");
+
+    const char* const expected = R"(This is a header:
+  short-arg                       short help text
+  a-really-long-arg-that-does-not-fit-in-the-first-column-and-keeps-going
+                                  shorty
+  short-arg                       some really long help text that does not fit on the same line
+                                  because we have a 100 character line limit and oh god it keeps
+                                  going and going
+  a-really-long-arg-combined-with-some-really-long-help-text
+                                  another instance of that really long help text goes here to
+                                  demonstrate that the worst case combo can be accommodated
+
+some example command
+this is some text)";
+
+    CHECK(uut.m_str == expected);
+}

src/vcpkg-test/files.cpp

@@ -1,4 +1,4 @@
-#include <vcpkg/base/system_headers.h>
+#include <vcpkg/base/system-headers.h>
 
 #include <catch2/catch.hpp>
 

src/vcpkg-test/messages.cpp

@@ -1,7 +1,7 @@
 #include <catch2/catch.hpp>
 
 #include <vcpkg/base/json.h>
-#include <vcpkg/base/setup_messages.h>
+#include <vcpkg/base/setup-messages.h>
 
 #include <vcpkg/commands.generate-message-map.h>
 

src/vcpkg-test/strings.cpp

@@ -1,6 +1,6 @@
 #include <catch2/catch.hpp>
 
-#include <vcpkg/base/api_stable_format.h>
+#include <vcpkg/base/api-stable-format.h>
 #include <vcpkg/base/expected.h>
 #include <vcpkg/base/strings.h>
 

src/vcpkg-test/system.cpp

@@ -1,4 +1,4 @@
-#include <vcpkg/base/system_headers.h>
+#include <vcpkg/base/system-headers.h>
 
 #include <catch2/catch.hpp>
 

src/vcpkg.cpp

@@ -1,10 +1,10 @@
-#include <vcpkg/base/system_headers.h>
+#include <vcpkg/base/system-headers.h>
 
 #include <vcpkg/base/chrono.h>
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/json.h>
 #include <vcpkg/base/pragmas.h>
-#include <vcpkg/base/setup_messages.h>
+#include <vcpkg/base/setup-messages.h>
 #include <vcpkg/base/strings.h>
 #include <vcpkg/base/system.debug.h>
 #include <vcpkg/base/system.process.h>