Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provides the ability to import JS and CSS files from CDNs #111

Merged
merged 1 commit into from
Dec 14, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/main/scala/microsites/MicrositeKeys.scala
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ trait MicrositeKeys {
"Optional. Microsite CSS directory. By default, it'll be the resourcesDirectory + '/microsite/css'")
val micrositeJsDirectory = settingKey[File](
"Optional. Microsite Javascript directory. By default, it'll be the resourcesDirectory + '/microsite/js'")
val micrositeCDNDirectives = settingKey[CdnDirectives](
"Optional. Microsite CDN directives lists (for css and js imports). By default, both lists are empty.")
val micrositeExternalLayoutsDirectory = settingKey[File](
"Optional. Microsite external layouts directory. By default, it'll be the resourcesDirectory + '/microsite/layout'")
val micrositeExternalIncludesDirectory = settingKey[File](
Expand Down
2 changes: 2 additions & 0 deletions src/main/scala/microsites/MicrositesPlugin.scala
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ object MicrositesPlugin extends AutoPlugin {
micrositeImgDirectory := (resourceDirectory in Compile).value / "microsite" / "img",
micrositeCssDirectory := (resourceDirectory in Compile).value / "microsite" / "css",
micrositeJsDirectory := (resourceDirectory in Compile).value / "microsite" / "js",
micrositeCDNDirectives := CdnDirectives(),
micrositeExternalLayoutsDirectory := (resourceDirectory in Compile).value / "microsite" / "layouts",
micrositeExternalIncludesDirectory := (resourceDirectory in Compile).value / "microsite" / "includes",
micrositeDataDirectory := (resourceDirectory in Compile).value / "microsite" / "data",
Expand Down Expand Up @@ -114,6 +115,7 @@ object MicrositesPlugin extends AutoPlugin {
micrositeImgDirectory = micrositeImgDirectory.value,
micrositeCssDirectory = micrositeCssDirectory.value,
micrositeJsDirectory = micrositeJsDirectory.value,
micrositeCDNDirectives = micrositeCDNDirectives.value,
micrositeExternalLayoutsDirectory = micrositeExternalLayoutsDirectory.value,
micrositeExternalIncludesDirectory = micrositeExternalIncludesDirectory.value,
micrositeDataDirectory = micrositeDataDirectory.value,
Expand Down
12 changes: 10 additions & 2 deletions src/main/scala/microsites/layouts/Layout.scala
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ abstract class Layout(config: MicrositeSettings) {
link(rel := "stylesheet", href := s"{{site.baseurl}}/css/${css.getName}")
}

val customCDNList = config.micrositeCDNDirectives.cssList map { css =>
link(rel := "stylesheet", href := css)
}

List(
link(rel := "stylesheet",
href := "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"),
Expand All @@ -71,7 +75,7 @@ abstract class Layout(config: MicrositeSettings) {
href := s"{{site.url}}{{site.baseurl}}/highlight/styles/${config.highlightTheme}.css"),
link(rel := "stylesheet", href := s"{{site.baseurl}}/css/style.css"),
link(rel := "stylesheet", href := s"{{site.baseurl}}/css/palette.css")
) ++ customCssList
) ++ customCssList ++ customCDNList
}

def scripts: List[TypedTag[String]] = {
Expand All @@ -80,6 +84,10 @@ abstract class Layout(config: MicrositeSettings) {
script(src := s"{{site.url}}{{site.baseurl}}/js/${js.getName}")
}

val customCDNList = config.micrositeCDNDirectives.jsList map { js =>
script(src := js)
}

List(
script(src := "https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"),
script(
Expand All @@ -90,7 +98,7 @@ abstract class Layout(config: MicrositeSettings) {
|});
|hljs.initHighlighting();
""".stripMargin)
) ++ customJsList
) ++ customJsList ++ customCDNList
}

def globalFooter =
Expand Down
3 changes: 3 additions & 0 deletions src/main/scala/microsites/microsites.scala
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ package object microsites {
micrositeImgDirectory: File,
micrositeCssDirectory: File,
micrositeJsDirectory: File,
micrositeCDNDirectives: CdnDirectives,
micrositeExternalLayoutsDirectory: File,
micrositeExternalIncludesDirectory: File,
micrositeDataDirectory: File,
Expand All @@ -45,6 +46,8 @@ package object microsites {
layout: String,
metaProperties: Map[String, String] = Map.empty)

case class CdnDirectives(jsList: List[String] = Nil, cssList: List[String] = Nil)

case class ConfigYml(
yamlCustomProperties: Map[String, Any] = Map.empty,
yamlPath: Option[File] = None,
Expand Down
2 changes: 1 addition & 1 deletion src/sbt-test/microsites/config-yml/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ check := {
sys.error("property defined inline not found")
if (!content.contains("permalink: pretty"))
sys.error("property defined in the provided file not found")
}
}
9 changes: 9 additions & 0 deletions src/test/scala/microsites/util/Arbitraries.scala
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ trait Arbitraries {
} yield ExtraMdFileConfig(file, target, mapArbValue)
}

implicit def cdnDirectivesArbitrary: Arbitrary[CdnDirectives] = Arbitrary {
for {
jsList <- listOf[String](Arbitrary.arbitrary[String])
cssList <- listOf[String](Arbitrary.arbitrary[String])
} yield CdnDirectives(jsList, cssList)
}

implicit def markdownMapArbitrary: Arbitrary[Map[File, ExtraMdFileConfig]] = Arbitrary {
for {
n ← choose(1, 100)
Expand All @@ -72,6 +79,7 @@ trait Arbitraries {
micrositeImgDirectory ← Arbitrary.arbitrary[File]
micrositeCssDirectory ← Arbitrary.arbitrary[File]
micrositeJsDirectory ← Arbitrary.arbitrary[File]
micrositeCDNDirectives <- cdnDirectivesArbitrary.arbitrary
micrositeExternalLayoutsDirectory ← Arbitrary.arbitrary[File]
micrositeExternalIncludesDirectory ← Arbitrary.arbitrary[File]
micrositeDataDirectory ← Arbitrary.arbitrary[File]
Expand All @@ -92,6 +100,7 @@ trait Arbitraries {
micrositeImgDirectory,
micrositeCssDirectory,
micrositeJsDirectory,
micrositeCDNDirectives,
micrositeExternalLayoutsDirectory,
micrositeExternalIncludesDirectory,
micrositeDataDirectory,
Expand Down