discorb 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d97cbcd0255e87b6c45af8b461e5400f78bd735b9f4f5ddaad9ea4f3913b542
-  data.tar.gz: 42fcc4705d437c4dd4f832d714420e17db218d301028600dfa6cfa7dc72b462e
+  metadata.gz: c4197e97af48fc47c1062d0327ccc048cb8317701be673a2bce035b108f7cade
+  data.tar.gz: 7c48b69868636ca4722e3ec2aee50bb6148174c1cfdcf0b31a2d227110aefa76
 SHA512:
-  metadata.gz: 2b06a2eb2046449644887b76ba5b38e14e66cbd106980e1e844bcc486ba4f036ca0bb3759ba6f871b2336efbee09a6313ad167dd5bf740f557496f97610ee668
-  data.tar.gz: e7a57666793b221788ddee034558bf9439deb8a537839491f9fa07b148d7789284e9c05228f103b0cb71c835fd5f9e5f4f8e3aa2627ff9867ac535d26390ff45
+  metadata.gz: 7215a8dc3b0c3502f1948838aac8c08cc0ae0ac4c7c874dcc695c48fc5ead628f36718f08e7e2854aa46f191e9f0c851ff23a6f96aa82edaa3c7d7c912ff490b
+  data.tar.gz: 7ade9dcd2e56efb2513928a021d0f557d827a230b02f2c23ee6691cc9decc919f2e51b19e9e95fab13f535e8cc112cc8f3a29ac36e3a2144651a625e60ea0e25

data/Changelog.md

@@ -186,4 +186,8 @@ end
 - Add: Add `Member#guild_permissions` as alias of `Member#permissions`
 - Add: Add default role to `Member#roles`
 - Fix: Fix error in `Integration#_set_data`
-- Change: Reverse `Member#roles`
+- Change: Reverse `Member#roles`
+
+## 0.7.3
+
+- Add: Improve `discorb init`

data/docs/cli/init.md

@@ -32,6 +32,18 @@ If true, the command will initialize git and commit the initial files with commi
 Use `git commit --amend -m "..."` to change the commit message.
 Default to false.
 
+### `--[no-]desc`
+
+Whether to create a description file.
+If true, the command will create a `.env.sample` and `README.md` file.
+Default to false.
+
+### `-n` `--name`
+
+The name of the project.
+It will be used in the `README.md` file.
+Default to the directory name.
+
 ### `-t`, `--token`
 
 The name of token environment variable.
@@ -49,7 +61,9 @@ The following files will be created:
 | File | Description |
 | ---- | ----------- |
 | `.env` | Environment variables. |
+| `main.rb` | Main script. |
 | `.gitignore` | Git ignore file. Won't be created if `--git` is false. |
 | `Gemfile` | Gemfile. Won't be created if `--bundle` is false. |
 | `Gemfile.lock` | Gemfile lock file. Won't be created if `--bundle` is false. |
-| `main.rb` | Main script. |
+| `README.md` | Readme file. Won't be created if `--desc` is false. |
+| `.env.sample` | Sample environment variables. Won't be created if `--desc` is false. |

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/exe/init.rb

@@ -96,11 +96,46 @@ FILES = {
     gem "discorb", "~> #{Discorb::VERSION}"
     gem "dotenv", "~> 2.7"
   RUBY
+  ".env.sample" => <<~BASH,
+    %<token>s=
+  BASH
+  "README.md" => <<~MARKDOWN,
+    # %<name>s
+
+    Welcome to your bot: %<name>s!
+
+    TODO: Write your bot's description here.
+
+    ## Usage
+
+    TODO: Write your bot's usage here.
+
+    ## Features
+
+    TODO: Write your bot's features here.
+
+    ## How to host
+
+    1. Clone the repository.
+    2. Run `bundle install`.
+    3. Get your bot's token from the Discord developer portal.
+    4. Copy `.env.sample` to `.env` and fill in the token.
+    5. Run `bundle exec discorb run`.
+
+    TODO: Write your own customizations here.
+
+    ## License
+
+    TODO: Write your bot's license here.
+      See https://choosealicense.com/ for more information.
+      https://rubygems.org/gems/license-cli may be useful.
+
+  MARKDOWN
 }
 
 # @!visibility private
 def create_file(name)
-  File.write($path + "/#{name}", format(FILES[name], token: $values[:token]), mode: "wb")
+  File.write($path + "/#{name}", format(FILES[name], token: $values[:token], name: $values[:name]), mode: "wb")
 end
 
 # @!visibility private
@@ -132,6 +167,14 @@ def git_init
           " to change commit message of initial commit.\n"
 end
 
+# @!visibility private
+def make_descs
+  iputs "Making descriptions..."
+  create_file(".env.sample")
+  create_file("README.md")
+  sputs "Made descriptions.\n"
+end
+
 opt = OptionParser.new <<~BANNER
                          A tool to make a new project.
 
@@ -145,6 +188,8 @@ $values = {
   git: false,
   force: false,
   token: "TOKEN",
+  descs: false,
+  name: nil,
 }
 
 opt.on("--[no-]bundle", "Whether to use bundle. Default to true.") do |v|
@@ -155,10 +200,18 @@ opt.on("--[no-]git", "Whether to initialize git. Default to false.") do |v|
   $values[:git] = v
 end
 
+opt.on("--[no-]descs", "Whether to put some file for description. Default to false.") do |v|
+  $values[:descs] = v
+end
+
 opt.on("-t NAME", "--token NAME", "The name of token environment variable. Default to TOKEN.") do |v|
   $values[:token] = v
 end
 
+opt.on("-n NAME", "--name NAME", "The name of your project. Default to the directory name.") do |v|
+  $values[:name] = v
+end
+
 opt.on("-f", "--force", "Whether to force use directory. Default to false.") do |v|
   $values[:force] = v
 end
@@ -187,10 +240,14 @@ if (dir = ARGV[0])
   Dir.chdir($path)
 end
 
+$values[:name] ||= Dir.pwd.split("/").last
+
 bundle_init if $values[:bundle]
 
 make_files
 
 git_init if $values[:git]
 
+make_descs if $values[:descs]
+
 sputs "\nSuccessfully made a new project at \e[32m#{$path}\e[92m."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - sevenc-nanashi