class Jekyll::Commands::New

Public Class Methods

blank_template() click to toggle source
# File lib/jekyll/commands/new.rb, line 43
def blank_template
  File.expand_path("../../blank_template", __dir__)
end
create_blank_site(path) click to toggle source
# File lib/jekyll/commands/new.rb, line 47
def create_blank_site(path)
  FileUtils.cp_r blank_template + "/.", path
  FileUtils.chmod_R "u+w", path

  Dir.chdir(path) do
    FileUtils.mkdir(%w(_data _drafts _includes _posts))
  end
end
init_with_program(prog) click to toggle source
# File lib/jekyll/commands/new.rb, line 9
def init_with_program(prog)
  prog.command(:new) do |c|
    c.syntax "new PATH"
    c.description "Creates a new Jekyll site scaffold in PATH"

    c.option "force", "--force", "Force creation even if PATH already exists"
    c.option "blank", "--blank", "Creates scaffolding but with empty files"

    c.action do |args, options|
      Jekyll::Commands::New.process(args, options)
    end
  end
end
initialized_post_name() click to toggle source

Internal: Gets the filename of the sample post to be created

Returns the filename of the sample post, as a String

# File lib/jekyll/commands/new.rb, line 63
def initialized_post_name
  "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.markdown"
end
process(args, options = {}) click to toggle source
# File lib/jekyll/commands/new.rb, line 23
def process(args, options = {})
  raise ArgumentError, "You must specify a path." if args.empty?

  new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
  FileUtils.mkdir_p new_blog_path
  if preserve_source_location?(new_blog_path, options)
    Jekyll.logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
    Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else try again " \
                                 "with `--force` to proceed and overwrite any files."
  end

  if options["blank"]
    create_blank_site new_blog_path
  else
    create_site new_blog_path
  end

  after_install(new_blog_path, options)
end
scaffold_post_content() click to toggle source
# File lib/jekyll/commands/new.rb, line 56
def scaffold_post_content
  ERB.new(File.read(File.expand_path(scaffold_path, site_template))).result
end

Private Class Methods

after_install(path, options = {}) click to toggle source

After a new blog has been created, print a success notification

# File lib/jekyll/commands/new.rb, line 134
def after_install(path, options = {})
  Jekyll.logger.info "New jekyll site installed in #{path.cyan}."
end
create_sample_files(path) click to toggle source
# File lib/jekyll/commands/new.rb, line 119
def create_sample_files(path)
  FileUtils.cp_r site_template + "/.", path
  FileUtils.chmod_R "u+w", path
  FileUtils.rm File.expand_path(scaffold_path, path)
end
create_site(new_blog_path) click to toggle source
# File lib/jekyll/commands/new.rb, line 107
def create_site(new_blog_path)
  create_sample_files new_blog_path

  File.write(File.expand_path(initialized_post_name, new_blog_path), scaffold_post_content)

  File.write(File.expand_path("Gemfile", new_blog_path), gemfile_contents)
end
gemfile_contents() click to toggle source
# File lib/jekyll/commands/new.rb, line 69
        def gemfile_contents
          <<~RUBY
            source "https://rubygems.org"
            # Hello! This is where you manage which Jekyll version is used to run.
            # When you want to use a different version, change it below, save the
            # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
            #
            #     bundle exec jekyll serve
            #
            # This will help ensure the proper Jekyll version is running.
            # Happy Jekylling!
            gem "jekyll", "~> #{Jekyll::VERSION}"
            # This is the default theme for new Jekyll sites. You may change this to anything you like.
            gem "minima", "~> 2.5"
            # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
            # uncomment the line below. To upgrade, run `bundle update github-pages`.
            # gem "github-pages", group: :jekyll_plugins
            # If you have any plugins, put them here!
            group :jekyll_plugins do
              gem "jekyll-feed", "~> 0.12"
            end

            # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
            # and associated library.
            platforms :mingw, :x64_mingw, :mswin, :jruby do
              gem "tzinfo", ">= 1", "< 3"
              gem "tzinfo-data"
            end

            # Performance-booster for watching directories on Windows
            gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

            # Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
            # do not have a Java counterpart.
            gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
          RUBY
        end
preserve_source_location?(path, options) click to toggle source
# File lib/jekyll/commands/new.rb, line 115
def preserve_source_location?(path, options)
  !options["force"] && !Dir["#{path}/**/*"].empty?
end
scaffold_path() click to toggle source
# File lib/jekyll/commands/new.rb, line 129
def scaffold_path
  "_posts/0000-00-00-welcome-to-jekyll.markdown.erb"
end
site_template() click to toggle source
# File lib/jekyll/commands/new.rb, line 125
def site_template
  File.expand_path("../../site_template", __dir__)
end