Skip to content

Commit a35bd87

Browse files
mbtoolsmbtools
authored
Merge pull request #1 from abapPM/template
chore: update template files
2 parents 35ff755 + 715ee13 commit a35bd87

File tree

7 files changed

+250
-38
lines changed

7 files changed

+250
-38
lines changed

‎.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# All contributions are important small and big
2+
github: abappm
3+
github: mbtools

‎.reuse/dep5

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎CHANGELOG.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
66
The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
77
and [ISO Date Format](https://www.iso.org/iso-8601-date-and-time-format.html).
88

9-
## [Unreleased]
10-
11-
### Added
12-
13-
### Changed
14-
15-
### Fixed
16-
9+
See [unreleased changes] for the latest updates.
1710

1811
## Version [1.0.0] - 2022-01-01
1912

2013
Initial Release.
2114

22-
23-
[Unreleased]: https://github.com/abapPM/ABAP-.../compare/1.0.0...main
24-
[1.0.0]: https://github.com/abapPM/ABAP-.../releases/tag/1.0.0
15+
[unreleased changes]: https://github.com/abapPM/ABAP-Syntax-Highlighter/compare/1.0.0...main
16+
[1.0.0]: https://github.com/abapPM/ABAP-Syntax-Highlighter/releases/tag/1.0.0

‎LICENSES/CC0-1.0.txt

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README.md

Lines changed: 75 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,101 @@
1-
![Version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/abapPM/ABAP-XXX/src/zcl_XXX.clas.abap/c_version&label=Version&color=blue)
1+
![Version](https://img.shields.io/endpoint?url=https://shield.abappm.com/github/abapPM/ABAP-Syntax-Highlighter/src/zcl_Syntax-Highlighter.clas.abap/c_version&label=Version&color=blue)
22

3-
[![License](https://img.shields.io/github/license/abapPM/ABAP-XXX?label=License&color=success)](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
3+
[![License](https://img.shields.io/github/license/abapPM/ABAP-Syntax-Highlighter?label=License&color=success)](https://github.com/abapPM/ABAP-Syntax-Highlighter/blob/main/LICENSE)
44
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?color=success)](https://github.com/abapPM/.github/blob/main/CODE_OF_CONDUCT.md)
5-
[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/ABAP-XXX)](https://api.reuse.software/info/github.com/abapPM/ABAP-XXX)
5+
[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/ABAP-Syntax-Highlighter)](https://api.reuse.software/info/github.com/abapPM/ABAP-Syntax-Highlighter)
66

7-
# XXX
7+
# Syntax-Highlighter
88

9+
Syntax highlighter for ABAP, HTML, XML, CSS, JavaScript, JSON, Markdown, and more.
910

10-
11-
NO WARRANTIES, [MIT License](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
11+
NO WARRANTIES, [MIT License](https://github.com/abapPM/ABAP-Syntax-Highlighter/blob/main/LICENSE)
1212

1313
## Usage
1414

15-
...
15+
For example, here's how you highlight keywords and comments in a line of ABAP code:
16+
17+
```abap
18+
DATA(highlighter) = zcl_highlighter_factory=>create( 'file.abap' ).
19+
20+
DATA(code) = `call function 'FM_NAME'. " Commented`.
21+
22+
DATA(html) = highlighter->process_line( code ).
23+
24+
WRITE html.
25+
```
26+
27+
Output:
28+
29+
```html
30+
<span class="keyword">call</span> <span class="keyword">function</span> <span class="text">'FM_NAME'</span>. <span class="comment">" Commented</span>
31+
```
32+
33+
The language is derived from the extension of the filename passed to the factory:
34+
35+
Extension | Syntax Highlighter
36+
------------|-------------------
37+
`.abap` | ABAP Code
38+
`.css` | CSS3
39+
`.diff` | Git Diff
40+
`.html ` | HTML
41+
`.ini ` | Plain Text
42+
`.js ` | JavaScript
43+
`.json` | JSON
44+
`.json5` | JSON5 (limited support for comments)
45+
`.jsonc` | JSON (with end-of-line comments)
46+
`.markdown` | Markdown
47+
`.md` | Markdown
48+
`.sass` | SASS
49+
`.scss` | SCSS
50+
`.text ` | Plain Text
51+
`.txt ` | Plain Text
52+
`.xml ` | XML
53+
`.yaml ` | YAML (experimental)
54+
`.yml ` | YAML (experimental)
55+
56+
> [!NOTE]
57+
> It's recommended to process one line at a time instead of passing a long string containing newline separators.
58+
59+
Options:
60+
61+
You can show invisible characters in the output by settings an option in the factory call. This will highlight the following characters: horizontal tab (x09), form feed (x0C), carriage return (x0D), space (x20), as well as byte-order-marks (BOM) for UTF-8 (xEF BB BF), UTF-16 big-endian (xFE FF), and UTF-16 little-endian (xFF FE).
62+
63+
```abap
64+
DATA(highlighter) = zcl_highlighter_factory=>create(
65+
filename = 'file.abap'
66+
hidden_chars = abap_true ).
67+
```
1668

1769
## Prerequisites
1870

1971
SAP Basis 7.40 or higher
2072

2173
## Installation
2274

23-
Import ABAP XXX to your project using [apm](https://abappm.com).
75+
Install `syntax-highlighter` as a global module in your system using [apm](https://abappm.com).
2476

25-
```abap
26-
IMPORT '*' TO 'z$1_your_project$2' FROM 'xxx'.
27-
" or
28-
IMPORT '*' TO '/namespace/$1$2' FROM 'xxx'.
29-
```
77+
or
78+
79+
Specify the `syntax-highlighter` module as a dependency in your project and import it to your namespace using [apm](https://abappm.com).
3080

3181
## Contributions
3282

33-
All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/ABAP-XXX/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request.
83+
All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/ABAP-Syntax-Highlighter/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request.
84+
85+
You can install the developer version of ABAP SYNTAX-HIGHLIGHTER using [abapGit](https://github.com/abapGit/abapGit) by creating a new online repository for `https://github.com/abapPM/ABAP-Syntax-Highlighter`.
86+
87+
Recommended SAP package: `$SYNTAX-HIGHLIGHTER`
88+
89+
## Attibution
3490

35-
You can install the developer version of ABAP XXX using [abapGit](https://github.com/abapGit/abapGit) either by creating a new online repository for https://github.com/abapPM/ABAP-XXX.
91+
This project includes the code for the following open-source projects. Please support them if you can!
3692

37-
Recommended SAP package: `$XXX`
93+
- [abapGit](https://github.com/abapGit/abapGit), abapGit Community, [MIT](https://github.com/abapGit/abapGit/blob/main/LICENSE)
3894

3995
## About
4096

41-
Made with ❤️ in Canada
97+
Made with ❤ in Canada
4298

43-
Copyright 2024 apm.to Inc. <https://apm.to>
99+
Copyright 2025 apm.to Inc. <https://apm.to>
44100

45-
Follow [@marcfbe](https://twitter.com/marcfbe) on X/Twitter or [marcfbe](https://linkedin.com/in/marcfbe) or LinkedIn
101+
Follow [@marcf.be](https://bsky.app/profile/marcf.be) on Blueksy and [@marcfbe](https://linkedin.com/in/marcfbe) or LinkedIn

‎REUSE.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version = 1
2+
3+
[[annotations]]
4+
path = "**/*"
5+
SPDX-FileCopyrightText = "2025 apm.to Inc. <https://apm.to>"
6+
SPDX-License-Identifier = "MIT"

‎package.abap.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "xxx",
3+
"version": "1.0.0",
4+
"description": "XXX",
5+
"type": "module",
6+
"keywords": [
7+
"abap",
8+
"apm",
9+
"module"
10+
],
11+
"homepage": "https://abappm.com",
12+
"bugs": {
13+
"url": "https://github.com/abapPM/ABAP-XXX"
14+
},
15+
"license": "MIT",
16+
"author": {
17+
"name": "Marc Bernard",
18+
"url": "https://abappm.com",
19+
"email": "marc@abappm.com"
20+
},
21+
"maintainers": [
22+
{
23+
"name": "Marc Bernard",
24+
"url": "https://github.com/mbtools",
25+
"email": "marc@abappm.com"
26+
}
27+
],
28+
"repository": {
29+
"url": "https://github.com/abapPM/ABAP-XXX"
30+
},
31+
"funding": {
32+
"type": "github",
33+
"url": "https://github.com/sponsors/abapPM"
34+
},
35+
"dependencies": {
36+
"error": "^1.0.0"
37+
},
38+
"engines": {
39+
"abap": ">=7.50",
40+
"apm": ">=1"
41+
}
42+
}

0 commit comments

Comments
 (0)