tty-markdown-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa41056d9d94df9f144f850544da70e883f56f0ef1b00ded5ba88a70c013c60e
+  data.tar.gz: 3d46cbb83ac6247c66a6af588d5ed1ce46d5eee8c74a0db1233575159ca61ba3
+SHA512:
+  metadata.gz: 2784a6a63b9a3a54440baacf19d5de3b1d107337c9a248158e3ce4cd24f2e485e00907cdf086c26c657f19a7fa979b25f931d5b67f82a4c9b5f94e84daf2d4be
+  data.tar.gz: 9c5cb653f168db88a2fe1b325a884ebf0994edae6049ca09d1defc4638cd6e224cfb077d2554763473bf9c418099f21e0d2495899725c02775049516a0af3667

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2020-09-03
+
+Initial release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-markdown-cli/compare/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Piotr Murach (piotrmurach.com)
+
+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,99 @@
+# TTY::Markdown CLI
+
+[![Gem Version](https://badge.fury.io/rb/tty-markdown-cli.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-markdown-cli.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/3i2mn2nh9hq1cag2?svg=true)][appveyor]
+
+[gem]: http://badge.fury.io/rb/tty-markdown-cli
+[travis]: http://travis-ci.org/piotrmurach/tty-markdown-cli
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-markdown-cli
+
+> CLI tool for displaying Markdown documents in a nicely formatted terminal output.
+
+**TTY::Markdown CLI** provides cli for [TTY::Markdown](https://github.com/piotrmurach/tty-markdown)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tty-markdown-cli"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tty-markdown-cli
+
+## Usage
+
+Run `tty-markdown` with `-h` or `--help` options to print help information:
+
+```bash
+$ tty-markdown --help
+```
+
+To preview a Markdown document like this `README.md`:
+
+```bash
+$ tty-markdown README.md
+```
+
+To pipe a Markdown document like this `README.md` file:
+
+```bash
+$ cat README.md | tty-markdown
+```
+
+By default `UTF-8` symbols are used to display terminal output but you can fallback on more widely supported `ASCII` set with `-a/--ascii`:
+
+```bash
+$ tty-markdown -a README.md
+$ tty-markdown --ascii README.md
+```
+
+Further, you can control the amount of indentation with `-i/--indent` option. By default 2 spaces are used but you can, for example, remove any indentation:
+
+```bash
+$ tty-markdown -i 0 README.md
+$ tty-markdown --indent 0 README.md
+```
+
+You can also use `-w/--width` option to specify the maximum output width. By default the output will span the full terminal width. To make output wrap around `80` characters do:
+
+```bash
+$ tty-markdown -w 80 README.md
+$ tty-markdown --width 80 README.md
+```
+
+To control output coloring, use `-c/--color` option with `always`, `never` or `auto`:
+
+```bash
+$ tty-markdown -c always README
+$ tty-markdown --color always README
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/piotrmurach/tty-markdown-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/piotrmurach/tty-markdown-cli/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 `tty-markdown-cli` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-markdown-cli/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2020 Piotr Murach (piotrmurach.com). See LICENSE for further details.

data/exe/tty-markdown

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") { exit 1 }
+
+require "optparse"
+require "tty-markdown"
+
+options = {}
+
+ARGV << "-h" if ARGV.empty? && $stdin.tty?
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{::File.basename($0)} [options] [file]"
+
+  opts.on("-a", "--ascii", "Use ASCII symbols (default UTF-8)") do
+    options[:symbols] = :ascii
+  end
+
+  opts.on("-m n", "--mode n", "Maximum number of colors (default auto detect)") do |n|
+    options[:mode] = n.to_i
+  end
+
+  opts.on("-c when", "--color when",
+          "When to color content. Valid values are never, " \
+          "always or auto. (default auto)") do |w|
+    options[:color] = w
+  end
+
+  opts.on("-i n", "--indent n", "Indentation amount (default 2 spaces)") do |n|
+    options[:indent] = n.to_i
+  end
+
+  opts.on("-w n", "--width n", "Maximum output width (default full terminal)") do  |n|
+    options[:width] = n.to_i
+  end
+
+  opts.on("-h", "--help", "Display help" ) do
+    puts opts
+    exit
+  end
+
+  opts.on("-v", "--version", "Display the version") do
+    puts "0.1.0 (tty-markdown #{TTY::Markdown::VERSION})"
+    exit
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::ParseError => error
+  $stderr.puts error.message
+  exit 1
+end
+
+text = ARGV[0] ? ARGV.pop : $stdin.read
+
+if ::File.file?(text)
+  print TTY::Markdown.parse_file(text, **options)
+else
+  print TTY::Markdown.parse(text, **options)
+end

data/exe/ttymarkdown

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.expand_path("tty-markdown", __dir__)

data/man/tty-markdown.1

@@ -0,0 +1,47 @@
+.\" generated by kramdown
+.TH "TTY\-MARKDOWN" "1"
+.SH "NAME"
+\fBtty\-markdown\fP \- display Markdown documents in a nicely formatted terminal output
+.SH "SYNOPSIS"
+\fBtty\-markdown\fP [options] [file]
+.SH "DESCRIPTION"
+The \fBtty\-markdown\fP utility displays Markdown documents in a nicely formatted terminal output\.
+.P
+The options are as follows:
+.TP
+\fB\-a\fP, \fB\-\-ascii\fP
+Use ASCII symbols\.
+.TP
+\fB\-c when\fP, \fB\-\-color when\fP
+When to color content\. Valid values are \fBnever\fP, \fBalways\fP or \fBauto\fP\&\. (default auto)
+.TP
+\fB\-i n\fP, \fB\-\-indent n\fP
+Indentation amount (default 2 spaces)\.
+.TP
+\fB\-m n\fP, \fB\-\-mode n\fP
+Maximum number of colors supported by the terminal (default auto detect)\.
+.TP
+\fB\-w n\fP, \fB\-\-width n\fP
+Maximum output width (default full terminal width)\.
+.TP
+\fB\-h\fP, \fB\-\-help\fP
+Print the synopsis and list all available options
+.TP
+\fB\-v\fP, \fB\-\-version\fP
+Print the tool version and the tty\-markdown version its using\.
+.SH "EXAMPLES"
+Print a Markdown document to the standard output using ASCII symbol set:
+.P
+\fB tty\-markdown \-a README\.md \fP
+.P
+Read a Markdown content and print it to the standard output at maximum width of 80 characters:
+.P
+\fB cat README\.md | tty\-markdown \-\-width 80 \fP
+.SH "EXIT STATUS"
+The \fBtty\-markdown\fP utility exits 0 on success, and 1 if an error occurs\.
+.SH "SEE ALSO"
+The \fBtty\-markdown\fP readme https://github\.com/piotrmurach/tty\-markdown
+.SH "AUTHOR"
+The \fBtty\-markdown\fP utility is written by Piotr Murach <piotr@piotrmurach\.com>
+.P
+Website: https://ttytoolkit\.org

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: tty-markdown-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: A command-line tool for displaying Markdown documents in a nicely fromatted
+  terminal output.
+email:
+- piotr@piotrmurach.com
+executables:
+- tty-markdown
+- ttymarkdown
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/tty-markdown
+- exe/ttymarkdown
+- man/tty-markdown.1
+homepage: https://ttytoolkit.org
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-markdown-cli/issues
+  changelog_uri: https://github.com/piotrmurach/tty-markdown-cli/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-markdown-cli
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-markdown-cli
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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 command-line tool for displaying Markdown documents in a nicely formatted
+  terminal output.
+test_files: []