<commit_before>Cross Reference Model Definition Language (CRMDL) Scheme
========================================================

CRMDL Syntax
------------
.. code : yaml

    include:
      <field>: <primitive type>
      <field-alias>: <cmrdl://>
      <field-alias>:
        from: <cmrdl://>
        include:
          - <field>
          - <field alias>
      <field-alias>:
        from: <cmrdl://>
        exclude:
          - <field>
          - <field alias>
    export:
      - <field>
      - <field alias>


CRMDL context
-------------

.. code: yaml

$repo: <domain>
$owner: <some-body>
$tree: <branch> | <tag>
$group: <some-group>
$name: some.namespace.name



CRMDL Reference Syntax
======================

Local Reference
---------------
.. code : yaml

    syntax: name#field
   example: some.namespace.name#someField
            repo    = $repo
            owner   = $owner
            group   = $group
            tree    = $tree
            name    = some.name.space.name
            field   = someField

Cross-Tree Reference
--------------------

.. code : yaml

    syntax: tree/name#field
   example: some-tree/some.namespace.name#someField
            repo    = $repo
            owner   = $owner
            group   = $group
            tree    = some-tree
            name    = some.name.space.name
            field   = someField

Cross-Group Reference
---------------------

.. code : yaml

    syntax: group/tree/name#field
   example: other-group/other-master/other.namespace.name#otherFiled
            repo    = $repo
            owner   = $owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Cross-Owner Reference
---------------------

.. code : yaml

    syntax: owner/group/tree/name#field
   example: other-owner/other-group/other-master/other.namespace.name#otherFiled
            repo    = $repo
            owner   = other-owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Cross-Repo Reference
--------------------

.. code : yaml

    syntax: /repo/owner/group/tree/name#field
   example: /other-repo/other-owner/other-group/other-master/other.namespace.name#otherFiled
            repo    = other-repo
            owner   = other-owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Maven Mapping Reference
-----------------------

.. code : yaml

    syntax: mvn://repo/owner/group/name/tree#!field<commit_msg>	modified:   README.rst<commit_after>Cross Reference Model Definition Language (CRMDL) Scheme
========================================================

CRMDL Syntax
------------
.. code-block:yaml

    include:
      <field>: <primitive type>
      <field-alias>: <cmrdl://>
      <field-alias>:
        from: <cmrdl://>
        include:
          - <field>
          - <field alias>
      <field-alias>:
        from: <cmrdl://>
        exclude:
          - <field>
          - <field alias>
    export:
      - <field>
      - <field alias>


CRMDL context
-------------

.. code-block:yaml

$repo: <domain>
$owner: <some-body>
$tree: <branch> | <tag>
$group: <some-group>
$name: some.namespace.name



CRMDL Reference Syntax
======================

Local Reference
---------------

.. code-block:yaml

    syntax: name#field
   example: some.namespace.name#someField
            repo    = $repo
            owner   = $owner
            group   = $group
            tree    = $tree
            name    = some.name.space.name
            field   = someField

Cross-Tree Reference
--------------------

.. code-block:yaml

    syntax: tree/name#field
   example: some-tree/some.namespace.name#someField
            repo    = $repo
            owner   = $owner
            group   = $group
            tree    = some-tree
            name    = some.name.space.name
            field   = someField

Cross-Group Reference
---------------------

.. code-block:yaml

    syntax: group/tree/name#field
   example: other-group/other-master/other.namespace.name#otherFiled
            repo    = $repo
            owner   = $owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Cross-Owner Reference
---------------------

.. code-block:yaml

    syntax: owner/group/tree/name#field
   example: other-owner/other-group/other-master/other.namespace.name#otherFiled
            repo    = $repo
            owner   = other-owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Cross-Repo Reference
--------------------

.. code-block:yaml

    syntax: /repo/owner/group/tree/name#field
   example: /other-repo/other-owner/other-group/other-master/other.namespace.name#otherFiled
            repo    = other-repo
            owner   = other-owner
            group   = other-group
            tree    = other-master
            name    = other.namespace.name
            field   = otherFiled

Maven Mapping Reference
-----------------------

.. code-block:yaml

    syntax: mvn://repo/owner/group/name/tree#!field
{'fraction_non_alphanumeric': 0.17794392523364486, 'fraction_numerical': 0.0, 'mean_word_length': 1.4523373052245647, 'pattern_counts': {'":': 0, '<': 41, '<?xml version=': 0, '>': 41, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7602468', 'n_tokens_mistral': 1508, 'n_tokens_neox': 1468, 'n_words': 313}