Skip to content

Commit 144778e

Browse files
ashmaroliashmaroli
authored
Define CLI option descriptions consistently (#496)
Merge pull request 496
1 parent 7bfad93 commit 144778e

File tree

20 files changed

+115
-115
lines changed

20 files changed

+115
-115
lines changed

‎lib/jekyll-import/importers/blogger.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ module Importers
55
class Blogger < Importer
66
def self.specify_options(c)
77
c.option "source", "--source NAME", "The XML file (blog-MM-DD-YYYY.xml) path to import"
8-
c.option "no-blogger-info", "--no-blogger-info", "not to leave blogger-URL info (id and old URL) in the front matter (default: false)"
8+
c.option "no-blogger-info", "--no-blogger-info", "not to leave blogger-URL info (id and old URL) in the front matter. (default: false)"
99
c.option "replace-internal-link", "--replace-internal-link", "replace internal links using the post_url liquid tag. (default: false)"
10-
c.option "comments", "--comments", "import comments to _comments collection"
10+
c.option "comments", "--comments", "import comments to _comments collection. (default: false)"
1111
end
1212

1313
def self.validate(options)

‎lib/jekyll-import/importers/csv.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ def self.require_deps
1212
end
1313

1414
def self.specify_options(c)
15-
c.option "file", "--file NAME", 'The CSV file to import (default: "posts.csv")'
16-
c.option "no-front-matter", "--no-front-matter", "Do not add the default front matter to the post body"
15+
c.option "file", "--file NAME", "The CSV file to import. (default: 'posts.csv')"
16+
c.option "no-front-matter", "--no-front-matter", "Do not add the default front matter to the post body. (default: false)"
1717
end
1818

1919
# Reads a csv with title, permalink, body, published_at, and filter.

‎lib/jekyll-import/importers/drupal_common.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ module ClassMethods
2323
}.freeze
2424

2525
def specify_options(c)
26-
c.option "engine", "--engine [mysql|postgresql]", "Database engine (default: #{DEFAULTS["engine"].inspect})"
2726
c.option "dbname", "--dbname DB", "Database name"
2827
c.option "user", "--user USER", "Database user name"
28+
c.option "engine", "--engine [mysql|postgresql]", "Database engine (default: #{DEFAULTS["engine"].inspect})"
2929
c.option "password", "--password PW", "Database user's password (default: #{DEFAULTS["password"].inspect})"
3030
c.option "host", "--host HOST", "Database host name (default: #{DEFAULTS["host"].inspect})"
3131
c.option "port", "--port PORT", "Database port name (default: #{DEFAULTS["port"].inspect})"
@@ -47,9 +47,9 @@ def require_deps
4747
end
4848

4949
def process(options)
50-
engine = options.fetch("engine", DEFAULTS["engine"])
5150
dbname = options.fetch("dbname")
5251
user = options.fetch("user")
52+
engine = options.fetch("engine", DEFAULTS["engine"])
5353
pass = options.fetch("password", DEFAULTS["password"])
5454
host = options.fetch("host", DEFAULTS["host"])
5555
port = options.fetch("port", DEFAULTS["port"])

‎lib/jekyll-import/importers/easyblog.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ def self.validate(options)
1010
end
1111

1212
def self.specify_options(c)
13-
c.option "dbname", "--dbname", "Database name"
14-
c.option "user", "--user", "Database user name"
15-
c.option "password", "--password", "Database user's password (default: '')"
16-
c.option "host", "--host", "Database host name"
17-
c.option "section", "--section", "Table prefix name"
18-
c.option "prefix", "--prefix", "Table prefix name"
13+
c.option "dbname", "--dbname", "Database name."
14+
c.option "user", "--user", "Database user name."
15+
c.option "password", "--password", "Database user's password. (default: '')"
16+
c.option "host", "--host", "Database host name. (default: 'localhost')"
17+
c.option "section", "--section", "Section ID. (default: '1')"
18+
c.option "prefix", "--prefix", "Table prefix name. (default: 'jos_')"
1919
end
2020

2121
def self.require_deps

‎lib/jekyll-import/importers/enki.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ def self.validate(options)
2020
end
2121

2222
def self.specify_options(c)
23-
c.option "dbname", "--dbname", "Database name"
24-
c.option "user", "--user", "Database name"
25-
c.option "password", "--password", 'Database name (default: "")'
26-
c.option "host", "--host", "Database name"
23+
c.option "dbname", "--dbname", "Database name."
24+
c.option "user", "--user", "User name."
25+
c.option "password", "--password", "Database password. (default: '')"
26+
c.option "host", "--host", "Database host name. (default: 'localhost')"
2727
end
2828

2929
def self.require_deps

‎lib/jekyll-import/importers/joomla.rb‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ def self.validate(options)
1010
end
1111

1212
def self.specify_options(c)
13-
c.option "dbname", "--dbname", "Database name"
14-
c.option "user", "--user", "Database user name"
15-
c.option "password", "--password", "Database user's password (default: '')"
16-
c.option "host", "--host", "Database host name"
17-
c.option "port", "--port", "Database port"
18-
c.option "section", "--section", "Table prefix name"
19-
c.option "prefix", "--prefix", "Table prefix name"
13+
c.option "dbname", "--dbname", "Database name."
14+
c.option "user", "--user", "Database user name."
15+
c.option "password", "--password", "Database user's password. (default: '')"
16+
c.option "host", "--host", "Database host name. (default: 'localhost')"
17+
c.option "port", "--port", "Database port. (default: '3306')"
18+
c.option "section", "--section", "Section ID. (default: '1')"
19+
c.option "prefix", "--prefix", "Table prefix name. (default: 'jos_')"
2020
end
2121

2222
def self.require_deps

‎lib/jekyll-import/importers/joomla3.rb‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ def self.validate(options)
1010
end
1111

1212
def self.specify_options(c)
13-
c.option "dbname", "--dbname", "Database name"
14-
c.option "user", "--user", "Database user name"
15-
c.option "password", "--password", "Database user's password (default: '')"
16-
c.option "host", "--host", "Database host name"
17-
c.option "port", "--port", "Database port"
18-
c.option "category", "--category", "ID of the category"
19-
c.option "prefix", "--prefix", "Table prefix name"
13+
c.option "dbname", "--dbname", "Database name."
14+
c.option "user", "--user", "Database user name."
15+
c.option "password", "--password", "Database user's password. (default: '')"
16+
c.option "host", "--host", "Database host name. (default: 'localhost')"
17+
c.option "port", "--port", "Database port. (default: '3306')"
18+
c.option "category", "--category", "ID of the category. (default: '0')"
19+
c.option "prefix", "--prefix", "Table prefix name. (default: 'jos_')"
2020
end
2121

2222
def self.require_deps

‎lib/jekyll-import/importers/jrnl.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ def self.require_deps
1212
end
1313

1414
def self.specify_options(c)
15-
c.option "file", "--file FILENAME", 'Journal file (default: "~/journal.txt")'
16-
c.option "time_format", "--time_format FORMAT", 'Time format of your journal (default: "%Y-%m-%d %H:%M")'
17-
c.option "extension", "--extension EXT", 'Output extension (default: "md")'
18-
c.option "layout", "--layout NAME", 'Output post layout (default: "post")'
15+
c.option "file", "--file FILENAME", "Journal file. (default: '~/journal.txt')"
16+
c.option "time_format", "--time_format FORMAT", "Time format of your journal. (default: '%Y-%m-%d %H:%M')"
17+
c.option "extension", "--extension EXT", "Output extension. (default: 'md')"
18+
c.option "layout", "--layout NAME", "Output post layout. (default: 'post')"
1919
end
2020

2121
# Reads a jrnl file and creates a new post for each entry

‎lib/jekyll-import/importers/marley.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def self.require_deps
2828
end
2929

3030
def self.specify_options(c)
31-
c.option "marley_data_dir", "--marley_data_dir DIR", "The dir containing your marley data"
31+
c.option "marley_data_dir", "--marley_data_dir DIR", "The dir containing your marley data."
3232
end
3333

3434
def self.process(options)

‎lib/jekyll-import/importers/mephisto.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def self.specify_options(c)
4040
c.option "dbname", "--dbname DB", "Database name"
4141
c.option "user", "--user USER", "Database user name"
4242
c.option "password", "--password PW", "Database user's password (default: '')"
43-
c.option "host", "--host HOST", 'Database host name (default: "localhost")'
43+
c.option "host", "--host HOST", "Database host name (default: 'localhost')"
4444
end
4545

4646
# This query will pull blog posts from all entries across all blogs. If

0 commit comments

Comments
 (0)