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.

Sign up for GitHub

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

Jump to bottom

do opam file generation in the same order as opam lint #2380

Closed
wants to merge 1 commit into from
Closed

do opam file generation in the same order as opam lint #2380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 19 additions & 19 deletions dune-build-info.opam
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# This file is generated by dune, edit dune-project instead
opam-version: "2.0"
synopsis: "Embed build informations inside executable"
description: """
The build-info library allows to access information about how the
executable was built, such as the version of the project at which it
was built or the list of statically linked libraries with their
versions. It supports reporting the version from the version control
system during development to get an precise reference of when the
executable was built.
"""
maintainer: ["Jane Street Group, LLC <[email protected]>"]
authors: ["Jane Street Group, LLC <[email protected]>"]
license: "MIT"
homepage: "https://github.com/ocaml/dune"
doc: "https://dune.readthedocs.io/"
bug-reports: "https://github.com/ocaml/dune/issues"
depends: [
"ocaml" {>= "4.02"}
"dune" {>= "1.11"}
]
build: [
["dune" "subst"] {pinned}
[
Expand All @@ -14,23 +33,4 @@ build: [
"@doc" {with-doc}
]
]
maintainer: ["Jane Street Group, LLC <[email protected]>"]
authors: ["Jane Street Group, LLC <[email protected]>"]
bug-reports: "https://github.com/ocaml/dune/issues"
homepage: "https://github.com/ocaml/dune"
doc: "https://dune.readthedocs.io/"
license: "MIT"
dev-repo: "git+https://github.com/ocaml/dune.git"
synopsis: "Embed build informations inside executable"
description: """
The build-info library allows to access information about how the
executable was built, such as the version of the project at which it
was built or the list of statically linked libraries with their
versions. It supports reporting the version from the version control
system during development to get an precise reference of when the
executable was built.
"""
depends: [
"ocaml" {>= "4.02"}
"dune" {>= "1.11"}
]
14 changes: 7 additions & 7 deletions dune.opam
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# This file is generated by dune, edit dune-project instead
opam-version: "2.0"
maintainer: ["Jane Street Group, LLC <[email protected]>"]
authors: ["Jane Street Group, LLC <[email protected]>"]
bug-reports: "https://github.com/ocaml/dune/issues"
homepage: "https://github.com/ocaml/dune"
doc: "https://dune.readthedocs.io/"
license: "MIT"
dev-repo: "git+https://github.com/ocaml/dune.git"
synopsis: "Fast, portable and opinionated build system"
description: """

Expand All @@ -27,6 +20,12 @@ several opam roots/switches simultaneously. This helps maintaining
packages across several versions of OCaml and gives cross-compilation
for free.
"""
maintainer: ["Jane Street Group, LLC <[email protected]>"]
authors: ["Jane Street Group, LLC <[email protected]>"]
license: "MIT"
homepage: "https://github.com/ocaml/dune"
doc: "https://dune.readthedocs.io/"
bug-reports: "https://github.com/ocaml/dune/issues"
depends: [
"ocaml" {>= "4.02"}
"base-unix"
Expand All @@ -37,6 +36,7 @@ conflicts: [
"odoc" {< "1.3.0"}
"dune-release" {< "1.3.0"}
]
dev-repo: "git+https://github.com/ocaml/dune.git"
build: [
# opam 2 sets OPAM_SWITCH_PREFIX, so we don't need a hardcoded path
["ocaml" "configure.ml" "--libdir" lib] {opam-version < "2"}
Expand Down
6 changes: 5 additions & 1 deletion src/opam_create.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,11 @@ let opam_fields project (package : Package.t) =
; "build", default_build_command project
]
in
List.concat
let sort_fields l =
if Dune_project.dune_version project < (1, 11) then l
else Opam_file.Create.normalise_field_order l
in
sort_fields @@ List.concat
[ fields
; list_fields
; optional_fields
Expand Down
52 changes: 52 additions & 0 deletions src/opam_file.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,58 @@ module Create = struct
let list f xs = List (nopos, List.map ~f xs)
let string_list xs = list string xs

let normalise_field_order vars =
let normal_field_order = [
(* Extracted from opam/src/format/opamFile.ml *)
"opam-version";
"name";
"version";
"synopsis";
"description";
"maintainer";
"authors";
"author";
"license";
"tags";
"homepage";
"doc";
"bug-reports";
"depends";
"depopts";
"conflicts";
"conflict-class";
"available";
"flags";
"setenv";
"build";
"run-test";
"install";
"remove";
"substs";
"patches";
"build-env";
"features";
"messages";
"post-messages";
"depexts";
"libraries";
"syntax";
"dev-repo";
"pin-depends";
"extra-files" ]
in
let standard_fields =
List.filter_map normal_field_order ~f:(fun field ->
Option.map (List.assoc vars field)
~f:(fun v -> field, v))
avsm marked this conversation as resolved.
Show resolved Hide resolved
in
let extra_fields =
List.filter_map vars ~f:(fun (name,v) ->
if List.mem ~set:normal_field_order name then None
else Some (name,v))
in
standard_fields @ extra_fields

let of_bindings vars ~file =
let file_contents =
List.map vars ~f:(fun (var, value) ->
Expand Down
2 changes: 2 additions & 0 deletions src/opam_file.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,7 @@ module Create : sig

val string_list : string list -> value

val normalise_field_order : (string * value) list -> (string * value) list

val of_bindings : (string * value) list -> file:Path.t -> t
end
113 changes: 113 additions & 0 deletions test/blackbox-tests/test-cases/dune-project-meta/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,116 @@ Generation of opam files with lang dune >= 1.11
"@doc" {with-doc}
]
]


Templates should also be respected with extension fields, in this
case "x-foo":

$ dune build @install --root test-fields-with-tmpl --auto-promote
Entering directory 'test-fields-with-tmpl'
$ cat test-fields-with-tmpl/github.opam
# This file is generated by dune, edit dune-project instead
opam-version: "2.0"
synopsis: "GitHub APIv3 OCaml library"
description: """
This library provides an OCaml interface to the
[GitHub APIv3](https://developer.github.com/v3/) (JSON).

It is compatible with [MirageOS](https://mirage.io) and also compiles to pure
JavaScript via [js_of_ocaml](http://ocsigen.org/js_of_ocaml)."""
maintainer: ["Anil Madhavapeddy <[email protected]>"]
authors: [
"Anil Madhavapeddy"
"David Sheets"
"Andy Ray"
"Jeff Hammerbacher"
"Thomas Gazagnaire"
"Rudi Grinberg"
"Qi Li"
"Jeremy Yallop"
"Dave Tucker"
]
license: "MIT"
homepage: "https://github.com/mirage/ocaml-github"
doc: "https://mirage.github.io/ocaml-github/"
bug-reports: "https://github.com/mirage/ocaml-github/issues"
depends: [
"ocaml" {>= "4.03.0"}
"uri" {>= "1.9.0"}
"cohttp" {>= "0.99.0"}
"cohttp-lwt" {>= "0.99"}
"lwt" {>= "2.4.4"}
"atdgen" {>= "2.0.0"}
"yojson" {>= "1.6.0"}
"stringext"
]
build: [
["dune" "subst"] {pinned}
[
"dune"
"build"
"-p"
name
"-j"
jobs
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/mirage/ocaml-github.git"
x-foo: "an extension field"

And this file should contains a "libraries" field at the end.
It is not sorted since its in a template, which always comes at
the end.

$ cat test-fields-with-tmpl/github-unix.opam
# This file is generated by dune, edit dune-project instead
opam-version: "2.0"
synopsis: "GitHub APIv3 Unix library"
description: """
This library provides an OCaml interface to the [GitHub APIv3](https://developer.github.com/v3/)
(JSON). This package installs the Unix (Lwt) version."""
maintainer: ["Anil Madhavapeddy <[email protected]>"]
authors: [
"Anil Madhavapeddy"
"David Sheets"
"Andy Ray"
"Jeff Hammerbacher"
"Thomas Gazagnaire"
"Rudi Grinberg"
"Qi Li"
"Jeremy Yallop"
"Dave Tucker"
]
license: "MIT"
homepage: "https://github.com/mirage/ocaml-github"
doc: "https://mirage.github.io/ocaml-github/"
bug-reports: "https://github.com/mirage/ocaml-github/issues"
depends: [
"ocaml" {>= "4.03.0"}
"github" {= version}
"cohttp" {>= "0.99.0"}
"cohttp-lwt-unix" {>= "0.99.0"}
"stringext"
"lambda-term" {>= "2.0"}
"cmdliner" {>= "0.9.8"}
"base-unix"
]
build: [
["dune" "subst"] {pinned}
[
"dune"
"build"
"-p"
name
"-j"
jobs
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/mirage/ocaml-github.git"
libraries: [ "github_unix" ]
60 changes: 60 additions & 0 deletions test/blackbox-tests/test-cases/dune-project-meta/test-fields-with-tmpl/dune-project
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
(lang dune 1.11)
(name github)

(generate_opam_files true)

(license MIT)
(maintainers "Anil Madhavapeddy <[email protected]>")
(authors "Anil Madhavapeddy" "David Sheets" "Andy Ray"
"Jeff Hammerbacher" "Thomas Gazagnaire" "Rudi Grinberg"
"Qi Li" "Jeremy Yallop" "Dave Tucker")
(source (github mirage/ocaml-github))
(documentation "https://mirage.github.io/ocaml-github/")

(package
(name github)
(tags (org:mirage org:xapi-project git))
(depends
(ocaml (>= 4.03.0))
(uri (>= 1.9.0))
(cohttp (>= 0.99.0))
(cohttp-lwt (>= 0.99))
(lwt (>= 2.4.4))
(atdgen (>= 2.0.0))
(yojson (>= 1.6.0))
stringext)
(synopsis "GitHub APIv3 OCaml library")
(description "This library provides an OCaml interface to the
[GitHub APIv3](https://developer.github.com/v3/) (JSON).

It is compatible with [MirageOS](https://mirage.io) and also compiles to pure
JavaScript via [js_of_ocaml](http://ocsigen.org/js_of_ocaml)."))

(package
(name github-jsoo)
(tags (org:mirage org:xapi-project git))
(depends
(ocaml (>= 4.03.0))
(github (= :version))
(cohttp (>= 0.99.0))
(cohttp-lwt-jsoo (>= 0.99.0))
(js_of_ocaml-lwt (>= 3.4.0)))
(synopsis "GitHub APIv3 JavaScript library")
(description "This library provides an OCaml interface to the [GitHub APIv3](https://developer.github.com/v3/)
(JSON). This library installs the JavaScript version, which uses [js_of_ocaml](http://ocsigen.org/js_of_ocaml)."))

(package
(name github-unix)
(tags (org:mirage org:xapi-project git))
(depends
(ocaml (>= 4.03.0))
(github (= :version))
(cohttp (>= 0.99.0))
(cohttp-lwt-unix (>= 0.99.0))
stringext
(lambda-term (>= 2.0))
(cmdliner (>= 0.9.8))
base-unix)
(synopsis "GitHub APIv3 Unix library")
(description "This library provides an OCaml interface to the [GitHub APIv3](https://developer.github.com/v3/)
(JSON). This package installs the Unix (Lwt) version."))
1 change: 1 addition & 0 deletions ...ackbox-tests/test-cases/dune-project-meta/test-fields-with-tmpl/github-unix.opam.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
libraries: [ "github_unix" ]
1 change: 1 addition & 0 deletions test/blackbox-tests/test-cases/dune-project-meta/test-fields-with-tmpl/github.opam.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
x-foo: "an extension field"