diff options
author | Jakob Odersky <jakob@odersky.com> | 2018-04-08 20:30:44 -0700 |
---|---|---|
committer | Jakob Odersky <jakob@odersky.com> | 2018-04-08 20:32:20 -0700 |
commit | da6a5cad7ef0fe723ac126f921f97c36962f42af (patch) | |
tree | d86aae792a7c96c22685ba1657abc766d56d4be0 | |
parent | 98f1acf269312545192be115c75a6cce58c00766 (diff) | |
download | yamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.tar.gz yamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.tar.bz2 yamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.zip |
Restructure build
-rw-r--r-- | README.md | 32 | ||||
-rw-r--r-- | build.sbt | 7 | ||||
-rw-r--r-- | yamlesque-spray-json/src/main/scala/formats.scala (renamed from yamlesque-spray/src/main/scala/formats.scala) | 0 | ||||
-rw-r--r-- | yamlesque-spray-json/src/test/scala/FormatTests.scala (renamed from yamlesque-spray/src/test/scala/FormatTests.scala) | 0 |
4 files changed, 27 insertions, 12 deletions
@@ -4,13 +4,8 @@ Pure Scala YAML parsing. As the name suggests, "yam-el-esque" is a Scala implementation of the most frequently used YAML features. It takes inspiration from -Spray-JSON and aims to provide an idiomatic, to-the-point API that is -cross-platform and has a minimal set of dependencies. - -It does not strictly implement all features as defined in [YAML -1.2](http://yaml.org/spec/1.2/spec.html), however support should be -sufficient for regular use. Pull requests with additional feature -implementations are always welcome! +Spray-JSON and aims to provide an idiomatic API that is cross-platform +and has a minimal set of dependencies. ## Getting Started Include yamlesque into a project. In sbt, this can be done with: @@ -31,6 +26,27 @@ val text = s"""|name: yamlesque | - name: Another |""".stripMargin -// parse yaml to a typesafe representation +// parse yaml to a type safe representation val yaml = text.parseYaml ``` + +### Integration with Spray-JSON +*TODO* + +### Integration with Akka-HTTP +*TODO* + +## YAML Conformance + +Yamlesque does not strictly implement all features as defined in [YAML +1.2](http://yaml.org/spec/1.2/spec.html), however support should be +sufficient for most regular documents. Pull requests with additional +feature implementations are always welcome! + +The current feature restrictions are: + +- always assumes utf-8 is used +- anchors and references are not supported +- tags are not supported +- flow-styles (aka inline JSON) aren't supported +- only single-line literals are allowed (no > or | blocks) @@ -27,22 +27,21 @@ lazy val yamlesqueJVM = yamlesque.jvm lazy val yamlesqueJS = yamlesque.js lazy val yamlesqueNative = yamlesque.native -lazy val yamlesqueSpray = crossProject(JVMPlatform) +lazy val `yamlesque-spray-json` = crossProject(JVMPlatform) .crossType(CrossType.Pure) - .in(file("yamlesque-spray")) .dependsOn(yamlesque) .settings(testSettings) .settings( libraryDependencies += "io.spray" %%% "spray-json" % "1.3.4" ) -lazy val yamlesqueSprayJVM = yamlesqueSpray.jvm +lazy val `yamlesque-spray-jsonJVM` = `yamlesque-spray-json`.jvm lazy val root = (project in file(".")) .aggregate( yamlesqueJVM, yamlesqueJS, yamlesqueNative, - yamlesqueSprayJVM + `yamlesque-spray-jsonJVM` ) .settings( publish := {}, diff --git a/yamlesque-spray/src/main/scala/formats.scala b/yamlesque-spray-json/src/main/scala/formats.scala index 188f4a9..188f4a9 100644 --- a/yamlesque-spray/src/main/scala/formats.scala +++ b/yamlesque-spray-json/src/main/scala/formats.scala diff --git a/yamlesque-spray/src/test/scala/FormatTests.scala b/yamlesque-spray-json/src/test/scala/FormatTests.scala index 93d763a..93d763a 100644 --- a/yamlesque-spray/src/test/scala/FormatTests.scala +++ b/yamlesque-spray-json/src/test/scala/FormatTests.scala |