rosu-memory-lib 1.3.1

A library to read osu! memory
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# git-cliff ~ default configuration file

# https://git-cliff.org/docs/configuration

#

# Lines starting with "#" are comments.

# Configuration options are organized into tables and keys.

# See documentation for more information on available options.



[changelog]

# template for the changelog footer

header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""

# template for the changelog body

# https://keats.github.io/tera/docs/#introduction

body = """
{% if version %}\

    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\

    ## [unreleased]
{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits | unique(attribute="message") %}
        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\

            {% if commit.breaking %}[**breaking**] {% endif %}\

            {{ commit.message | upper_first }} \

			{% if commit.github.username %}by @{{ commit.github.username}} {% endif %}\

    {% endfor %}
{% endfor %}\n
"""

# template for the changelog footer

footer = """
<!-- generated by git-cliff -->
"""

# remove the leading and trailing s

trim = true

# postprocessors

postprocessors = [

  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL

]



[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = true

# process each line of a commit as an individual commit

split_commits = false

# regex for preprocessing the commit messages

commit_preprocessors = [

  # Replace issue numbers

  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},

  # Check spelling of the commit with https://github.com/crate-ci/typos

  # If the spelling is incorrect, it will be automatically fixed.

  #{ pattern = '.*', replace_command = 'typos --write-changes -' },

]

# regex for parsing and grouping commits

commit_parsers = [

  { message = "^feat", group = "<!-- 0 -->🚀 Features" },

  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },

  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },

  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },

  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },

  { message = "^style", group = "<!-- 5 -->🎨 Styling" },

  { message = "^test", group = "<!-- 6 -->🧪 Testing" },

  { message = "^chore\\(release\\): prepare for", skip = true },

  { message = "^chore\\(deps.*\\)", skip = true },

  { message = "^chore\\(pr\\)", skip = true },

  { message = "^chore\\(pull\\)", skip = true },

  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },

  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },

  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },

  { message = "binding", group = "<!-- 10 -->🔗 Bindings" },

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = false

# filter out the commits that are not matched by commit parsers

filter_commits = false

# regex for matching git tags

# tag_pattern = "v[0-9].*"

# regex for skipping tags

# skip_tags = ""

# regex for ignoring tags

# ignore_tags = ""

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "oldest"

# limit the number of commits included in the changelog.

# limit_commits = 42