snippet_converter 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dc56d98a3f84090a5668ee6707a606f765adb28ad4fb53ccf54c144d46b571f
+  data.tar.gz: 93c626dd0f6be3e366606554502a33b5e53dafaf3105a42d3b2be6da862e6614
+SHA512:
+  metadata.gz: 648fc64287f5de008ca97377c3e09aa25649e843e1ae6e668d23964ac5c9e05437956a34f1c1fcf631bc65ee177bf8278e53415c6553863d772e889726a4a9e4
+  data.tar.gz: 7e41bc607312eab66769d9d97acc433f0a9d6cffa7cbf0c95605f7e875268c9a25a9f97d0199909a843396e63541b49dd905b340e3b527b3ab23252c81e45262

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
+.ruby-gemset
+
+# Gems
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeremie@cubytz.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in snippet_converter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    snippet_converter (0.1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  snippet_converter!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jeremie Henri
+
+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,87 @@
+# SnippetConverter
+
+[![The MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](http://opensource.org/licenses/MIT)
+
+Simple command-line tool to convert Sublime Text Snippets to Visual Studio Code format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snippet_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snippet_converter
+
+## Usage
+
+### Simple conversion
+
+Convert a snippet to json
+
+```
+snippet_converter -f PATH_TO_SUBLIME_SNIPPET
+```
+
+This will create a `snippets/snippets.json` file in the current working directory.
+
+**Keep original filename**
+
+Pass the split `-s` option to keep the original filename.
+
+### Bulk conversion
+
+**Convert selected files**
+
+Convert multiple files by passing a comma seperated list to the `-f` option
+
+```
+snippet_converter -f 'PATH_TO_FILE,PATH_TO_FILE,...'
+```
+
+**Convert content of directory**
+
+Convert a folder by using the `-d` option
+
+```
+snippet_converter -d PATH_TO_DIRECTORY
+```
+
+**Split files**
+
+Pass the split `-s` option to split the output in multiple files
+
+### Output directory
+
+Set the output directory by passing the `-o` option
+
+```
+snippet_converter -f PATH_TO_SNIPPET_FILE -o PATH_TO_OUTPUT_FOLDER
+```
+
+For all available options, see `-h` or `--help` for details
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cubytz/snippet_converter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SnippetConverter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cubytz/snippet_converter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/snippet_converter

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby -w
+# frozen_string_literal: true
+
+require 'snippet_converter'
+
+# Parse the options to the converter
+options = SnippetConverter.parse(ARGV)
+
+# File or Directory required
+unless options.file || options.directory
+  puts 'No file or directory passed'
+  exit
+end
+
+# Choose file over directory in case both are passed
+if options.file
+  if File.directory?(options.file) || !File.file?(options.file)
+    puts "#{options.file} is not a snippet file"
+    exit
+  end
+
+  files = options.file.split(',')
+elsif options.directory
+  if !File.directory?(options.directory) || File.file?(options.directory)
+    puts "#{options.directory} is not a directory"
+    exit
+  end
+
+  directory = options.directory
+  directory += '/' unless options.directory[-1] == '/'
+
+  files = Dir["#{directory}*.sublime-snippet"]
+end
+
+puts "#{files.count} files" if options.verbose
+
+# Exit if no file found
+exit unless files.size.positive?
+
+# Create the directory
+FileUtils.mkdir_p(options.destination) unless Dir.exist?(options.destination)
+
+# Create a snippets hash
+snippets = {}
+
+# Loop through the files
+files.each do |file|
+  # Convert the files
+  snippet = SnippetConverter.convert_to_vsc(file)
+  snippets[snippet[:prefix]] = snippet
+  if options.verbose
+    # puts "### #{snippet[:prefix]} ###"
+    # pp snippet.to_json
+  end
+end
+
+case options.split
+when true
+  snippets.each do |key, value|
+    snippet = {}
+    snippet[key] = value
+    filename = "#{options.destination}/#{key}.#{options.output}"
+    SnippetConverter.write_file(filename, snippet)
+  end
+when false
+  filename = "#{options.destination}/snippets.#{options.output}"
+  SnippetConverter.write_file(filename, snippets)
+end
+
+puts JSON.pretty_generate(snippets) if options.verbose
+
+puts 'Done'

data/lib/snippet_converter.rb

@@ -0,0 +1,192 @@
+#!/usr/bin/ruby -w
+# frozen_string_literal: true
+
+require 'rexml/document'
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require 'pp'
+require 'json'
+require 'fileutils'
+require 'snippet_converter/version'
+
+# The main class
+class SnippetConverter
+  include REXML
+
+  # variable referencing the corresponding
+  # keys {Sublime: 'VSC'}
+  KEYS = {
+    content: 'body',
+    tabTrigger: 'prefix',
+    scope: 'scope',
+    description: 'description'
+  }.freeze
+
+  #
+  # Outputs info to the command line
+  #
+  def self.info
+    name = Gem.loaded_specs['snippet_converter'].name
+    name = name.split('_').map(&:capitalize).join
+    license = Gem.loaded_specs['snippet_converter'].license
+    puts ''
+    puts "#{name}, version #{VERSION}"
+    puts "#{license} License"
+    puts 'Copyright (c) 2018 Jeremie Henri - Cubytz'
+    puts ''
+  end
+
+  #
+  # Parse arguments
+  #
+  # @param [Array] args Array of arguments passed in cli
+  #
+  # @return [OpenStruct] options as a ostruct
+  #
+  def self.parse(args)
+    options = OpenStruct.new
+    options.encoding = 'utf8'
+    options.verbose = false
+    options.split = false
+    options.output = 'json'
+    options.destination = 'snippets'
+
+    opts = OptionParser.new do |op|
+      op.banner = "Usage:\tsnippetconverter.rb [options]\n\tFile(s) or directory required"
+
+      op.separator ''
+      op.separator 'Specific options:'
+
+      # File
+      op.on('-f', '--file file', 'Snippet file(s) to convert') do |f|
+        options.file = f
+      end
+
+      # Directory
+      op.on('-d', '--directory directory', 'Directory of snippets file to convert') do |d|
+        options.directory = d
+      end
+
+      # Split
+      op.on('-s', '--[no-]split', 'Split output into multiple files') do |s|
+        options.split = s
+      end
+
+      # Output
+      op.on('-o', '--output output', 'Output format (default: json)') do |o|
+        options.output = o
+      end
+
+      # Destination folder
+      op.on('--destination destination', 'Destination directory (default: snippets)') do |dest|
+        options.destination = dest
+      end
+
+      # Verbose
+      op.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+        options.verbose = v
+      end
+
+      op.separator ''
+      op.separator 'Common options:'
+
+      # Print an options summary.
+      op.on_tail('-h', '--help', 'Show this help message') do
+        info
+        puts opts
+        exit
+      end
+
+      # Print the version.
+      op.on_tail('--version', 'Show version') do
+        puts "SnippetConverter, version #{VERSION}"
+        exit
+      end
+    end
+
+    opts.parse!(args)
+    options
+  end
+
+  #
+  # Read snippet file and return the first snippet found
+  #
+  # @param [String] file Snipppet file path
+  #
+  # @return [REXML::Element] First snippet element found
+  #
+  def self.read_snippet(file)
+    xmlfile = File.new(file)
+    doc = Document.new(xmlfile)
+
+    # return the snippet element
+    XPath.first(doc.root, '//snippet')
+  end
+
+  #
+  # Creates a Hash element with VSC keys and
+  # formatted body
+  #
+  # @param [REXML::Element] snippet_element Snippet xml element
+  #
+  # @return [Hash] Snippet as a hash
+  #
+  def self.create_json_snippet(snippet_element)
+    snippet = {}
+    snippet_element.elements.each do |element|
+      key = KEYS[element.name.to_sym]
+      case key
+      when 'body'
+        value = SnippetConverter.format_body(element.text)
+      else
+        value = element.text
+      end
+
+      snippet[key.to_sym] = value
+    end
+    snippet
+  end
+
+  #
+  # Convert file content to VSC snippet format
+  #
+  # @param [file] file Snippet file path
+  #
+  # @return [Hash] VSC Json snippet
+  #
+  def self.convert_to_vsc(file)
+    # Get the first snippet element
+    snippet_element = read_snippet(file)
+    # Convert the snippet to VSC snippet format
+    create_json_snippet(snippet_element)
+  end
+
+  #
+  # Format the body element
+  #
+  # @param [String] body Sublime snippet content element
+  #
+  # @return [Array] Body as an array
+  #
+  def self.format_body(body)
+    # Split by \n
+    formatted_body = body.split("\n")
+    # Remove any empty element from the array
+    formatted_body.delete('')
+    formatted_body
+  end
+
+  #
+  # Save snippet content to disk
+  #
+  # @param [String] file filename
+  # @param [Has] snippet snippet hash
+  #
+  def self.write_file(file, snippet)
+    File.open(file, 'w') do |f|
+      # Pretty generate the JSON before saving
+      f.write(JSON.pretty_generate(snippet))
+    end
+  end
+end

data/lib/snippet_converter/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# The SnippetConverter main class
+class SnippetConverter
+  VERSION = '0.1.8'
+end

data/snippet_converter.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snippet_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snippet_converter'
+  spec.version       = SnippetConverter::VERSION
+  spec.authors       = ['Jeremie Henri']
+  spec.email         = ['jeremie@cubytz.com']
+
+  spec.summary       = 'CLI Converter for Sublime Snippets to Visual Studio Code format'
+  spec.description   = 'Simple command-line tool to convert Sublime Text Snippets to Visual Studio Code format'
+  spec.homepage      = 'https://github.com/cubytz/SnippetConverter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: snippet_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Jeremie Henri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple command-line tool to convert Sublime Text Snippets to Visual Studio
+  Code format
+email:
+- jeremie@cubytz.com
+executables:
+- snippet_converter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/snippet_converter
+- lib/snippet_converter.rb
+- lib/snippet_converter/version.rb
+- snippet_converter.gemspec
+homepage: https://github.com/cubytz/SnippetConverter
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CLI Converter for Sublime Snippets to Visual Studio Code format
+test_files: []