TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typos, change placeholder name

Browse Source
This commit is contained in:
Chris de Graaf 2017-08-18 16:08:48 -05:00
parent 3cf0ce6652
commit 61b44a285d
10 changed files with 57 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,4 +1,4 @@
Copyright (c) 2017 Invenia Technical Computing Corporation Copyright (c) 2017 Chris de Graaf, Invenia Technical Computing Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

22
README.md
View File

@ -1,10 +1,10 @@
# PkgTemplates # PkgTemplates
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://invenia.github.io/PkgTemplates.jl/stable) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://christopher-dG.github.io/PkgTemplates.jl/stable)
[![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.github.io/PkgTemplates.jl/latest) [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://christopher-dG.github.io/PkgTemplates.jl/latest)
[![Build Status](https://travis-ci.org/invenia/PkgTemplates.jl.svg?branch=master)](https://travis-ci.org/invenia/PkgTemplates.jl) [![Build Status](https://travis-ci.org/christopher-dG/PkgTemplates.jl.svg?branch=master)](https://travis-ci.org/christopher-dG/PkgTemplates.jl)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/invenia/PkgTemplates.jl?svg=true)](https://ci.appveyor.com/project/invenia/PkgTemplates-jl) [![Build Status](https://ci.appveyor.com/api/projects/status/github/christopher-dG/PkgTemplates.jl?svg=true)](https://ci.appveyor.com/project/christopher-dG/PkgTemplates-jl)
[![CodeCov](https://codecov.io/gh/invenia/PkgTemplates.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/invenia/PkgTemplates.jl) [![CodeCov](https://codecov.io/gh/christopher-dG/PkgTemplates.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/christopher-dG/PkgTemplates.jl)
**PkgTemplates is a Julia package for creating new Julia packages in an easy, **PkgTemplates is a Julia package for creating new Julia packages in an easy,
repeatable, and customizable way.** repeatable, and customizable way.**
@ -23,12 +23,12 @@ The simplest template only requires your GitHub username.
```julia ```julia
julia> using PkgTemplates julia> using PkgTemplates
julia> t = Template(; user="invenia") julia> t = Template(; user="christopher-dG")
julia> generate("MyPkg", t) julia> generate("MyPkg", t)
INFO: Initialized git repo at /tmp/tmpvaHVki/MyPkg INFO: Initialized git repo at /tmp/tmpvaHVki/MyPkg
INFO: Made initial empty commit INFO: Made initial empty commit
INFO: Set remote origin to https://github.com/invenia/MyPkg.jl INFO: Set remote origin to https://github.com/christopher-dG/MyPkg.jl
INFO: Staged 5 files/directories: src/, test/, REQUIRE, .gitignore, README.md INFO: Staged 5 files/directories: src/, test/, REQUIRE, .gitignore, README.md
INFO: Committed files generated by PkgTemplates INFO: Committed files generated by PkgTemplates
INFO: Moving temporary package directory into /home/degraafc/.julia/v0.6/ INFO: Moving temporary package directory into /home/degraafc/.julia/v0.6/
@ -47,7 +47,7 @@ However, we can also configure a number of keyword arguments to `Template` and
```julia ```julia
julia> t = Template(; julia> t = Template(;
user="invenia", user="christopher-dG",
license="MIT", license="MIT",
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"], authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
years="2016-2017", years="2016-2017",
@ -68,7 +68,7 @@ julia> generate("MyPkg", t; force=true, ssh=true)
INFO: Initialized git repo at /tmp/tmpe0dWY5/MyPkg INFO: Initialized git repo at /tmp/tmpe0dWY5/MyPkg
INFO: Applying git configuration INFO: Applying git configuration
INFO: Made initial empty commit INFO: Made initial empty commit
INFO: Set remote origin to git@github.com:invenia/MyPkg.jl.git INFO: Set remote origin to git@github.com:christopher-dG/MyPkg.jl.git
INFO: Created empty gh-pages branch INFO: Created empty gh-pages branch
INFO: Staged 9 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE, .travis.yml, .appveyor.yml, docs/ INFO: Staged 9 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE, .travis.yml, .appveyor.yml, docs/
INFO: Committed files generated by PkgTemplates INFO: Committed files generated by PkgTemplates
@ -91,7 +91,7 @@ test/runtests.jl
``` ```
Information on each keyword as well as plugin types can be found in the Information on each keyword as well as plugin types can be found in the
[documentation](https://invenia.github.io/PkgTemplates.jl/stable). [documentation](https://christopher-dG.github.io/PkgTemplates.jl/stable).
## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl) ## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl)
@ -105,4 +105,4 @@ features that `PkgTemplates` doesn't include, you are encouraged to use
It's extremely easy to extend `PkgTemplates` with new plugins. To get started, It's extremely easy to extend `PkgTemplates` with new plugins. To get started,
check out the check out the
[plugin development guide](https://invenia.github.io/PkgTemplates.jl/stable/pages/plugin_development.html). [plugin development guide](https://chrostipher-dG.github.io/PkgTemplates.jl/stable/pages/plugin_development.html).

8
docs/make.jl
View File

@ -1,6 +1,6 @@
using Documenter, PkgTemplates using Documenter, PkgTemplates
makedocs( makedocs(;
modules=[PkgTemplates], modules=[PkgTemplates],
format=:html, format=:html,
pages=[ pages=[
@ -13,14 +13,14 @@ makedocs(
], ],
repo="https://github.com/christopher-dG/PkgTemplates.jl/blob/{commit}{path}#L{line}", repo="https://github.com/christopher-dG/PkgTemplates.jl/blob/{commit}{path}#L{line}",
sitename="PkgTemplates.jl", sitename="PkgTemplates.jl",
authors="Invenia Technical Computing Corporation", authors="Chris de Graaf, Invenia Technical Computing Corporation",
assets=[ assets=[
"assets/invenia.css", "assets/invenia.css",
], ],
) )
deploydocs( deploydocs(;
repo="github.com/christopher-dG/PkgTemplates.jl.git", repo="github.com/christopher-dG/PkgTemplates.jl",
target="build", target="build",
julia="0.6", julia="0.6",
deps=nothing, deps=nothing,

14
docs/src/index.md
View File

@ -1,10 +1,10 @@
# PkgTemplates # PkgTemplates
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://invenia.github.io/PkgTemplates.jl/stable) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://christopher-dG.github.io/PkgTemplates.jl/stable)
[![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.github.io/PkgTemplates.jl/latest) [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://christopher-dG.github.io/PkgTemplates.jl/latest)
[![Build Status](https://travis-ci.org/invenia/PkgTemplates.jl.svg?branch=master)](https://travis-ci.org/invenia/PkgTemplates.jl) [![Build Status](https://travis-ci.org/christopher-dG/PkgTemplates.jl.svg?branch=master)](https://travis-ci.org/christopher-dG/PkgTemplates.jl)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/invenia/PkgTemplates.jl?svg=true)](https://ci.appveyor.com/project/invenia/PkgTemplates-jl) [![Build Status](https://ci.appveyor.com/api/projects/status/github/christopher-dG/PkgTemplates.jl?svg=true)](https://ci.appveyor.com/project/christopher-dG/PkgTemplates-jl)
[![CodeCov](https://codecov.io/gh/invenia/PkgTemplates.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/invenia/PkgTemplates.jl) [![CodeCov](https://codecov.io/gh/christopher-dG/PkgTemplates.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/christopher-dG/PkgTemplates.jl)
**PkgTemplates is a Julia package for creating new Julia packages in an easy, **PkgTemplates is a Julia package for creating new Julia packages in an easy,
repeatable, and customizable way.** repeatable, and customizable way.**
@ -22,7 +22,7 @@ The simplest template only requires your GitHub username.
```@repl ```@repl
using PkgTemplates using PkgTemplates
t = Template(; user="invenia") t = Template(; user="christopher-dG")
generate("MyPkg", t) generate("MyPkg", t)
cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`) cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`)
``` ```
@ -33,7 +33,7 @@ However, we can also configure a number of keyword arguments to [`Template`](@re
```@repl ```@repl
using PkgTemplates using PkgTemplates
t = Template(; t = Template(;
user="invenia", user="christopher-dG",
license="MIT", license="MIT",
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"], authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
years="2016-2017", years="2016-2017",

2
docs/src/pages/licenses.md
View File

@ -4,7 +4,7 @@ CurrentModule = PkgTemplates
# Licenses # Licenses
[Many open-source licenses](https://github.com/invenia/PkgTemplates.jl/tree/master/licenses) [Many open-source licenses](https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses)
are available for use with `PkgTemplates`, but if you see that one is missing, are available for use with `PkgTemplates`, but if you see that one is missing,
don't hesitate to open an issue or PR. don't hesitate to open an issue or PR.

2
src/generate.jl
View File

@ -34,7 +34,7 @@ function generate(
if !force && ispath(pkg_dir) if !force && ispath(pkg_dir)
throw(ArgumentError( throw(ArgumentError(
"Something already exists at $pkg_dir, use force=true to overwrite it." "Path '$pkg_dir' already exists, use force=true to overwrite it."
)) ))
end end

2
src/plugin.jl
View File

@ -38,7 +38,7 @@ Generic plugins are plugins that add any number of patterns to the generated pac
new( new(
["*.mgp"], ["*.mgp"],
config_file, config_file,
".mypugin.yml", ".myplugin.yml",
[ [
Badge( Badge(
"My Plugin", "My Plugin",

2
src/plugins/documenter.jl
View File

@ -35,7 +35,7 @@ function gen_plugin(plugin::Documenter, template::Template, pkg_name::AbstractSt
text = """ text = """
using Documenter, $pkg_name using Documenter, $pkg_name
makedocs( makedocs(;
modules=[$pkg_name], modules=[$pkg_name],
format=:html, format=:html,
pages=[ pages=[

2
src/plugins/githubpages.jl
View File

@ -50,7 +50,7 @@ function gen_plugin(plugin::GitHubPages, template::Template, pkg_name::AbstractS
file, file,
""" """
deploydocs( deploydocs(;
repo="github.com/$(template.user)/$pkg_name.jl", repo="github.com/$(template.user)/$pkg_name.jl",
target="build", target="build",
julia="0.6", julia="0.6",

57
test/tests.jl
View File

@ -9,6 +9,7 @@ end
struct Bar <: CustomPlugin end struct Bar <: CustomPlugin end
struct Baz <: Plugin end struct Baz <: Plugin end
const me = "christopher-dG"
const git_config = Dict( const git_config = Dict(
"user.name" => "Tester McTestFace", "user.name" => "Tester McTestFace",
"user.email" => "email@web.site", "user.email" => "email@web.site",
@ -29,9 +30,9 @@ template_text = """
write(test_file, template_text) write(test_file, template_text)
@testset "Template creation" begin @testset "Template creation" begin
t = Template(; user="invenia") t = Template(; user=me)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.user == "invenia" @test t.user == me
@test t.license == nothing @test t.license == nothing
@test t.years == string(Dates.year(Dates.today())) @test t.years == string(Dates.year(Dates.today()))
@test t.authors == LibGit2.getconfig("user.name", "") @test t.authors == LibGit2.getconfig("user.name", "")
@ -40,50 +41,50 @@ write(test_file, template_text)
@test isempty(t.git_config) @test isempty(t.git_config)
@test isempty(t.plugins) @test isempty(t.plugins)
t = Template(; user="invenia", license="MIT") t = Template(; user=me, license="MIT")
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.license == "MIT" @test t.license == "MIT"
t = Template(; user="invenia", years=2014) t = Template(; user=me, years=2014)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.years == "2014" @test t.years == "2014"
t = Template(user="invenia", years="2014-2015") t = Template(user=me, years="2014-2015")
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.years == "2014-2015" @test t.years == "2014-2015"
t = Template(; user="invenia", authors="Some Guy") t = Template(; user=me, authors="Some Guy")
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.authors == "Some Guy" @test t.authors == "Some Guy"
t = Template(; user="invenia", authors=["Guy", "Gal"]) t = Template(; user=me, authors=["Guy", "Gal"])
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.authors == "Guy, Gal" @test t.authors == "Guy, Gal"
t = Template(; user="invenia", dir=test_file) t = Template(; user=me, dir=test_file)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.dir == test_file @test t.dir == test_file
t = Template(; user="invenia", julia_version=v"0.1.2") t = Template(; user=me, julia_version=v"0.1.2")
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.julia_version == v"0.1.2" @test t.julia_version == v"0.1.2"
t = Template(; user="invenia", requirements=["$test_pkg 0.1"]) t = Template(; user=me, requirements=["$test_pkg 0.1"])
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.requirements == ["$test_pkg 0.1"] @test t.requirements == ["$test_pkg 0.1"]
@test_warn r".+" t = Template(; user="invenia", requirements=[test_pkg, test_pkg]) @test_warn r".+" t = Template(; user=me, requirements=[test_pkg, test_pkg])
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.requirements == [test_pkg] @test t.requirements == [test_pkg]
@test_throws ArgumentError t = Template(; @test_throws ArgumentError t = Template(;
user="invenia", user=me,
requirements=[test_pkg, "$test_pkg 0.1"] requirements=[test_pkg, "$test_pkg 0.1"]
) )
rm(t.temp_dir; force=true, recursive=true) rm(t.temp_dir; force=true, recursive=true)
t = Template(; user="invenia", git_config=git_config) t = Template(; user=me, git_config=git_config)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.git_config == git_config @test t.git_config == git_config
t = Template(; user="invenia", git_config=git_config) t = Template(; user=me, git_config=git_config)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@test t.authors == git_config["user.name"] @test t.authors == git_config["user.name"]
@ -93,7 +94,7 @@ write(test_file, template_text)
@test t.authors == git_config["user.name"] @test t.authors == git_config["user.name"]
t = Template(; t = Template(;
user="invenia", user=me,
plugins = [GitHubPages(), TravisCI(), AppVeyor(), CodeCov(), Coveralls()], plugins = [GitHubPages(), TravisCI(), AppVeyor(), CodeCov(), Coveralls()],
) )
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@ -105,7 +106,7 @@ write(test_file, template_text)
) )
@test_warn r".+" t = Template(; @test_warn r".+" t = Template(;
user="invenia", user=me,
plugins=[TravisCI(), TravisCI()], plugins=[TravisCI(), TravisCI()],
) )
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
@ -117,7 +118,7 @@ write(test_file, template_text)
@test t.user == LibGit2.getconfig("github.username", "") @test t.user == LibGit2.getconfig("github.username", "")
end end
rm(t.temp_dir; force=true, recursive=true) rm(t.temp_dir; force=true, recursive=true)
@test_throws ArgumentError t = Template(; user="invenia", license="FakeLicense") @test_throws ArgumentError t = Template(; user=me, license="FakeLicense")
rm(t.temp_dir; force=true, recursive=true) rm(t.temp_dir; force=true, recursive=true)
end end
@ -237,7 +238,7 @@ end
@testset "File generation" begin @testset "File generation" begin
t = Template(; t = Template(;
user="invenia", user=me,
license="MPL", license="MPL",
requirements=[test_pkg], requirements=[test_pkg],
git_config=git_config, git_config=git_config,
@ -316,7 +317,7 @@ end
end end
@testset "Package generation" begin @testset "Package generation" begin
t = Template(; user="invenia") t = Template(; user=me)
generate(test_pkg, t) generate(test_pkg, t)
@test !isfile(Pkg.dir(test_pkg, "LICENSE")) @test !isfile(Pkg.dir(test_pkg, "LICENSE"))
@test isfile(Pkg.dir(test_pkg, "README.md")) @test isfile(Pkg.dir(test_pkg, "README.md"))
@ -330,7 +331,7 @@ end
remote = LibGit2.get(LibGit2.GitRemote, repo, "origin") remote = LibGit2.get(LibGit2.GitRemote, repo, "origin")
branches = [LibGit2.shortname(branch[1]) for branch in LibGit2.GitBranchIter(repo)] branches = [LibGit2.shortname(branch[1]) for branch in LibGit2.GitBranchIter(repo)]
@test LibGit2.getconfig(repo, "user.name", "") == LibGit2.getconfig("user.name", "") @test LibGit2.getconfig(repo, "user.name", "") == LibGit2.getconfig("user.name", "")
@test LibGit2.url(remote) == "https://github.com/invenia/$test_pkg.jl" @test LibGit2.url(remote) == "https://github.com/$me/$test_pkg.jl"
@test in("master", branches) @test in("master", branches)
@test !in("gh-pages", branches) @test !in("gh-pages", branches)
@test !LibGit2.isdirty(repo) @test !LibGit2.isdirty(repo)
@ -339,24 +340,24 @@ end
generate(test_pkg, t; ssh=true) generate(test_pkg, t; ssh=true)
repo = LibGit2.GitRepo(Pkg.dir(test_pkg)) repo = LibGit2.GitRepo(Pkg.dir(test_pkg))
remote = LibGit2.get(LibGit2.GitRemote, repo, "origin") remote = LibGit2.get(LibGit2.GitRemote, repo, "origin")
@test LibGit2.url(remote) == "git@github.com:invenia/$test_pkg.jl.git" @test LibGit2.url(remote) == "git@github.com:$me/$test_pkg.jl.git"
rm(Pkg.dir(test_pkg); recursive=true) rm(Pkg.dir(test_pkg); recursive=true)
t = Template(; user="invenia", host="gitlab.com") t = Template(; user=me, host="gitlab.com")
generate(test_pkg, t) generate(test_pkg, t)
repo = LibGit2.GitRepo(Pkg.dir(test_pkg)) repo = LibGit2.GitRepo(Pkg.dir(test_pkg))
remote = LibGit2.get(LibGit2.GitRemote, repo, "origin") remote = LibGit2.get(LibGit2.GitRemote, repo, "origin")
@test LibGit2.url(remote) == "https://gitlab.com/invenia/$test_pkg.jl" @test LibGit2.url(remote) == "https://gitlab.com/$me/$test_pkg.jl"
rm(Pkg.dir(test_pkg); recursive=true) rm(Pkg.dir(test_pkg); recursive=true)
temp_dir = mktempdir() temp_dir = mktempdir()
t = Template(; user="invenia", dir=temp_dir) t = Template(; user=me, dir=temp_dir)
generate(test_pkg, t) generate(test_pkg, t)
@test isdir(joinpath(temp_dir, test_pkg)) @test isdir(joinpath(temp_dir, test_pkg))
rm(temp_dir; recursive=true) rm(temp_dir; recursive=true)
t = Template(; t = Template(;
user="invenia", user=me,
license="MIT", license="MIT",
git_config=git_config, git_config=git_config,
plugins=[AppVeyor(), GitHubPages(), Coveralls(), CodeCov(), TravisCI()], plugins=[AppVeyor(), GitHubPages(), Coveralls(), CodeCov(), TravisCI()],
@ -383,7 +384,7 @@ end
@test isfile(Pkg.dir(test_pkg, "README.md")) @test isfile(Pkg.dir(test_pkg, "README.md"))
rm(Pkg.dir(test_pkg); recursive=true) rm(Pkg.dir(test_pkg); recursive=true)
t = Template(; user="invenia", plugins=[GitHubPages()]) t = Template(; user=me, plugins=[GitHubPages()])
generate(test_pkg, t) generate(test_pkg, t)
readme = readstring(Pkg.dir(test_pkg, "README.md")) readme = readstring(Pkg.dir(test_pkg, "README.md"))
index = readstring(Pkg.dir(test_pkg, "docs", "src", "index.md")) index = readstring(Pkg.dir(test_pkg, "docs", "src", "index.md"))
@ -392,7 +393,7 @@ end
end end
@testset "Plugin generation" begin @testset "Plugin generation" begin
t = Template(; user="invenia") t = Template(; user=me)
pkg_dir = joinpath(t.temp_dir, test_pkg) pkg_dir = joinpath(t.temp_dir, test_pkg)
p = TravisCI() p = TravisCI()
@ -539,7 +540,7 @@ end
@test contains(text, "PKGNAME: $test_pkg") @test contains(text, "PKGNAME: $test_pkg")
@test contains(text, "Other") @test contains(text, "Other")
t = Template(; user="invenia") t = Template(; user=me)
rm(t.temp_dir; recursive=true) rm(t.temp_dir; recursive=true)
view["OTHER"] = false view["OTHER"] = false