gpt_helpr 0.2.2 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +60 -53
  3. data/lib/gpt_helpr/version.rb +1 -1
  4. metadata +25 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c814003e6048682f0cbbf4985a6bf7a808c3f9ebc9930802c1a77431f9332d66
4
- data.tar.gz: b2d2409169926d3e34a65b508b422a11497b865bd342ec9f010d9433d386798e
3
+ metadata.gz: cfabf37973f5cac3d009a1779db5952d907078952a84327e97f888ba5a9f5aad
4
+ data.tar.gz: 89e3a7625633e972ef758cd6da93d2e9cf9ab67972fffe464c844f6287b7f064
5
5
  SHA512:
6
- metadata.gz: 721f294a118a2c86d3ea80acb3f9b639f575a1a56db1d82dffacc0144e9038fd868f7b126a72a36da139d17dd73030fb87fec81252b3ee65d35e08835b0265f4
7
- data.tar.gz: a493222c91116d543a2992a0d08b4062d6d488be010c0ffff32df87aaf011bd826720642cf70ccf2092d35368a2e9cb6b44c97a23b37182010752df42b9fcd91
6
+ metadata.gz: dffda688f7d9092f86ad498913694f950206c2fd952286bde125575166cc6a0032672657cb674c64f19f15a3ac94ef2eb94606160ef58a445e54ada53d9478c3
7
+ data.tar.gz: 11ac421b0b6eb0c77dd57b62556c079b92b4c48d9d68d91f97b150486fa127dcc6752c8e5e537165b9ec8f7f825892a289e1eebfde0dd442347087fc0b31b825
data/README.md CHANGED
@@ -1,15 +1,17 @@
1
- # GPT_Helpr
1
+ ## == 🏴‍☠️ GptHelpr == Helping to dig your codebase and cook GPT-XX instructions
2
2
 
3
- GPT_Helpr is a Ruby gem that provides a command-line tool for generating formatted programming prompts based on the content of specified files. This tool is particularly useful for efficiently sharing code snippets with detailed explanations.
3
+ ### What is GptHelpr?
4
4
 
5
- ## Features
5
+ It is sometime necessary to provide context and explanations for your code. Instead of manually copying and formatting code snippets, GPT-Helpr automates the process with an interactive cli, generating a well-structured Markdown output, which can be copied to your clipboard or printed to file.
6
+
7
+ ### Features
6
8
 
7
9
  - **Interactive Mode**: Easily specify file paths and ranges interactively.
8
10
  - **Line Numbers**: Option to include line numbers in the output.
9
11
  - **Completion Support**: Supports tab completion for file paths.
10
12
  - **Output to File**: Option to write the generated output to a file.
11
13
 
12
- ## Installation
14
+ ### Installation
13
15
 
14
16
  1. **Add the Gem to Your Gemfile**
15
17
  ```ruby
@@ -26,23 +28,23 @@ GPT_Helpr is a Ruby gem that provides a command-line tool for generating formatt
26
28
  gem install gpt_helpr
27
29
  ```
28
30
 
29
- ## Usage
31
+ ### Usage
30
32
 
31
- ### Basic Usage
33
+ #### Basic Usage
32
34
 
33
35
  Run the tool in interactive mode:
34
36
  ```sh
35
- gpt_helpr --interactive
37
+ gpt_helpr -i -ln
36
38
  ```
37
39
 
38
- ### Command-Line Arguments
40
+ #### Command-Line Arguments
39
41
 
40
42
  You can also provide file paths and instructions directly via command-line arguments:
41
43
  ```sh
42
- gpt_helpr <file1> <re: instructions> / <file2> <re: instructions>
44
+ gpt_helpr <file1> <instructions> / <file2> <instructions>
43
45
  ```
44
46
 
45
- ### Options
47
+ #### Options
46
48
 
47
49
  - `--interactive` or `-i`: Run the tool in interactive mode.
48
50
  - `--file` or `-f`: Write the output to a file.
@@ -52,41 +54,56 @@ gpt_helpr <file1> <re: instructions> / <file2> <re: instructions>
52
54
 
53
55
  #### Interactive Mode
54
56
 
55
- 1. Run the tool:
56
-
57
- ```
58
- ➜ gpt_helpr -i -ln
59
- File path (optional :start:end): TAB ->
60
- Capfile INSTALL.md REVISION bin
61
- Gemfile Procfile Rakefile config
62
- Gemfile.lock Procfile.dev VERSION config.ru
63
- Guardfile README.md app db
64
-
65
- File path (optional :start:end): bin/ TAB ->
66
- bin/bundle bin/db-backup.sh bin/db-restore.sh bin/gpt_helpr bin/rails bin/rake bin/rubocop bin/s3_sync.sh bin/setup bin/update
67
-
68
- File path (optional :start:end): bin/gpt_helpr:9:14
69
- Instructions: can you explain these lines?
70
- File path (optional :start:end):
71
- ```
72
-
73
- 2. The output will be:
74
- ```
75
- #### file source `bin/gpt_helpr`
76
- 9:
77
- 10: Readline.completion_append_character = nil
78
- 11: Readline.completion_proc = -> (input) {
79
- 12: Dir[input+'*'].grep(/^#{Regexp.escape(input)}/)
80
- 13: }
81
- 14:
82
-
83
- can you explain these lines?
57
+ 1. Run the tool in interactive mode:
58
+ ```sh
59
+ # note lmk is an alias for gpt_helpr -i -ln
60
+ $ lmk
61
+ == 🏴‍☠️ GptHelpr 0.2.2 == Helping to dig your codebase and cook GPT-XX instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]
62
+
63
+ File Path (optional :start:end): TAB ->
64
+ favicon.ico hey.md js random-acts-of-pizza.md
65
+ _config.yml _site draft fonts
66
+ images kneading-baking-academy.md _exe academy
67
+ favicon.gif hands-in-dough.md index.md parties-and-events.md
68
+
69
+ File Path (optional :start:end): hey.md 1:22
70
+ Instructions: can you improve this text? Do you see any issues with the template?
71
+ File Path (optional :start:end):
72
+
73
+ # this is the generated output (also copied to the clipboard)
74
+ ==== file source `hey.md 1:22`
75
+
76
+ 1: ---
77
+ 2: title: Hey, hello!
78
+ 3: layout: default
79
+ 4: ---
80
+ 5:
81
+ 6: # {{ page.title }}
82
+ 7: ----
83
+ 8:
84
+ 9: <div class="row">
85
+ 10: <div class="col-md-12">
86
+ 11: <p class='justin'>
87
+ 12: Nice to meet you, I am *Mek*!
88
+ 13: </p>
89
+ 14: <p class='listo'>
90
+ 15: I am a self-proclaimed pizza guru and I am here to teach & learn. Originally from Venice, Italy you can find me in San Diego, CA.
91
+ 16: </p>
92
+ 17: <p class='listo'>
93
+ 18: In my spare time, I write code @ PlayStation!
94
+ 19: </p>
95
+ 20: </div>
96
+ 21: </div>
97
+ 22:
98
+
99
+ can you improve this text? Do you see any issues with the template?
100
+
101
+ ==== end of `hey.md`
102
+ ```
84
103
 
85
- #### end of `bin/gpt_helpr`
86
- ```
87
- 3. You can add more files and instructions in the same way.
104
+ 2. You can add more files and instructions in the same way.
88
105
 
89
- 4. The output will be also copied to the clipboard!
106
+ 3. Profit!
90
107
 
91
108
  #### Command-Line Mode
92
109
 
@@ -100,16 +117,6 @@ File path (optional :start:end):
100
117
  gpt_helpr app/controllers/pos_controller.rb:10:20 "Describe the controller logic" / app/views/pos/index.html.erb "Explain the view template" --file
101
118
  ```
102
119
 
103
- ## Why GPT_Helpr?
104
-
105
- GPT_Helpr is designed to save time and effort when sharing code snippets. It's often necessary to provide context and explanations for the code. Instead of manually copying and formatting code snippets, GPT_Helpr automates the process, generating well-structured Markdown output.
106
-
107
- This can be useful for:
108
-
109
- - **Creating Documentation**: Quickly generate descriptions of code segments for documentation.
110
- - **Sharing Code**: Share specific parts of your codebase with clear descriptions.
111
- - **Teaching and Learning**: Provide examples and explanations of code in a consistent format.
112
-
113
120
  ## Contributing
114
121
 
115
122
  Contributions are welcome! If you have suggestions for improvements or find any issues, please open an issue or create a pull request.
data/lib/gpt_helpr/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module GptHelpr
4
- VERSION = '0.2.2'
4
+ VERSION = '0.2.3'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gpt_helpr
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Emanuele Tozzato
@@ -24,28 +24,30 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: 0.0.3
27
- description: "== What is GptHelpr?\n\nIt is sometime necessary to provide context
27
+ description: "=== What is GptHelpr?\n\nIt is sometime necessary to provide context
28
28
  and explanations for your code. Instead of manually copying and formatting code
29
29
  snippets, GPT-Helpr automates the process with an interactive cli, generating a
30
30
  well-structured Markdown output, which can be copied to your clipboard or printed
31
- to file.\n\n=== Example Usage\n\n```\n#note lmk is an alias for gpt_helpr -i -ln\n\n$
32
- lmk\n== \U0001F3F4‍☠️ GptHelpr 0.2.2 == Helping to dig your codebase and cook GPT-XX
33
- instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]\n\nFile
34
- Path (optional :start:end): TAB ->\nfavicon.ico hey.md js
35
- \ random-acts-of-pizza.md\n_config.yml _site
36
- \ draft fonts\nimages kneading-baking-academy.md
37
- \ _exe academy\nfavicon.gif hands-in-dough.md
38
- \ index.md parties-and-events.md\n\nFile Path (optional
39
- :start:end): hey.md 1:22\nInstructions: can you improve this text? Do you see any
40
- issues with the template?\nFile Path (optional :start:end):\n\n==== file source
41
- \ `hey.md`\n\n1: ---\n2: title: Hey, hello!\n3: layout: default\n4: ---\n5:\n6:
42
- # {{ page.title }}\n7: ----\n8:\n9: <div class=\"row\">\n10: <div class=\"col-md-12\">\n11:
43
- \ <p class='justin'>\n12: Nice to meet you, I am *Mek*!\n13: </p>\n14:
44
- \ <p class='listo'>\n15: I am a self-proclaimed pizza guru and I am here
45
- to teach & learn. Originally from Venice, Italy you can find me in San Diego, CA.\n16:
46
- \ </p>\n17: <p class='listo'>\n18: In my spare time, I write code @
47
- PlayStation!\n19: </p>\n20: </div>\n21: </div>\n22:\n\ncan you improve this
48
- text? Do you see any issues with the template?\n\n==== end of `hey.md`\n```\n"
31
+ to file.\n\n=== Example Usage\n\n # note lmk is an alias for gpt_helpr -i -ln\n
32
+ \ $ lmk\n == \U0001F3F4‍☠️ GptHelpr 0.2.3 == Helping to dig your codebase and cook
33
+ GPT-XX instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]\n\n
34
+ \ File Path (optional :start:end): TAB ->\n favicon.ico hey.md
35
+ \ js random-acts-of-pizza.md\n _config.yml
36
+ \ _site draft fonts\n
37
+ \ images kneading-baking-academy.md _exe academy\n
38
+ \ favicon.gif hands-in-dough.md index.md parties-and-events.md\n\n
39
+ \ File Path (optional :start:end): hey.md 1:22\n Instructions: can you improve
40
+ this text? Do you see any issues with the template?\n File Path (optional :start:end):\n\n
41
+ \ # this is the generated output (also copied to the clipboard)\n ==== file source
42
+ \ `hey.md 1:22`\n\n 1: ---\n 2: title: Hey, hello!\n 3: layout: default\n 4:
43
+ ---\n 5:\n 6: # {{ page.title }}\n 7: ----\n 8:\n 9: <div class=\"row\">\n
44
+ \ 10: <div class=\"col-md-12\">\n 11: <p class='justin'>\n 12: Nice
45
+ to meet you, I am *Mek*!\n 13: </p>\n 14: <p class='listo'>\n 15: I
46
+ am a self-proclaimed pizza guru and I am here to teach & learn. Originally from
47
+ Venice, Italy you can find me in San Diego, CA.\n 16: </p>\n 17: <p class='listo'>\n
48
+ \ 18: In my spare time, I write code @ PlayStation!\n 19: </p>\n 20:
49
+ \ </div>\n 21: </div>\n 22:\n\n can you improve this text? Do you see any issues
50
+ with the template?\n\n ==== end of `hey.md`\n\n"
49
51
  email:
50
52
  - etozzato@gmail.com
51
53
  executables:
@@ -62,11 +64,11 @@ files:
62
64
  - lib/gpt_helpr.rb
63
65
  - lib/gpt_helpr/cli.rb
64
66
  - lib/gpt_helpr/version.rb
65
- homepage: https://etozzato.com
67
+ homepage: https://www.etozzato.com
66
68
  licenses:
67
69
  - MIT
68
70
  metadata:
69
- homepage_uri: https://etozzato.com
71
+ homepage_uri: https://www.etozzato.com
70
72
  source_code_uri: https://github.com/etozzato/gpt-helpr
71
73
  changelog_uri: https://github.com/etozzato/gpt-helpr/blob/main/CHANGELOG.md
72
74
  rubygems_mfa_required: 'true'
@@ -88,6 +90,6 @@ requirements: []
88
90
  rubygems_version: 3.5.14
89
91
  signing_key:
90
92
  specification_version: 4
91
- summary: "== \U0001F3F4‍☠️ GptHelpr 0.2.2 == Helping to dig your codebase and cook
93
+ summary: "== \U0001F3F4‍☠️ GptHelpr 0.2.3 == Helping to dig your codebase and cook
92
94
  GPT-XX instructions"
93
95
  test_files: []