natvis-join 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 753804b91a3ae8116954545478dfbff09bca514d6ceae7d766fbc7dffea321cd
+  data.tar.gz: deed40094a5c424c5b3c533587c3607711548dde952702ac64a8486ab90712b4
+SHA512:
+  metadata.gz: ab4b3950a6957233ef8d3859f6122927df4f3ba1826b653f75b355891362efc21c53c94597bb50bd21c877fdb6ce061f40a0942d3c59d6eb2759041e1c2bd31a
+  data.tar.gz: 4dea0ba568e65b760ca1c21bfb579df94a936708610ef6805a98b2e3de3f8568e8e74a8f417b3e1341f4e789c40b8beb5dd5515a4d806d0292990cc1269e6011

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Borislav Stanimirov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# natvis-join
+
+A CLI tool to join multiple .natvis files into one.
+
+Visual Studio can be configured to use multiple .natvis files. In Visual Studio Code the plugin [vscode-cpptools](https://github.com/microsoft/vscode-cpptools) can be configured to use a single .natvis file.
+
+This tool helps by combining multiple .natvis files into one which can then be used in Visual Studio Code.
+
+## Installation
+
+A Ruby interpreter is required.
+
+You can install the gem with `$ gem install natvis-join` or you can just copy the self-contained file `bin/natvis-join` to use as a loose script.
+
+## Usage
+
+`$ natvis-join <paths> [-o <output_file>]`
+
+* `paths` are paths on the disk. If an entry is a file, it is appended to the output. If it is a directory it's scanned (non-recursively) for .natvis files and all found are appended to the output
+* `output_file` is the optional output .natvis file. If it is not provided, the result is printed to the standard output.
+
+## License
+
+This software is distributed under the MIT Software License. See accompanying LICENSE file or copy [here](https://opensource.org/licenses/MIT).
+
+Copyright &copy; 2021 [Borislav Stanimirov](http://github.com/iboB)
+
+

data/bin/natvis-join

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+#
+# natvis-join
+# Copyright (c) 2021 Borislav Stanimirov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+require 'nokogiri'
+
+VERSION = '0.1.0'
+
+VERSION_TEXT = "natvis-join v#{VERSION}"
+
+USAGE = <<USG
+
+Usage:
+    natvis-join <paths> [-o <output_file>]
+USG
+
+HELP = <<HLP
+
+Join Visual Studio native debug visualizer (.natvis) files into one
+
+Options:
+
+    paths:          Paths to files and/or directories. All files from the list
+                    and all .natvis files from the lited directories will be
+                    joined.
+
+    -o, --output    Optional output file. Without it the output goes to STDOUT
+    -h, -?, --help  Show this help message
+    -v, --version   Print version
+
+HLP
+
+begin
+  raise USAGE if ARGV.empty?
+  case ARGV[0]
+  when '-v', '--version'
+    puts VERSION_TEXT
+    exit(0)
+  when '-h', '-?', '--help'
+    puts VERSION_TEXT
+    puts USAGE
+    puts HELP
+    exit(0)
+  end
+
+  output = STDOUT
+  paths = []
+
+  output_arg = false
+  ARGV.each do |arg|
+    if arg == '-o' || arg == '--output'
+      output_arg = true
+      next
+    elsif output_arg
+      output = File.open(arg, 'w')
+      output_arg = false
+      next
+    else
+      paths << arg
+    end
+  end
+
+  AutoVisualizer = 'AutoVisualizer'
+
+  result_doc = Nokogiri::XML <<~XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+    </AutoVisualizer>
+  XML
+
+  paths.map { |p|
+    next p if File.file?(p)
+    next Dir[File.join(p, '*.natvis')] if File.directory?(p)
+    raise "Provided path '#{p}' was not found"
+    nil
+  }.compact.flatten.each do |f|
+    begin
+      result_doc.root.add_child("  <!-- #{f} -->")
+      Nokogiri::XML(File.read(f)).root.children.each do |node|
+        result_doc.root.add_child(node)
+      end
+    rescue
+      raise "Invalid xml in '#{f}'"
+    end
+  end
+
+  output.puts result_doc
+rescue StandardError => e
+  STDERR.puts e.message
+  exit(1)
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: natvis-join
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Borislav Stanimirov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'A CLI gem to join multiple .natvis files into one
+
+'
+email: b.stanimirov@abv.bg
+executables:
+- natvis-join
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/natvis-join
+homepage: https://github.com/iboB/natvis-join
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A CLI gem to join multiple .natvis files into one
+test_files: []