Improve skeletons

Author: Fabrice Le Fessant

.drom

@@ -1,64 +1,40 @@
 # Keep this file in your GIT repo to help drom track generated files
-ac2aab1d8f78befbbfca730668f71e8d .github/workflows/ci.ml
-a7863667f1da4a1284e533e6919cdce3 .github/workflows/workflow.yml
-4545d6f4a7e1902e0f4f56112134548b .gitignore
-4cb1bae128d8e649654a5828aaf3e0f9 .gitignore2
-be2d226b0dc658a425e86af1847a2316 .ocamlformat
-5574462426a3706b11f5cbdbb0d4ad91 .ocamlformat-ignore
-1281376e351d6c2be9ea4c576a29ebd4 .ocp-indent
-7a038eccc259630a7aaa876eceb826ba CHANGES.md
-3490cfc0aa14b8da56f1a05329374b43 LICENSE.md
-118525fb5ba6186eedb505bbc7cd9a9c Makefile
-b091dd96e8b553dd7a7df285279d7d9e README.md
-8be75c8edbcba1b202a77111dda43d0c _drom/test
-22d2b3768a6ad00e859332cc4643e85b dir/output-tests/dune
-f0ef7081e1539ac00ef5b761b4fb01b3 dir/output-tests/test1.expected
-894dddf3304cbcb0fe04f7c2bbd56073 dir/output-tests/test2.expected
-0f462df2b69093bbe70ed1e7f9fd0ac6 dir/output-tests/test2.ml
-d41d8cd98f00b204e9800998ecf8427e docs/.nojekyll
-8c90147085379063e18134a7f18f079b docs/doc/index.html
-c352caa74812a7a09cdd3e52031d6033 docs/index.html
-8a2ddf0ce1706457ec54652cf0f5ffac docs/sphinx/index.html
-a95f1ab7d178b468eff6188a527535d9 docs/style.css
-30281c0f416f7fa965c21b066d27eb2c drom-deps.opam
-bd59d8728576b564d779a35c4cab2b30 drom-lib.opam
-30281c0f416f7fa965c21b066d27eb2c drom-opam.deps
-2be6032b5de53fc74f1cf300bcf5ba67 drom.opam
-be9bce812c8fb84f1181a4465d5db382 drom.toml
-4af4aefc60cfb31ded96d242d76d2e5a drom_lib.opam
-f2ce6be777f5e6d83267aac5c4687b0e drom_lib2.opam
-97eadaa266cb426e18086dbf393d9951 dune
-e4c401c332554eaf0cf522d3dbed4735 dune-project
-9783fff1ee77833796e3b1e81bb07bba main/dune
-5a67f25edac115500b168ab38b3c7faf main/dune2
-d947d2a8c369bc5ff232874cc3b568ac main/index.mld
-ee5e7bde03148f6dcef8a75efa4fa83b main/main.ml
-5574462426a3706b11f5cbdbb0d4ad91 ocamlformat-ignore
-68b329da9893e34099c7d8ad5cb9c940 sphinx/UNDER_static/css/fixes.css
-d41d8cd98f00b204e9800998ecf8427e sphinx/_static/css/fixes.css
-a44c87f3a364dd95f55427fe40b2c5d1 sphinx/about.rst
-a27d8599880dce8b4833c38f89ccd6cf sphinx/conf.py
-31524abd666942907d4ff5e55f3d24b4 sphinx/index.rst
-35f7c2d1720a9af03823647787c53099 sphinx/install.rst
-6a086ec9f013f20864c7d019b0d634fe sphinx/license.rst
-5a67f25edac115500b168ab38b3c7faf src/drom/dune
-330455ff80dd6bbff00fe9da6576ab09 src/drom_lib/dune
-5995081f731bcce4893801234419852a src/drom_lib/dune2
-0ae0bb904b090c17249048a67a527ffb src/dune
-5bd0ab058432e0b47eb76a0ad12489bc src/dune2
-dfda02aaec08f18742582243e9cd6748 src/index.mld
-5a67f25edac115500b168ab38b3c7faf src/main/dune
-af27c1e3ba42bf604debde81955f1eeb src/main/dune2
-fab8224b1866cef1103bca89068b73fe src/version.ml
-cbc07c7ef25a01ae6c7ef10c559d3bd7 src2/dune
-bc93b0840d0f30f70e7c491d436a812a src2/index.mld
-8ca05f6f060c00d1bd3a34eec8f176dc src2/main.ml
-fab8224b1866cef1103bca89068b73fe src2/version.ml
-f15fedac6f43c154bcd0348b776ac08c test/expect-tests/dune
-16aa6d750c44bb58dc22a8c2a06d1534 test/expect-tests/test.ml
-75d7504f9c8002ec5ccdd2458f01da09 test/inline-tests/dune
-e001d04969100c711855223ad6c23e6a test/inline-tests/test.ml
-28db2068920c1259cbd67a7c322730ed test/output-tests/dune
-f0ef7081e1539ac00ef5b761b4fb01b3 test/output-tests/test1.expected
-894dddf3304cbcb0fe04f7c2bbd56073 test/output-tests/test2.expected
-704ff05ffd8b0e50716542fa55b2db8a test/output-tests/test2.ml
+e85b39194f20e462352c7e6bb1dde3b4:.
+a7863667f1da4a1284e533e6919cdce3:.github/workflows/workflow.yml
+4545d6f4a7e1902e0f4f56112134548b:.gitignore
+be2d226b0dc658a425e86af1847a2316:.ocamlformat
+5574462426a3706b11f5cbdbb0d4ad91:.ocamlformat-ignore
+1281376e351d6c2be9ea4c576a29ebd4:.ocp-indent
+7a038eccc259630a7aaa876eceb826ba:CHANGES.md
+c4217a22064a4a18f9587b930b250fbe:LICENSE.md
+118525fb5ba6186eedb505bbc7cd9a9c:Makefile
+b091dd96e8b553dd7a7df285279d7d9e:README.md
+8be75c8edbcba1b202a77111dda43d0c:_drom/test
+d41d8cd98f00b204e9800998ecf8427e:docs/.nojekyll
+8c90147085379063e18134a7f18f079b:docs/doc/index.html
+c352caa74812a7a09cdd3e52031d6033:docs/index.html
+8a2ddf0ce1706457ec54652cf0f5ffac:docs/sphinx/index.html
+a95f1ab7d178b468eff6188a527535d9:docs/style.css
+30281c0f416f7fa965c21b066d27eb2c:drom-opam.deps
+2be6032b5de53fc74f1cf300bcf5ba67:drom.opam
+a214da2770f27534d07f5a6120c5a742:drom.toml
+4af4aefc60cfb31ded96d242d76d2e5a:drom_lib.opam
+97eadaa266cb426e18086dbf393d9951:dune
+e4c401c332554eaf0cf522d3dbed4735:dune-project
+d41d8cd98f00b204e9800998ecf8427e:sphinx/_static/css/fixes.css
+a44c87f3a364dd95f55427fe40b2c5d1:sphinx/about.rst
+a27d8599880dce8b4833c38f89ccd6cf:sphinx/conf.py
+31524abd666942907d4ff5e55f3d24b4:sphinx/index.rst
+35f7c2d1720a9af03823647787c53099:sphinx/install.rst
+cf3f86e8f7d8e90e663c3cb7e438057d:sphinx/license.rst
+5a67f25edac115500b168ab38b3c7faf:src/drom/dune
+84f9ee00eede6c0e54dbfb5e1fc871e1:src/drom_lib/dune
+5995081f731bcce4893801234419852a:src/drom_lib/dune2
+f15fedac6f43c154bcd0348b776ac08c:test/expect-tests/dune
+16aa6d750c44bb58dc22a8c2a06d1534:test/expect-tests/test.ml
+75d7504f9c8002ec5ccdd2458f01da09:test/inline-tests/dune
+e001d04969100c711855223ad6c23e6a:test/inline-tests/test.ml
+28db2068920c1259cbd67a7c322730ed:test/output-tests/dune
+f0ef7081e1539ac00ef5b761b4fb01b3:test/output-tests/test1.expected
+894dddf3304cbcb0fe04f7c2bbd56073:test/output-tests/test2.expected
+704ff05ffd8b0e50716542fa55b2db8a:test/output-tests/test2.ml

.gitignore2

@@ -0,0 +1,47 @@
+How to contribute to drom ?
+===========================
+
+There are many ways to contribute to drom. Here are a few starting
+points:
+
+Adding support for a new tool/environement
+------------------------------------------
+
+Suppose you think most OCaml projects should use a given tool. So, you
+may want to contribute support for this tool into projects generated
+by `drom`.
+
+Here is how to do it:
+
+* There are projects' skeletons in `src/drom_lib/skeletons/projects`,
+  in particular the `virtual/` skeleton used as the basis for all
+  other skeletons. You can add a new template file in that skeleton.
+  Template files are used by substitutions of 3 kinds, !{EXPR},
+  !(FIELD) and ![FLAG]. Have a look at other templates for examples.
+
+* Once you have added a file in the skeleton, modify the
+  `dune-trailer` field of the `drom_lib` package in `drom.toml` to add
+  the new file as a dependency of the corresponding skeleton. You will
+  need to call `drom project` to regenerate the `dune` file after
+  every change.
+
+* You may also want to add specific substitutions for your template
+  file. This is done by modifying the project substitution
+  `project_brace` in `src/drom_lib/subst.ml`.
+
+Adding more known licenses
+--------------------------
+
+Known licenses are included by scanning the `src/drom_lib/licenses/`
+directory. Have a look there for example. Every license is defined by:
+
+* the name of its directory, which is the key used in the `license`
+  field in `drom.toml`
+* a file `NAME` with the long name of the license
+* a file `HEADER` with the lines to add in the header of every source file
+* a file `LICENSE` with the complete text of the license
+
+Once you have added a new license, edit the `dune-trailer` field in
+`drom.toml` to add the license files as dependencies (check where the
+other licenses appear). You will need to call `drom project` after
+that to regenerate the corresponding `dune` file.

CONTRIBUTING.md

@@ -1,6 +1,5 @@
 Copyright (c) 2020 OCamlPro SAS & Origin Labs SAS
 
-
 This software is distributed under the terms of the
 GNU Lesser General Public License (LGPL) version 2.1 (included below).
 

LICENSE.md

@@ -0,0 +1,25 @@
+
+
+* Utiliser les squelettes à la création du projet:
+  * lookup du squelette
+  * écriture avec substitution de certains champs
+  * rechargement du projet
+
+* Utiliser les squelettes à la création des packages:
+  * lookup du squelette
+  * écriture avec substitution de certains champs
+  * rechargement du projet
+
+* Ne pas écrire tant que tout n'a pas été calculé, permet d'éviter des
+   erreurs avec un état partiel
+
+* In the case where we share a global switch, pin the package.
+
+* Générer la doc dans gh-pages depuis les github actions plutot que les
+   pusher dans docs/
+
+cargo build --release :
+dune build --profile xxx
+drom run -p xxx
+drom build -p xxx
+drom test -p xxx

TODO

@@ -50,6 +50,7 @@ ocaml-flags = "-w +a-4-40-41-42-44"
 [profile.release]
 ocaml-flags = "-w -a"
 [project]
+generators = ["ocamllex", "menhir"]
 pack-modules = true
 skip-dirs = ["drom-test"]
 
@@ -80,6 +81,8 @@ dune-trailer = """
 (rule
   (targets skel_project_virtual.ml)
   (deps
+skeletons/projects/virtual.toml
+
 skeletons/projects/virtual/dot_ocp-indent
 skeletons/projects/virtual/dot_ocamlformat-ignore
 skeletons/projects/virtual/LICENSE.md
@@ -131,10 +134,21 @@ skeletons/projects/library.toml
     (with-stdout-to %{targets}
     (run skel_packer project library virtual skeletons/projects/library))))
 
+(rule
+  (targets skel_package_virtual.ml)
+  (deps
+    skeletons/packages/virtual.toml
+     )
+  (action
+    (with-stdout-to %{targets}
+    (run skel_packer package virtual None skeletons/packages/virtual))))
+
 (rule
   (targets skel_package_program.ml)
   (deps
+    skeletons/packages/program.toml
     skeletons/packages/program/dune
+    skeletons/packages/program/main.ml
      )
   (action
     (with-stdout-to %{targets}
@@ -143,7 +157,9 @@ skeletons/projects/library.toml
 (rule
   (targets skel_package_library.ml)
   (deps
+    skeletons/packages/library.toml
     skeletons/packages/library/dune
+    skeletons/packages/library/main.ml
      )
   (action
     (with-stdout-to %{targets}
@@ -152,11 +168,41 @@ skeletons/projects/library.toml
 (rule
   (targets skel_package_driver.ml)
   (deps
+    skeletons/packages/driver.toml
     skeletons/packages/driver/dune
+    skeletons/packages/driver/main.ml
      )
   (action
     (with-stdout-to %{targets}
     (run skel_packer package driver None skeletons/packages/driver))))
 
+(rule
+  (targets skel_licenses.ml)
+  (deps
+    licenses/LGPL2/NAME
+    licenses/LGPL2/HEADER
+    licenses/LGPL2/LICENSE
+
+    licenses/GPL3/NAME
+    licenses/GPL3/HEADER
+    licenses/GPL3/LICENSE
+
+    licenses/BSD2/NAME
+    licenses/BSD2/HEADER
+    licenses/BSD2/LICENSE
+
+    licenses/BSD3/NAME
+    licenses/BSD3/HEADER
+    licenses/BSD3/LICENSE
+
+    licenses/ISC/NAME
+    licenses/ISC/HEADER
+    licenses/ISC/LICENSE
+     )
+  (action
+    (with-stdout-to %{targets}
+    (run skel_packer licenses))))
+
 (data_only_dirs skeletons)
 """
+

drom.backup

@@ -0,0 +1,103 @@
+Workspace root: /home/lefessan/GIT/ocp/public-github/drom
+Running[0]: /usr/bin/nproc > /tmp/dune05458a.output 2> /dev/null
+Auto-detected concurrency: 4
+disable binary cache
+Running[1]: /home/lefessan/.opam/4.07.1/bin/ocamlc.opt -config > /tmp/dune80f1d8.output
+Dune context:
+ { name = "default"
+ ; kind = "default"
+ ; profile = Dyn
+ ; merlin = true
+ ; for_host = None
+ ; fdo_target_exe = None
+ ; build_dir = "default"
+ ; toplevel_path = Some External "/home/lefessan/.opam/4.07.1/lib/toplevel"
+ ; ocaml_bin = External "/home/lefessan/.opam/4.07.1/bin"
+ ; ocaml = Ok External "/home/lefessan/.opam/4.07.1/bin/ocaml"
+ ; ocamlc = External "/home/lefessan/.opam/4.07.1/bin/ocamlc.opt"
+ ; ocamlopt = Ok External "/home/lefessan/.opam/4.07.1/bin/ocamlopt.opt"
+ ; ocamldep = Ok External "/home/lefessan/.opam/4.07.1/bin/ocamldep.opt"
+ ; ocamlmklib = Ok External "/home/lefessan/.opam/4.07.1/bin/ocamlmklib.opt"
+ ; env =
+     map
+       { "INSIDE_DUNE" :
+           "/home/lefessan/GIT/ocp/public-github/drom/_build/default"
+       ; "OCAMLFIND_IGNORE_DUPS_IN" :
+           "/home/lefessan/GIT/ocp/public-github/drom/_build/install/default/lib"
+       ; "OCAMLPATH" :
+           "/home/lefessan/GIT/ocp/public-github/drom/_build/install/default/lib"
+       ; "OCAMLTOP_INCLUDE_PATH" :
+           "/home/lefessan/GIT/ocp/public-github/drom/_build/install/default/lib/toplevel"
+       }
+ ; findlib_path = [ External "/home/lefessan/.opam/4.07.1/lib" ]
+ ; arch_sixtyfour = true
+ ; natdynlink_supported = true
+ ; supports_shared_libraries = true
+ ; ocaml_config =
+     { version = "4.07.1"
+     ; standard_library_default = "/home/lefessan/.opam/4.07.1/lib/ocaml"
+     ; standard_library = "/home/lefessan/.opam/4.07.1/lib/ocaml"
+     ; standard_runtime = "/home/lefessan/.opam/4.07.1/bin/ocamlrun"
+     ; ccomp_type = "cc"
+     ; c_compiler = "gcc"
+     ; ocamlc_cflags = [ "-O2"; "-fno-strict-aliasing"; "-fwrapv"; "-fPIC" ]
+     ; ocamlopt_cflags = [ "-O2"; "-fno-strict-aliasing"; "-fwrapv" ]
+     ; bytecomp_c_compiler =
+         [ "gcc"
+         ; "-O2"
+         ; "-fno-strict-aliasing"
+         ; "-fwrapv"
+         ; "-fPIC"
+         ; "-D_FILE_OFFSET_BITS=64"
+         ; "-D_REENTRANT"
+         ]
+     ; bytecomp_c_libraries = [ "-lm"; "-ldl"; "-lpthread" ]
+     ; native_c_compiler =
+         [ "gcc"
+         ; "-O2"
+         ; "-fno-strict-aliasing"
+         ; "-fwrapv"
+         ; "-D_FILE_OFFSET_BITS=64"
+         ; "-D_REENTRANT"
+         ]
+     ; native_c_libraries = [ "-lm"; "-ldl" ]
+     ; cc_profile = [ "-pg" ]
+     ; architecture = "amd64"
+     ; model = "default"
+     ; int_size = 63
+     ; word_size = 64
+     ; system = "linux"
+     ; asm = [ "as" ]
+     ; asm_cfi_supported = true
+     ; with_frame_pointers = false
+     ; ext_exe = ""
+     ; ext_obj = ".o"
+     ; ext_asm = ".s"
+     ; ext_lib = ".a"
+     ; ext_dll = ".so"
+     ; os_type = "Unix"
+     ; default_executable_name = "a.out"
+     ; systhread_supported = true
+     ; host = "x86_64-unknown-linux-gnu"
+     ; target = "x86_64-unknown-linux-gnu"
+     ; profiling = true
+     ; flambda = false
+     ; spacetime = false
+     ; safe_string = false
+     ; exec_magic_number = "Caml1999X023"
+     ; cmi_magic_number = "Caml1999I024"
+     ; cmo_magic_number = "Caml1999O023"
+     ; cma_magic_number = "Caml1999A023"
+     ; cmx_magic_number = "Caml1999Y023"
+     ; cmxa_magic_number = "Caml1999Z023"
+     ; ast_impl_magic_number = "Caml1999M023"
+     ; ast_intf_magic_number = "Caml1999N023"
+     ; cmxs_magic_number = "Caml1999D023"
+     ; cmt_magic_number = "Caml1999T024"
+     ; natdynlink_supported = true
+     ; supports_shared_libraries = true
+     ; windows_unicode = false
+     }
+ }
+Actual targets:
+- recursive alias @doc

drom.toml

@@ -4,7 +4,6 @@ Copyright and License
 
 Copyright (c) 2020 OCamlPro SAS & Origin Labs SAS
 
-
 This software is distributed under the terms of the
 GNU Lesser General Public License (LGPL) version 2.1 (included below).