https://github.com/maxlap/custom_escape_sequence
https://github.com/maxlap/custom_escape_sequence
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/maxlap/custom_escape_sequence
- Owner: MaxLap
- License: mit
- Created: 2024-04-02T19:07:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T18:34:42.000Z (almost 2 years ago)
- Last Synced: 2025-02-10T09:23:03.912Z (over 1 year ago)
- Language: Ruby
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CustomEscapeSequence
Currently a WIP used by directly using the GitHub repo for my personal needs.
Sometimes, I need to work with strings that have custom escape sequences.
Think for example a format string such as "### ###". This tool is meant to help
working with such a situation.
TODO: Add test for other functions than `#isolate`
TODO: Cleanup the comments for other functions than `#isolate`
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/custom_escape_sequence`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
## Usage
TODO: Write usage instructions here
## 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 https://github.com/[USERNAME]/custom_escape_sequence.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).