-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfile.new.html
120 lines (77 loc) · 4.57 KB
/
file.new.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE html>
<html>
<head>
<link rel="shortcut icon" href="/favicon.png" />
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: CLI: discorb new
— discorb v0.20.0 documentation
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "new";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="a_index.html">Index</a> »
<span class="title">File: CLI: discorb new</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'>
<h1 id="label-discorb+new">discorb new</h1>
<p>This command will create a new project in the directory.</p>
<h2 id="label-Usage">Usage</h2>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_discorb'>discorb</span> <span class='id identifier rubyid_new'>new</span> <span class='lbracket'>[</span><span class='id identifier rubyid_options'>options</span><span class='rbracket'>]</span> <span class='lbracket'>[</span><span class='id identifier rubyid_dir'>dir</span><span class='rbracket'>]</span>
</code></pre>
<h2 id="label-Options">Options</h2>
<h3 id="label-dir"><code>dir</code></h3>
<p>The directory to create the project in. Defaults to the current directory. If the directory exists and is not empty, an error is returned. You can use <code>--force</code> to overwrite an existing directory.</p>
<h3 id="label---5Bno--5Dbundle"><code>--[no-]bundle</code></h3>
<p>Whether to use bundle. If true, the command will create Gemfile and execute <code>bundle install</code>. Default to true.</p>
<h3 id="label---5Bno--5Dgit"><code>--[no-]git</code></h3>
<p>Whether to initialize git. If true, the command will initialize git and commit the initial files with commit message <code>Initial commit</code>. Use <code>git commit --amend -m "..."</code> to change the commit message. Default to false.</p>
<h3 id="label---5Bno--5Ddesc"><code>--[no-]desc</code></h3>
<p>Whether to create a description file. If true, the command will create a <code>.env.sample</code> and <code>README.md</code> file. Default to false.</p>
<h3 id="label-n+--name"><code>-n</code> <code>--name</code></h3>
<p>The name of the project. It will be used in the <code>README.md</code> file. Default to the directory name.</p>
<h3 id="label-t-2C+--token"><code>-t</code>, <code>--token</code></h3>
<p>The name of token environment variable. Default to TOKEN.</p>
<h3 id="label-f-2C+--force"><code>-f</code>, <code>--force</code></h3>
<p>Whether to overwrite an existing directory. Default to false.</p>
<h3 id="label---5Bno--5Dcomment"><code>--[no-]comment</code></h3>
<p>Whether to write comment in main.rb. Default to true.</p>
<h2 id="label-File+structure">File structure</h2>
<p>The following files will be created:</p>
<p>| File | Description | | ————– | ——————————————————————– | | <code>.env</code> | Environment variables. | | <code>main.rb</code> | Main script. | | <code>.gitignore</code> | Git ignore file. Won't be created if <code>--git</code> is false. | | <code>Gemfile</code> | Gemfile. Won't be created if <code>--bundle</code> is false. | | <code>Gemfile.lock</code> | Gemfile lock file. Won't be created if <code>--bundle</code> is false. | | <code>README.md</code> | Readme file. Won't be created if <code>--desc</code> is false. | | <code>.env.sample</code> | Sample environment variables. Won't be created if <code>--desc</code> is false. |</p>
</div></div>
<div id="footer">
Generated on Sat Sep 3 22:19:56 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.2).
</div>
</div>
</body>
</html>