gemoji-cli 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +34 -25
  3. data/.rubocop_todo.yml +14 -1
  4. data/CHANGELOG.md +11 -0
  5. data/README.md +58 -13
  6. data/Rakefile +1 -1
  7. data/TODO.md +45 -0
  8. data/lib/gemoji/cli/version.rb +1 -1
  9. data/mise.toml +3 -0
  10. metadata +8 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 259ef6cb27019361b5ba2fde8894af3e7989091af84c38c0ca5294f621610b72
4
- data.tar.gz: 7c908ec314daf7646c0b9d18f31149093d13aa0751b0e1470c3a2dbad7ed6851
3
+ metadata.gz: b91ef8ccf0c6d4e258cfc1ba0f534a2a6e3f327e8edd103910b11dc6e04ee155
4
+ data.tar.gz: 8e89138ad680b99c76a03dbbe541b2c601f2eb5921d90a92fa412a52a32dc78c
5
5
  SHA512:
6
- metadata.gz: 6d23ac895a205c2b768fd427e4b1a426cfd9158d5db64f266a57b9a5ef5223096431ff40876f49a72182bb7ff3e746c39b31bc125471e5414415d2fc53b9a9d9
7
- data.tar.gz: dcbaff573657f536b63050c3ed4cb7eb3029e9ebf0182f0a59622fc5c2f3019a85a80c448be47449a9f2eca156dc9dfa6468d9c9d7bcdb0eb0594e22868f7a71
6
+ metadata.gz: 217ad99e67c360650e88c811438861f8350aa27b774a2df284336ed6643639419751b2c81f54ba6611539904ecc8e6484230b4742423b2b6716ce042c6f6a4c2
7
+ data.tar.gz: a9885fceed92910a6c2f4940aeb7a707b504c019c865d5992f3176428fc031ec8b0699efbf8dc91a45287d7ad267c75b3d53f36c39300396ba0db9580841d719
data/.rubocop.yml CHANGED
@@ -1,39 +1,41 @@
1
- ---
2
1
  AllCops:
3
2
  DisplayCopNames: true
4
3
  DisplayStyleGuide: true
5
4
  EnabledByDefault: true
6
5
  Exclude:
7
- - bin/**/*
8
- - vendor/**/*
6
+ - bin/**/*
7
+ - vendor/**/*
9
8
  ExtraDetails: true
10
- TargetRubyVersion: 3.4
9
+ NewCops: enable
10
+ TargetRubyVersion: 3.2
11
11
  UseCache: true
12
+
12
13
  inherit_mode:
13
14
  merge:
14
- - Exclude
15
+ - Exclude
16
+
15
17
  plugins:
16
- - rubocop-performance
17
- - rubocop-rake
18
- - rubocop-rspec
19
- - rubocop-thread_safety
20
- require: []
21
- inherit_from:
22
- - .rubocop_todo.yml
23
- - .rubocop/bundler.yml
24
- - .rubocop/gemspec.yml
25
- - .rubocop/layout.yml
26
- - .rubocop/lint.yml
27
- - .rubocop/metrics.yml
28
- - .rubocop/migration.yml
29
- - .rubocop/naming.yml
30
- - .rubocop/performance.yml
31
- - .rubocop/rspec.yml
32
- - .rubocop/rake.yml
33
- - .rubocop/security.yml
34
- - .rubocop/style.yml
35
- - .rubocop/threadsafety.yml
18
+ - rubocop-performance
19
+ - rubocop-rake
20
+ - rubocop-rspec
21
+ - rubocop-thread_safety
22
+
23
+ inherit_gem:
24
+ docquet:
25
+ - config/cops/bundler.yml
26
+ - config/cops/gemspec.yml
27
+ - config/cops/layout.yml
28
+ - config/cops/lint.yml
29
+ - config/cops/metrics.yml
30
+ - config/cops/naming.yml
31
+ - config/cops/performance.yml
32
+ - config/cops/rake.yml
33
+ - config/cops/rspec.yml
34
+ - config/cops/security.yml
35
+ - config/cops/style.yml
36
+ - config/cops/thread_safety.yml
36
37
 
38
+ inherit_from: .rubocop_todo.yml
37
39
 
38
40
  Style/DisableCopsWithinSourceCodeDirective:
39
41
  AllowedCops:
@@ -45,3 +47,10 @@ Style/DocumentationMethod:
45
47
  - AllowedMethods
46
48
  AllowedMethods:
47
49
  - call
50
+
51
+ RSpec/ContextWording:
52
+ inherit_mode:
53
+ merge:
54
+ - Prefixes
55
+ Prefixes:
56
+ - "on"
data/.rubocop_todo.yml CHANGED
@@ -1,7 +1,20 @@
1
1
  # This configuration was generated by
2
2
  # `rubocop --auto-gen-config --no-exclude-limit --no-offense-counts --no-auto-gen-timestamp`
3
- # using RuboCop version 1.72.2.
3
+ # using RuboCop version 1.81.7.
4
4
  # The point is for the user to remove these configuration records
5
5
  # one by one as the offenses are removed from the code base.
6
6
  # Note that changes in the inspected code, or installation of new
7
7
  # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # This cop supports safe autocorrection (--autocorrect).
10
+ # Configuration parameters: AllowedCops.
11
+ Style/DisableCopsWithinSourceCodeDirective:
12
+ Exclude:
13
+ - 'lib/gemoji/cli/commands/list.rb'
14
+
15
+ # Configuration parameters: AllowedMethods, RequireForNonPublicMethods.
16
+ Style/DocumentationMethod:
17
+ Exclude:
18
+ - 'lib/gemoji/cli/commands/filter.rb'
19
+ - 'lib/gemoji/cli/commands/list.rb'
20
+ - 'lib/gemoji/cli/commands/version.rb'
data/CHANGELOG.md CHANGED
@@ -1,4 +1,15 @@
1
1
  ## [Unreleased]
2
2
 
3
+ ## [1.1.1] - 2025-11-02
4
+
5
+ ### Changed
6
+ - Bump minimum version requirement of ruby to 3.2
7
+
8
+ ### Development
9
+ - Use Trusted Publishing for RubyGems releases via GitHub Actions OIDC
10
+
11
+ ## [1.1.0] - 2025-03-06
12
+ - Loosen version requirement of ruby to 3.2.7
13
+
3
14
  ## [1.0.0] - 2025-02-24
4
15
  - Initial release
data/README.md CHANGED
@@ -1,39 +1,84 @@
1
- # Gemoji::Cli
1
+ # gemoji-cli
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ :construction: **This project is under active development** :construction:
4
4
 
5
- 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/gemoji/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ A command-line interface for converting emoji codes to Unicode characters and listing available emojis. Built on top of GitHub's [gemoji](https://github.com/github/gemoji) library, this tool provides an easy way to work with emojis in your terminal.
6
+
7
+ ## Features
8
+
9
+ - :arrows_counterclockwise: Convert GitHub-style emoji codes (`:emoji_name:`) to Unicode characters
10
+ - :page_facing_up: List all available emojis in Markdown or CSV format
11
+ - :computer: Cross-platform support
6
12
 
7
13
  ## Installation
8
14
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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.
15
+ ```bash
16
+ gem install gemoji-cli
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ### Filter Emoji Codes
10
22
 
11
- Install the gem and add to the application's Gemfile by executing:
23
+ Convert emoji codes in standard input to Unicode characters:
12
24
 
13
25
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
26
+ echo "Hello :smile: :wave:" | gemoji filter
27
+ # Output: Hello 😊 👋
15
28
  ```
16
29
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
30
+ This will convert all valid emoji codes (`:emoji_name:`) to their corresponding Unicode characters. Custom emoji codes will remain unchanged.
31
+
32
+ ### List All Emojis
33
+
34
+ Display all available emojis:
18
35
 
19
36
  ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
37
+ gemoji list
21
38
  ```
22
39
 
23
- ## Usage
40
+ By default, this will output a Markdown-formatted table:
24
41
 
25
- TODO: Write usage instructions here
42
+ ```markdown
43
+ | Name | Raw |
44
+ |------|-----|
45
+ | :smile: | 😊 |
46
+ | :wave: | 👋 |
47
+ ...
48
+ ```
49
+
50
+ You can also get the output in CSV format:
51
+
52
+ ```bash
53
+ gemoji list --format=csv
54
+ ```
55
+
56
+ This will output:
57
+
58
+ ```csv
59
+ Name,Raw
60
+ :smile:,😊
61
+ :wave:,👋
62
+ ...
63
+ ```
26
64
 
27
65
  ## Development
28
66
 
29
67
  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.
30
68
 
31
- 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).
69
+ To install this gem onto your local machine, run `bundle exec rake install`.
32
70
 
33
71
  ## Contributing
34
72
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemoji-cli.
73
+ 1. Fork it
74
+ 2. Create your feature branch (`git checkout -b feature/my-new-feature`)
75
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
76
+ 4. Push to the branch (`git push origin feature/my-new-feature`)
77
+ 5. Create a new Pull Request
78
+
79
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sakuro/gemoji-cli.
36
80
 
37
81
  ## License
38
82
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
83
+ The gem is available as open source under the terms of the
84
+ [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile CHANGED
@@ -4,6 +4,6 @@ require "bundler/gem_tasks"
4
4
  require "rspec/core/rake_task"
5
5
 
6
6
  RSpec::Core::RakeTask.new(:spec)
7
- Dir["lib/tasks/*.rake"].each { load it }
7
+ Dir["lib/tasks/*.rake"].each {|file| load file }
8
8
 
9
9
  task default: %i[spec rubocop]
data/TODO.md ADDED
@@ -0,0 +1,45 @@
1
+ # Planned Features for gemoji-cli
2
+
3
+ ## Get Command
4
+
5
+ Retrieve a specific emoji in various formats:
6
+
7
+ ```bash
8
+ # Unicode format (default)
9
+ gemoji get smile
10
+ 😊
11
+
12
+ # HTML entity
13
+ gemoji get smile --format html
14
+ 😊
15
+
16
+ # GitHub markdown
17
+ gemoji get smile --format markdown
18
+ :smile:
19
+ ```
20
+
21
+ ## Info Command
22
+
23
+ Display detailed information about a specific emoji:
24
+
25
+ ```bash
26
+ gemoji info smile
27
+ ```
28
+
29
+ Expected output:
30
+ ```
31
+ Name: smile
32
+ Unicode: 😊
33
+ HTML: 😊
34
+ Markdown: :smile:
35
+ Description: smiling face with smiling eyes
36
+ Aliases: ["blush"]
37
+ Tags: ["happy", "joy", "pleased"]
38
+ ```
39
+
40
+ ## Implementation Notes
41
+
42
+ - Both commands should support fuzzy matching for emoji names
43
+ - Format options for `get` command: unicode (default), html, markdown
44
+ - Info command should display all available metadata from the gemoji library
45
+ - Consider adding support for copying the output to clipboard
data/lib/gemoji/cli/version.rb CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Gemoji
4
4
  module CLI
5
- VERSION = "1.0.0"
5
+ VERSION = "1.1.1"
6
6
  public_constant :VERSION
7
7
  end
8
8
  end
data/mise.toml CHANGED
@@ -1,2 +1,5 @@
1
1
  [env]
2
2
  _.path = ["bin", "exe"]
3
+
4
+ [tools]
5
+ ruby = "3.2"
metadata CHANGED
@@ -1,13 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gemoji-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - OZAWA Sakuro
8
+ autorequire:
8
9
  bindir: exe
9
10
  cert_chain: []
10
- date: 2025-02-24 00:00:00.000000000 Z
11
+ date: 2025-11-02 00:00:00.000000000 Z
11
12
  dependencies:
12
13
  - !ruby/object:Gem::Dependency
13
14
  name: csv
@@ -69,6 +70,7 @@ files:
69
70
  - LICENSE.txt
70
71
  - README.md
71
72
  - Rakefile
73
+ - TODO.md
72
74
  - exe/gemoji
73
75
  - lib/gemoji/cli.rb
74
76
  - lib/gemoji/cli/commands/filter.rb
@@ -86,6 +88,7 @@ metadata:
86
88
  source_code_uri: https://github.com/sakuro/gemoji-cli.git
87
89
  changelog_uri: https://github.com/sakuro/gemoji-cli/blob/main/CHANGELOG.md
88
90
  rubygems_mfa_required: 'true'
91
+ post_install_message:
89
92
  rdoc_options: []
90
93
  require_paths:
91
94
  - lib
@@ -93,14 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
93
96
  requirements:
94
97
  - - ">="
95
98
  - !ruby/object:Gem::Version
96
- version: 3.4.2
99
+ version: 3.2.8
97
100
  required_rubygems_version: !ruby/object:Gem::Requirement
98
101
  requirements:
99
102
  - - ">="
100
103
  - !ruby/object:Gem::Version
101
104
  version: '0'
102
105
  requirements: []
103
- rubygems_version: 3.6.5
106
+ rubygems_version: 3.4.19
107
+ signing_key:
104
108
  specification_version: 4
105
109
  summary: GitHub emoji converter and lister
106
110
  test_files: []