CHANGES.md

v0.9.2

• Two-phase project creation: projects starts in a creation phase (option create set to true in drom.toml) after project new, where more files are updated when drom.toml is modified. Creation phase must be ended by drom project --create false, after which fewer files are updated (useful to create the project and edit synopsis/description before freezing them). Only for skeletons with DROM_VERSION > 0.9.2~dev2.
• Support for inline templates:
  • If path/file.ext is to be generated, drom will check if path/file.ext.drom-tpl exists, in which case it will use it as a template for the file. It is possible to use _drom/skeleton/path/file.ext as an example to create such a file.
• Support for LATEST_VERSIONS in drom-share: the LATEST_VERSIONS file indicates, for any version of drom, the latest version of the drom-share repo that should be used. It makes the LATEST file obsolete (as it was incomplete in that matter)
• Package substitution: fix incorrect substitution of 'description', 'synopsis', 'version' and 'authors*' (previously interpreted as from the project instead of from the package). {drom-version >= 0.9.2~dev4}
• Fix usage of drom-version: takes as drom version the most recent version between drom.toml and skeleton DROM_VERSION

v0.9.1

• Fix Sys_error docs/style.css because of missing file
• Fix non-working removal of files (deprecated opam files for example)

v0.9.0

• Split drom-share into another repository:
  • Use https://github.com/OCamlPro/drom-share by default
  • Add fields share-repo and share-version in drom.toml to manage the repo and version of skeletons, independantly of the version of drom
  • Add command-line arguments:
    • --share-version VERSION: set the version of the repo to use (VERSION should be a tag). Available in drom project and drom new.
      • Use branch:BRANCH or branch:REMOTE:BRANCH to use a branch instead of a tagged version (only to test new versions of drom-share)
    • --share-repo URL: set the git url of the repo to use. Available in drom project and drom new.
    • --no-fetch-share: do not access the network with git when looking up the latest version (i.e. use the most recent local version)
    • --reclone-share: reclone with git the share repository
  • Repositories are cloned into $HOME/.config/drom/shares/, with a md5 of their url as directory name
• Support for pin-depends in dependencies:
  • d = { pin = "..." } will translate to [ "d" "..." ]
  • d = { version = "=1.0", pin = "..." } will translate to [ "d.1.0" "..." ] (notice the explicit use of = inside the version)
• Automatic use of locked files:
  • opam install is always called with --locked, and will generate a file $PROJECT-deps.opam.locked at the root of the source tree
  • If a file $PROJECT-deps.opam.locked is available at the root of the source tree, it will be provided to opam install (projects with binaries should git add this file, while other projects should .gitignore it)
• Configuration file $HOME/.config/drom/config:
  • Add option git-stage: true/false to decide whether drom should call git add and git rm after every modification
• Support for git conflicts in .drom: accept multiple hash for a file to decide whether it has been modified by the user or by drom
• Requires use of opam>=2.1

v0.8.0

• Improve templates to inherit values from drom.toml/package.toml inherited files
• drom_toml: because drom requires additional features in toml that do not fit in the standard toml library, we forked toml.0.7.1 into drom_toml. Additional features:
  • New operators: == (init value if never set), := (override value), -= (delete/clear value)
• Fix ocamlformat stuck at 0.15
• Make .ocamlformat-ignore always ignore share-dirs

v0.7.0

• temporary version, never released

v0.6.0

• Generate opam files in opam/ instead of top directory
• drom install PACKAGES where PACKAGES is a limited set of project packages
• drom build tries to update program files by default, unless auto-upgrade: false is set in user configuration:

  [user]
  auto-upgrade = false
  

v0.5.0

• Add --edition and --min-edition to drom new and drom project
• Add support for optional dependencies: lib = { opt = true, version = "3.1" }
• Add @ before skip tags: skip = [ "@test" ]
• drom uninstall: also unpin all project packages
• Add support for optional packages: optional = true
• Add support for preprocessor preprocess = "pps pgocaml_ppx"

v0.4.0 ( 2021-05-11 )

• New [fields] in package.toml:
  • 'gen-opam' to generate the opam file of a virtual package. Possible values are "all" (all sub-packages are dependencies), "some" (you need to specify the dependencies in [dependencies]) or "none" (no opam file is generated, the default).
  • 'no-opam-test = "no"' to disable tests in the opam package
  • 'no-opam-doc = "no"' to disable doc in the opam package
• Add 'rust_binding' skeleton
• New env variable DROM_VERBOSE_SUBST to debug substitutions
• New 'skip = [ "file"...]' in package.toml to skip files in src/PACKAGE/
• New subcommand 'list': "drom list" will list all known skeletons. If an argument is provided, it is either "all", or one of "projects" or "packages".

v0.3.0

• More skeletons

v0.2.1 ( 2020-11-25 )

• Add table [file] in skeleton.toml to specify flags for skeleton files from the outside (useful for binary files for example). Flags can be file (name of file), create (create only if non-existing), skips (list of tags forcing skip), subst (do not perform substitution)
• Extend skeleton substitution language with ![if:COND]...![else]...![fi] COND can be gen:SKIPTAG, skip:SKIPTAG, skeleton:is:SKELETON, kind:is:KIND, not:COND, pack (packed)
• New skeleton projects mini-lib and mini-prg with skip = "test sphinx github docs ocamlformat ocp-indent code"
• Improved inline documentation of drom.toml and package.toml files
• New command drom opam-plugin to install drom as an opam plugin, so it can be called opam drom from anywhere.
• New argument --profile PROFILE to drom build
• New argument --all to drom test to do the test on all available/compatible opam switches (using dune-workspace context feature)
• New option dev-tools in ~/.config/drom/config, a list of opam packages that should be installed in the local switch when drom dev-deps is called
• New environment variable DROM_SHARE_DIR can be used to set the directory containing skeletons and licenses directories (can be used to install drom globally, i.e. DROM_SHARE_DIR=$OPAM_SWITCH_PREFIX/share/drom)
• New common argument -q or --quiet to set verbosity to 0
• New command drom dep [DEP]: display and update dependencies with options: --package NAME : only for package NAME --tool : tool dependencies --add : add new dependency --remove : remove dependency --ver VERSION : set version constraint --lib LIBNAME : set dune name --test BOOL : set for-test --doc BOOL : set for-doc
• New option drom package x --new-file y.ml to create a source file with a correct license header
• Field gen-version = "version.ml" in package.toml does not create the file "version.ml" anymore, but a script "version.mlt" to generate the file with git information
• New command drom lock to generate a file ${package}-deps.opam.locked and git add it.
• New argument --locked to drom build to use ${package}-deps.opam.locked if available.
• Fixes:
  • OCaml escaping in toml file preventing drom new when utf8 chars are present in email addresses of authors

v0.2.0 ( 2020-11-24 )

• Fix bug with misnamed 'packages.toml` file in skeletons

v0.1.0 ( 2020-11-23 )

• First version