Symbol and String Collection (Web UI)

In this tutorial we’ll introduce the different addon pipeline that can be used for collecting symbols and strings from codebase resources.

Note

This tutorial assumes that you have a working installation of ScanCode.io. If you don’t, please refer to the Installation page.

Throughout this tutorial, we will use this resource for symbol and string collection.

_images/tutorial-web-ui-symbol-and-string-collection-demo-resource.png

Ctags Symbols

  • Open any existing projects containing a few resources.

  • Click on the “Add pipeline” button and select the “collect_symbols_ctags” pipeline from the dropdown list. Check the “Execute pipeline now” option and validate with the “Add pipeline” button.

Warning

The collect_symbols_ctags pipeline requires universal-ctags, please refer to the System Dependencies.

  • Once the pipeline run completes with success, you can reach the Resources list view by clicking the count number under the “RESOURCES” header:

_images/tutorial-web-ui-symbol-and-string-collection-resource-link.png
  • Click on any code file and go to Extra tab, to get the resource symbols.

_images/tutorial-web-ui-symbol-and-string-collection-result-ctags.png

Xgettext Strings

  • Open any existing projects containing a few resources.

  • Click on the “Add pipeline” button and select the “collect_strings_gettext” pipeline from the dropdown list. Check the “Execute pipeline now” option and validate with the “Add pipeline” button.

Warning

The collect_strings_gettext pipeline requires gettext, please refer to the System Dependencies.

  • Once the pipeline run completes with success, you can reach the Resources list view by clicking the count number under the “RESOURCES” header:

  • Click on any code file and go to Extra tab, to get the resource strings.

_images/tutorial-web-ui-symbol-and-string-collection-result-xgettext.png

Tree-Sitter Symbols and Strings

  • Open any existing projects containing a few resources.

  • Click on the “Add pipeline” button and select the “collect_symbols_tree_sitter” pipeline from the dropdown list. Check the “Execute pipeline now” option and validate with the “Add pipeline” button.

  • Once the pipeline run completes with success, you can reach the Resources list view by clicking the count number under the “RESOURCES” header:

  • Click on any code file and go to Extra tab, to get the resource symbols and strings.

_images/tutorial-web-ui-symbol-and-string-collection-result-tree-sitter.png

Pygments Symbols and Strings

  • Open any existing projects containing a few resources.

  • Click on the “Add pipeline” button and select the “collect_symbols_pygments” pipeline from the dropdown list. Check the “Execute pipeline now” option and validate with the “Add pipeline” button.

  • Once the pipeline run completes with success, you can reach the Resources list view by clicking the count number under the “RESOURCES” header:

  • Click on any code file and go to Extra tab, to get the resource symbols and strings.

_images/tutorial-web-ui-symbol-and-string-collection-result-pygments.png