https://github.com/ajmarkow/total_rewrite_of_snippet_cli_gem

Now you can easily add snippets to your espanso configuration in a snap, using snippet_cli.
https://github.com/ajmarkow/total_rewrite_of_snippet_cli_gem

cli command-line-tool espanso espanso-snippets ruby

Last synced: 3 months ago
JSON representation

Now you can easily add snippets to your espanso configuration in a snap, using snippet_cli.

• Host: GitHub
• URL: https://github.com/ajmarkow/total_rewrite_of_snippet_cli_gem
• Owner: ajmarkow
• License: mit
• Created: 2023-09-28T02:33:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-04T03:36:44.000Z (about 1 year ago)
• Last Synced: 2024-06-11T12:46:57.106Z (5 months ago)
• Topics: cli, command-line-tool, espanso, espanso-snippets, ruby
• Language: Ruby
• Homepage: https://l.ajm.codes/snippet_cli
• Size: 188 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - ajmarkow/total_rewrite_of_snippet_cli_gem - Now you can easily add snippets to your espanso configuration in a snap, using snippet_cli. (Ruby)

README

        
# SnippetCli  

                   

- This Ruby Gem allows you to effortlessly incorporate YAML snippets into your Espanso configuration with consistency.

- This is A Command line interface, aka CLI.

- It writes directly to your base.yml (Default Configuration File) in Espanso.

- Built to be used with the application [Espanso](https://espanso.org).

- This gem is not associated with any node/npm package of the same name.

## Compatibility

- Built specifically to be used on MacOS.

- This software requires Espanso version 2 or above.

## Installation

Install the gem by executing:

    gem install --user-install snippet_cli

## Usage

TODO: Link to gh-pages hosted doc.

## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at . 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/ajmarkow/snippet_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 SnippetCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ajmarkow/snippet_cli/blob/master/CODE_OF_CONDUCT.md).

### TO-DO

- [json schema in rspec](https://thoughtbot.com/blog/validating-json-schemas-with-an-rspec-matcher)

- [yaml structures vs ruby](https://yaml.org/YAML_for_ruby.html)

- [safe yaml](https://github.com/dtao/safe_yaml) ???