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

feat: Config defaults for dune-project #10835

Merged
merged 18 commits into from
Sep 15, 2024
Merged

feat: Config defaults for dune-project #10835

merged 18 commits into from
Sep 15, 2024

Conversation

H-ANSEN
Copy link
Contributor

@H-ANSEN H-ANSEN commented Aug 20, 2024 •
edited
Loading

This is a pull request in reference to and would close #10027 by adding the ability to configure defaults for the authors, maintainers, and license stanzas of the dune-project file. Values are sourced from the config file when using the dune init project command allowing for preferred preset values to be added. Values can be specified by adding the following stanza to the dune config file

(project_defaults
 (authors <string(s)>)
 (maintainers <string(s)>)
 (license <string(s)>))

H-ANSEN added 9 commits August 19, 2024 12:54
@H-ANSEN
initial support for authors default from config
eb4c096 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
refactor to make solution more generic
cab0a11 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
remove all "Default_author" references
0431f28 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
add support for license in config
e0cf5a3 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
apply clean up for existing tests
a425471 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
fmt
083f8de 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
add initial test cases
ecb5984 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
add inital documentation for project_defaults stanza
eeb6f54 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
refactor how default values are passed from config to example
7521fa0 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN H-ANSEN changed the title Dune proj config defaults feat: Config defaults for dune-project Aug 20, 2024
H-ANSEN added 3 commits August 19, 2024 22:09
@H-ANSEN
attempt fix for failing tests
0f38f2f 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
add additional test cases verifying stanza behavior
994e312 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
revise documentation page of project_defaults stanza
10f1e25 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN H-ANSEN marked this pull request as ready for review August 21, 2024 14:57
H-ANSEN and others added 3 commits August 28, 2024 16:37
@H-ANSEN
update package_info.ml to conform with recently pushed changes
ad73096 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN
Merge branch 'main' into dune-proj-config-defaults
584a523 
Signed-off-by: thanse23 <62850132+H-ANSEN@users.noreply.github.com>
@H-ANSEN
update defaults fixing failing test case
9fdc492 
Signed-off-by: teague hansen <thanse23@asu.edu>
@H-ANSEN H-ANSEN force-pushed the dune-proj-config-defaults branch from 384cd4a to 9fdc492 Compare August 28, 2024 21:15
@H-ANSEN
Copy link
Contributor Author

H-ANSEN commented Sep 11, 2024 •
edited
Loading

This is ready for review @Leonidas-from-XIV ! Tagging you here since I never got any initial response and you reviewed my previous pull :)

@H-ANSEN
allow empty but defined stanza copying dune-project behavior
5af0e72 
Signed-off-by: teague hansen <thanse23@asu.edu>
Leonidas-from-XIV
Leonidas-from-XIV reviewed Sep 12, 2024
View reviewed changes
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, I appreciate it comes with a test and documentation updates. The code looks fine, I only have a few nitpicks about the documentation.

Could you add a short changelog entry as well?

doc/reference/config/project_defaults.rst Outdated Show resolved Hide resolved
doc/reference/config/project_defaults.rst Outdated Show resolved Hide resolved
doc/reference/config/project_defaults.rst

.. describe:: (authors <string(s)>)

Specify authors.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder, if this could link to the definition of authors in the dune-project reference?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't find any relevant definition of authors in the reference, I'm sure I am just glancing over it though. I made all the other requested changes as well as adding a .. versionadded 3.17 to the top of the doc page!

H-ANSEN and others added 2 commits September 13, 2024 08:43
@H-ANSEN
clean up doc and add chagelog file
35003b0 
Signed-off-by: teague hansen <thanse23@asu.edu>
@rgrinberg
_
8fbff04 
Signed-off-by: Rudi Grinberg <me@rgrinberg.com>
@rgrinberg rgrinberg merged commit 242b0c3 into ocaml:main Sep 15, 2024
23 of 27 checks passed
@H-ANSEN H-ANSEN mentioned this pull request Sep 15, 2024
Merged
rgrinberg pushed a commit that referenced this pull request Sep 16, 2024
@H-ANSEN
Fix #10835 expect tests (#10924)
cc26034 
Signed-off-by: teague hansen <thanse23@asu.edu>
anmonteiro pushed a commit to anmonteiro/dune that referenced this pull request Nov 17, 2024
@H-ANSEN @anmonteiro
feat: Config defaults for dune-project (ocaml#10835)
791a51c 
* support for authors default from config

Signed-off-by: teague hansen <thanse23@asu.edu>
anmonteiro pushed a commit to anmonteiro/dune that referenced this pull request Nov 17, 2024
@H-ANSEN @anmonteiro
Fix ocaml#10835 expect tests (ocaml#10924)
7502226 
Signed-off-by: teague hansen <thanse23@asu.edu>
@maiste maiste mentioned this pull request Nov 25, 2024
Closed
maiste added a commit to maiste/opam-repository that referenced this pull request Nov 25, 2024
@maiste
[new release] dune (15 packages) (3.17.0~alpha0)
f1d49be 
CHANGES:

### Fixed

- Show the context name for errors happening in non-default contexts.
  (ocaml/dune#10414, fixes ocaml/dune#10378, @jchavarri)

- Correctly declare dependencies of indexes so that they are rebuilt when
  needed. (ocaml/dune#10623, @voodoos)

- Don't depend on coq-stdlib being installed when expanding variables
  of the `coq.version` family (ocaml/dune#10631, fixes ocaml/dune#10629, @gares)

- Error out if no files are found when using `copy_files`. (ocaml/dune#10649, @jchavarri)

- Re_export dune-section private library in the dune-site library stanza,
  in order to avoid failure when generating and building sites modules
  with implicit_transitive_deps = false. (ocaml/dune#10650, fixes ocaml/dune#9661, @MA0100)

- Expect test fixes: support multiple modes and fix dependencies when there is
  a custom runner (ocaml/dune#10671, @vouillon)

- In a `(library)` stanza with `(extra_objects)` and `(foreign_stubs)`, avoid
  double linking the extra object files in the final executable.
  (ocaml/dune#10783, fixes ocaml/dune#10785, @nojb)

- Map `(re_export)` library dependencies to the `exports` field in `META` files,
  and vice-versa. This field was proposed in to
  https://discuss.ocaml.org/t/proposal-a-new-exports-field-in-findlib-meta-files/13947.
  The field is included in Dune-generated `META` files only when the Dune lang
  version is >= 3.17.
  (ocaml/dune#10831, fixes ocaml/dune#10830, @nojb)

- Fix staged pps preprocessors on Windows (which were not working at all
  previously) (ocaml/dune#10869, fixes ocaml/dune#10867, @nojb)

- Fix `dune describe` when an executable is disabled with `enabled_if`.
  (ocaml/dune#10881, fixes ocaml/dune#10779, @moyodiallo)

- Fix an issue where C stubs would be rebuilt whenever the stderr of Dune was
  redirected. (ocaml/dune#10883, fixes ocaml/dune#10882, @nojb)

- Format long lists in s-expressions to fill the line instead of formatting
  them in a vertical way (ocaml/dune#10892, fixes ocaml/dune#10860, @nojb)

- Fix the URL opened by the command `dune ocaml doc`. (ocaml/dune#10897, @gridbugs)

- Fix the file referred to in the error/warning message displayed due to the
  dune configuration version not supporting a particular configuration
  stanza in use. (ocaml/dune#10923, @H-ANSEN)

- Fix `enabled_if` when it uses `env` variable. (ocaml/dune#10936, fixes ocaml/dune#10905, @moyodiallo)

- Fix exec -w for relative paths with --root argument (ocaml/dune#10982, @gridbugs)

- Do not ignore the `(locks ..)` field in the `test` and `tests` stanza
  (ocaml/dune#11081, @rgrinberg)

- Tolerate files without extension when generating merlin rules.
  (ocaml/dune#11128, @anmonteiro)

### Added

- Make Merlin/OCaml-LSP aware of "hidden" dependencies used by
  `(implicit_transitive_deps false)` via the `-H` compiler flag. (ocaml/dune#10535, @voodoos)

- Add support for the -H flag (introduced in OCaml compiler 5.2) in dune
  (requires lang versions 3.17). This adaptation gives
  the correct semantics for `(implicit_transitive_deps false)`.
  (ocaml/dune#10644, fixes ocaml/dune#9333, ocsigen/tyxml#274, ocaml/dune#2733, ocaml/dune#4963, @MA0100)

- Add support for specifying Gitlab organization repositories in `source`
  stanzas (ocaml/dune#10766, fixes ocaml/dune#6723, @H-ANSEN)

- New option to control jsoo sourcemap generation in env and executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- One can now control jsoo compilation_mode inside an executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- Add support for specifying default values of the `authors`, `maintainers`, and
  `license` stanzas of the `dune-project` file via the dune config file. Default
  values are set using the `(project_defaults)` stanza (ocaml/dune#10835, @H-ANSEN)

- Add names to source tree events in performance traces (ocaml/dune#10884, @jchavarri)

- Add `codeberg` as an option for defining project sources in dune-project
  files. For example, `(source (codeberg user/repo))`. (ocaml/dune#10904, @nlordell)

- `dune runtest` can now run individual tests with `dune runtest mytest.t`
  (ocaml/dune#11041, @Alizter).

- Wasm_of_ocaml support (ocaml/dune#11093, @vouillon)

- Add a `coqdep_flags` field to the `coq` field of the `env` stanza, and to the `coq.theory` stanza, allowing to configure `coqdep` flags.
  (ocaml/dune#11094, @rlepigre)

### Changed

- Remove all remnants of the experimental `patch-back-source-tree`. (ocaml/dune#10771,
  @rgrinberg)

- Change the preset value for author and maintainer fields in the
  `dune-project` file to encourage including emails. (ocaml/dune#10848, @punchagan)

- Tweak the preset value for tags in the `dune-project` file to hint at topics
  not having a special meaning. (ocaml/dune#10849, @punchagan)

- Change some colors to improve readability in light-mode terminals
  (ocaml/dune#10890, @gridbugs)

- Forward the linkall flag to jsoo in whole program compilation as well (ocaml/dune#10935, @hhugo)

- Configurator uses `pkgconf` as pkg-config implementation when available
  and forwards it the `target` of `ocamlc -config`. (ocaml/dune#10937, @pirbo)

- Enable Dune cache by default. Add a new Dune cache setting
  `enabled-except-user-rules`, which enables the Dune cache, but excludes
  user-written rules from it. This is a conservative choice that can avoid
  breaking rules whose dependencies are not correctly specified. This is the
  current default. (ocaml/dune#10944, ocaml/dune#10710, @nojb, @ElectreAAS)

- Do not add `dune` dependency in `dune-project` when creating projects with
  `dune init proj`. The Dune dependency is implicitely added when generating
  opam files (ocaml/dune#11129, @Leonidas-from-XIV)
maiste added a commit to maiste/opam-repository that referenced this pull request Nov 27, 2024
@maiste
[new release] dune (15 packages) (3.17.0)
ca0426d 
CHANGES:

### Fixed

- Show the context name for errors happening in non-default contexts.
  (ocaml/dune#10414, fixes ocaml/dune#10378, @jchavarri)

- Correctly declare dependencies of indexes so that they are rebuilt when
  needed. (ocaml/dune#10623, @voodoos)

- Don't depend on coq-stdlib being installed when expanding variables
  of the `coq.version` family (ocaml/dune#10631, fixes ocaml/dune#10629, @gares)

- Error out if no files are found when using `copy_files`. (ocaml/dune#10649, @jchavarri)

- Re_export dune-section private library in the dune-site library stanza,
  in order to avoid failure when generating and building sites modules
  with implicit_transitive_deps = false. (ocaml/dune#10650, fixes ocaml/dune#9661, @MA0100)

- Expect test fixes: support multiple modes and fix dependencies when there is
  a custom runner (ocaml/dune#10671, @vouillon)

- In a `(library)` stanza with `(extra_objects)` and `(foreign_stubs)`, avoid
  double linking the extra object files in the final executable.
  (ocaml/dune#10783, fixes ocaml/dune#10785, @nojb)

- Map `(re_export)` library dependencies to the `exports` field in `META` files,
  and vice-versa. This field was proposed in to
  https://discuss.ocaml.org/t/proposal-a-new-exports-field-in-findlib-meta-files/13947.
  The field is included in Dune-generated `META` files only when the Dune lang
  version is >= 3.17.
  (ocaml/dune#10831, fixes ocaml/dune#10830, @nojb)

- Fix staged pps preprocessors on Windows (which were not working at all
  previously) (ocaml/dune#10869, fixes ocaml/dune#10867, @nojb)

- Fix `dune describe` when an executable is disabled with `enabled_if`.
  (ocaml/dune#10881, fixes ocaml/dune#10779, @moyodiallo)

- Fix an issue where C stubs would be rebuilt whenever the stderr of Dune was
  redirected. (ocaml/dune#10883, fixes ocaml/dune#10882, @nojb)

- Fix the URL opened by the command `dune ocaml doc`. (ocaml/dune#10897, @gridbugs)

- Fix the file referred to in the error/warning message displayed due to the
  dune configuration version not supporting a particular configuration
  stanza in use. (ocaml/dune#10923, @H-ANSEN)

- Fix `enabled_if` when it uses `env` variable. (ocaml/dune#10936, fixes ocaml/dune#10905, @moyodiallo)

- Fix exec -w for relative paths with --root argument (ocaml/dune#10982, @gridbugs)

- Do not ignore the `(locks ..)` field in the `test` and `tests` stanza
  (ocaml/dune#11081, @rgrinberg)

- Tolerate files without extension when generating merlin rules.
  (ocaml/dune#11128, @anmonteiro)

### Added

- Make Merlin/OCaml-LSP aware of "hidden" dependencies used by
  `(implicit_transitive_deps false)` via the `-H` compiler flag. (ocaml/dune#10535, @voodoos)

- Add support for the -H flag (introduced in OCaml compiler 5.2) in dune
  (requires lang versions 3.17). This adaptation gives
  the correct semantics for `(implicit_transitive_deps false)`.
  (ocaml/dune#10644, fixes ocaml/dune#9333, ocsigen/tyxml#274, ocaml/dune#2733, ocaml/dune#4963, @MA0100)

- Add support for specifying Gitlab organization repositories in `source`
  stanzas (ocaml/dune#10766, fixes ocaml/dune#6723, @H-ANSEN)

- New option to control jsoo sourcemap generation in env and executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- One can now control jsoo compilation_mode inside an executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- Add support for specifying default values of the `authors`, `maintainers`, and
  `license` stanzas of the `dune-project` file via the dune config file. Default
  values are set using the `(project_defaults)` stanza (ocaml/dune#10835, @H-ANSEN)

- Add names to source tree events in performance traces (ocaml/dune#10884, @jchavarri)

- Add `codeberg` as an option for defining project sources in dune-project
  files. For example, `(source (codeberg user/repo))`. (ocaml/dune#10904, @nlordell)

- `dune runtest` can now run individual tests with `dune runtest mytest.t`
  (ocaml/dune#11041, @Alizter).

- Wasm_of_ocaml support (ocaml/dune#11093, @vouillon)

- Add a `coqdep_flags` field to the `coq` field of the `env` stanza, and to the `coq.theory` stanza, allowing to configure `coqdep` flags.
  (ocaml/dune#11094, @rlepigre)

### Changed

- Remove all remnants of the experimental `patch-back-source-tree`. (ocaml/dune#10771,
  @rgrinberg)

- Change the preset value for author and maintainer fields in the
  `dune-project` file to encourage including emails. (ocaml/dune#10848, @punchagan)

- Tweak the preset value for tags in the `dune-project` file to hint at topics
  not having a special meaning. (ocaml/dune#10849, @punchagan)

- Change some colors to improve readability in light-mode terminals
  (ocaml/dune#10890, @gridbugs)

- Forward the linkall flag to jsoo in whole program compilation as well (ocaml/dune#10935, @hhugo)

- Configurator uses `pkgconf` as pkg-config implementation when available
  and forwards it the `target` of `ocamlc -config`. (ocaml/dune#10937, @pirbo)

- Enable Dune cache by default. Add a new Dune cache setting
  `enabled-except-user-rules`, which enables the Dune cache, but excludes
  user-written rules from it. This is a conservative choice that can avoid
  breaking rules whose dependencies are not correctly specified. This is the
  current default. (ocaml/dune#10944, ocaml/dune#10710, @nojb, @ElectreAAS)

- Do not add `dune` dependency in `dune-project` when creating projects with
  `dune init proj`. The Dune dependency is implicitely added when generating
  opam files (ocaml/dune#11129, @Leonidas-from-XIV)
@maiste maiste mentioned this pull request Nov 27, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Leonidas-from-XIV Leonidas-from-XIV Leonidas-from-XIV left review comments

@rgrinberg rgrinberg rgrinberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Config options for default author, maintainer etc
3 participants
@H-ANSEN @Leonidas-from-XIV @rgrinberg