docs: fix test documentation (#466)

.gitignore

@@ -5,5 +5,8 @@ target/
 __pycache__/
 .pytest_cache/
 
+# mkdocs
+.cache
+
 # pixi environments
 .pixi

README.md

@@ -85,6 +85,8 @@ package as output. The `test` subcommand can be used to test existing packages
 A simple example recipe for the `xtensor` header-only C++ library:
 
 ```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/prefix-dev/recipe-format/main/schema.json
+
 context:
   name: xtensor
   version: 0.24.6
@@ -127,8 +129,8 @@ requirements:
   run_constrained:
     - xsimd >=8.0.3,<10
 
-test:
-  commands:
+tests:
+  - script:
     - if: unix or emscripten
       then:
         - test -d ${PREFIX}/include/xtensor
@@ -190,13 +192,11 @@ requirements:
     - python 3.10
     - typing_extensions >=4.0.0,<5.0.0
 
-test:
-  imports:
-    - rich
-  commands:
-    - pip check
-  requires:
-    - pip
+tests:
+  - python:
+      imports:
+        - rich
+      pip_check: true
 
 about:
   homepage: https://github.com/Textualize/rich

docs/recipe_file.md

@@ -114,9 +114,10 @@ requirements:
     - python
 
 # tests to validate that the package works as expected
-test:
-  imports:
-    - imagesize
+tests:
+  - python:
+      imports:
+        - imagesize
 
 # information about the package
 about:
@@ -372,10 +373,11 @@ build:
   noarch: python
 ```
 
-> ***Note***: At the time of this writing, `noarch` packages should not make use
-> of preprocess-selectors: `noarch` packages are built with the directives which
-> evaluate to `true` in the platform it is built on, which probably will result
-> in incorrect/incomplete installation in other platforms.
+!!! note
+    At the time of this writing, `noarch` packages should not make use
+    of preprocess-selectors: `noarch` packages are built with the directives which
+    evaluate to `true` in the platform it is built on, which probably will result
+    in incorrect/incomplete installation in other platforms.
 
 <!--
 ### Include build recipe
@@ -473,7 +475,7 @@ version is part of the package dependencies, list `numpy` as a requirement in
 `recipe.yaml` and use a `conda_build_config.yaml` file with multiple NumPy
 versions.
 
-### Run\_constrained
+### Run constrained
 
 Packages that are optional at runtime but must obey the supplied additional
 constraint if they are installed.
@@ -484,7 +486,7 @@ specifications](https://conda.io/projects/conda/en/latest/user-guide/concepts/pk
 ```yaml
 requirements:
   run_constrained:
-    - optional-subpackage =={{ version }}
+    - optional-subpackage ==${{ version }}
 ```
 
 For example, let's say we have an environment that has package "a" installed at
@@ -884,7 +886,7 @@ and automatically selects the right (cross-)compiler for the target platform.
 
 ```
 build:
-  - "{{ compiler('c') }}"
+  - ${{ compiler('c') }}
 ```
 
 The `pin_subpackage` function pins another package produced by the recipe with
@@ -928,8 +930,6 @@ requirements:
 
 #### Pin compatible
 
-**Note: not yet implemented**
-
 Pin compatible lets you pin a package based on the version retrieved from the
 variant file (if the pinning from the variant file needs customization).
 
@@ -1018,22 +1018,22 @@ Lists are automatically "merged" upwards, so it is possible to group multiple
 items under a single selector:
 
 ```yaml
-test:
-  commands:
-    - if: unix
-      then:
-      - test -d ${PREFIX}/include/xtensor
-      - test -f ${PREFIX}/lib/cmake/xtensor/xtensorConfigVersion.cmake
-    - if: win
-      then:
-      - if not exist %LIBRARY_PREFIX%\include\xtensor\xarray.hpp (exit 1)
-      - if not exist %LIBRARY_PREFIX%\lib\cmake\xtensor\xtensorConfigVersion.cmake (exit 1)
+tests:
+  - script:
+      - if: unix
+        then:
+        - test -d ${PREFIX}/include/xtensor
+        - test -f ${PREFIX}/lib/cmake/xtensor/xtensorConfigVersion.cmake
+      - if: win
+        then:
+        - if not exist %LIBRARY_PREFIX%\include\xtensor\xarray.hpp (exit 1)
+        - if not exist %LIBRARY_PREFIX%\lib\cmake\xtensor\xtensorConfigVersion.cmake (exit 1)
 
 # On unix this is rendered to:
-test:
-commands:
-    - test -d ${PREFIX}/include/xtensor
-    - test -f ${PREFIX}/lib/cmake/xtensor/xtensorConfigVersion.cmake
+tests:
+  - script:
+      - test -d ${PREFIX}/include/xtensor
+      - test -f ${PREFIX}/lib/cmake/xtensor/xtensorConfigVersion.cmake
 ```
 
 <!--

examples/cargo-edit/recipe.yaml

@@ -21,9 +21,9 @@ requirements:
     - ${{ compiler('rust') }}
     - cargo-bundle-licenses
 
-test:
-  commands:
-    - cargo-upgrade --help
+tests:
+  - script:
+      - cargo-upgrade --help
 
 about:
   homepage: https://github.com/killercup/cargo-edit

examples/mamba/recipe.yaml

@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/prefix-dev/recipe-format/main/schema.json
+
 context:
   name: mamba
   libmamba_version: "1.5.3"
@@ -55,8 +57,8 @@ outputs:
           - spdlog
           - python
         # - ${{ "python" if win }}
-    test:
-      commands:
+    tests:
+      - script:
         - if: unix
           then:
             - test -d ${PREFIX}/include/mamba  # [unix]
@@ -114,12 +116,13 @@ outputs:
       ignore_run_exports:
         by_name:
           - spdlog
-    test:
-      imports:
-        - libmambapy
-        - libmambapy.bindings
-      commands:
-        - python -c "import libmambapy._version; assert libmambapy._version.__version__ == '${{ libmambapy_version }}'"
+    tests:
+      - python:
+          imports:
+            - libmambapy
+            - libmambapy.bindings
+      - script:
+          - python -c "import libmambapy._version; assert libmambapy._version.__version__ == '${{ libmambapy_version }}'"
 
   - package:
       name: mamba
@@ -148,12 +151,11 @@ outputs:
         - conda >=23.9,<24
         - ${{ pin_subpackage('libmambapy', exact=True) }}
 
-    test:
-      imports:
-        - mamba
-      requires:
-        - pip
-      commands:
+    tests:
+      - python:
+          imports:
+            - mamba
+      - script:
         - mamba --help
         # for some reason tqdm doesn't have a proper colorama dependency so pip check fails
         # but that's completely unrelated to mamba