nmk_workspace.resolvers
=======================

.. py:module:: nmk_workspace.resolvers

.. autoapi-nested-parse::

   Nmk workspace plugin config item resolvers.



Classes
-------

.. autoapisummary::

   nmk_workspace.resolvers.SubProjectsResolver


Module Contents
---------------

.. py:class:: SubProjectsResolver(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Resolver usable find sub-projects in the workspace tree.

   Default behavior is to look sub-projects by iterating through git submodules.
   (other behaviors may be implemented if needed later).


   .. py:method:: get_value(name: str, root: str, only_nmk_projects: bool = True) -> list[str]

      Resolver for sub-projects list.

      :param root: root path of the workspace
      :param only_nmk_projects: if True (default), only return sub-projects having a default nmk project file (nmk.yml)
      :return: list of sub-projects paths relative to the workspace root