Liking cljdoc? Tell your friends :D

code-maat.app.grouper


group-grammarclj

Here's the instaparse grammar for a regex-based grouping/layering. We expect the groups to be specified as text: some-path => some_name or with a regex: ^some-regexp$ => some_name That is, everything matching some-path or some-regexp will be grouped under some_name.

Here's the instaparse grammar for a regex-based grouping/layering.
 We expect the groups to be specified as text:
    some-path => some_name
or with a regex:
   ^some-regexp$ => some_name
 That is, everything matching some-path or some-regexp will be grouped
 under some_name.
sourceraw docstring

map-entities->groupsclj

(map-entities->groups commits groups)

Maps each entity in the commits to one of the pre-defined architectural boundaries (groups). The groups are given as a seq of maps. Each map denotes the physical path to the group together with its logical name. We translate that path into a regex that matches entity names with logical names.

Maps each entity in the commits to one of the pre-defined
architectural boundaries (groups).
The groups are given as a seq of maps. Each map denotes the
physical path to the group together with its logical name.
We translate that path into a regex that matches
entity names with logical names.
sourceraw docstring

runclj

(run group-info-file commits)

This entry point parses the given group info. All entities in each commit are then re-mapped to one of the given groups.

This entry point parses the given group info.
All entities in each commit are then re-mapped to one
of the given groups.
sourceraw docstring

text->group-specificationclj

(text->group-specification input)

Transforms the given text or regular expression into a seq of maps specifying the grouping. Each map will have a path key corresponding to a regex pattern and a name key corresponding to the grouping logical name: {:path #'^some/path/' :name 'some_name'} or {:path #'^some-regexp$' :name 'some_name'}

Transforms the given text or regular expression into a
seq of maps specifying the grouping.
Each map will have a path key corresponding to a regex pattern
and a name key corresponding to the grouping logical name:
 {:path #'^some/path/' :name 'some_name'}
 or
 {:path #'^some-regexp$' :name 'some_name'}
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close