✨ Analyser CLI

[juiwenchen]

Add Analyzer :

Impemented Anaylzer CLI and API

1. Three types of markers extraction from comments:

• one-line needs declared by one-line comment style
• Need ID Refs
• Marked RST block

2. Extract the scopes such Class and Functions tagged by these markers

3. CLI can only be used with TOML config file

Remove Virtual Docs and integrate one-line parser into Analyzer

1. One-line comment pattern is integrated into Analyzer as one of the marker type one-line needs

2. caching in Virtual Docs is removed and will bring back in the future

Adaption of Sphinx directive src-trace

1. using Analyzer to extract One-line needs

2. Config files of src-trace and Anaylzer CLI are not compatible and will adapt in the future

[ubmarco]

Default for marker should be @need-ids:.
This should be documented. It will avoid the following surprise:

    "marker": "@",
    "need_ids": ["req-id:", "need_001", "need_002", "need_003", "need_004"]
  },

while it should be

    "marker": "@",
    "type": "need-id-refs",
    "need_ids": ["need_001", "need_002", "need_003", "need_004"]
  },

There a couple of use case of the analyzer and the downstream consumers do not know what use case is extracted.
Add this:

"type": "need-id-refs",

Use cases:

• need-id-refs
• need
• rst

An example output json can look like:

[
  {
    "filepath": "tests/data/anchors/dummy_1.cpp",
    "remote_url": "https://github.com/useblocks/sphinx-codelinks/blob/f2d8d98ca10361663191c4c96255f39db9b5f518/tests/data/anchors/dummy_1.cpp#L3",
    "source_map": {
        "start": {
            "row": 10,
            "column": 3
        },
        "end": {
            "row": 13,
            "column": 16
        }
    },
    "marker": "@req-id:",
    "type": "need-id-refs",
    "need_ids": ["need_001", "need_002", "need_003", "need_004"]
  },
  {
    "filepath": "tests/data/anchors/dummy_1.cpp",
    "remote_url": "https://github.com/useblocks/sphinx-codelinks/blob/f2d8d98ca10361663191c4c96255f39db9b5f518/tests/data/anchors/dummy_1.cpp#L3",
    "source_map": {
        "start": {
            "row": 20,
            "column": 3
        },
        "end": {
            "row": 26,
            "column": 15
        }
    },
    "type": "need",
    "need": {
        "id": "TEST_001",
        "type": "test",
        "title": "Test a function"
    }
  },
  {
    "filepath": "tests/data/anchors/dummy_1.cpp",
    "remote_url": "https://github.com/useblocks/sphinx-codelinks/blob/f2d8d98ca10361663191c4c96255f39db9b5f518/tests/data/anchors/dummy_1.cpp#L3",
    "source_map": {
        "start": {
            "row": 30,
            "column": 3
        },
        "end": {
            "row": 35,
            "column": 15
        }
    },
    "type": "rst",
    "rst": "some paragraph with **bold** text and a \n\n.. test:: Test case\n   :id: TEST_002\n   This is a test case for the function.\n"
  }
]

[ubmarco]

unpinned dependency, either pick a release or refer to a commit, document that clang is required due to this bug, also point out what's wrong.

[ubmarco]

Did an online review, looks good for the first version