Skip to content

Commit 8e077b1

Browse files
thorspherethorsphere
committed
Completed implementation
1 parent aaf56ab commit 8e077b1

20 files changed

Lines changed: 972 additions & 67 deletions

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
moderation at thorsphere.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing to tslog
2+
3+
First, thanks for taking the time! Everyone is welcomed to contribute!
4+
5+
- Please open issues or pull requests on GitHub to report bugs and propose improvements.
6+
- Please open pull requests on GitHub to contribute to the source code.
7+
- If you consider contributing large new features please consider to have a [discussion](https://github.com/thorsphere/lpcode/discussions) before beginning with the clean implementation.
8+
- If you have a question, please start a [discussion](https://github.com/thorsphere/lpcode/discussions).

‎OSSMETADATA‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
osslifecycle=active

‎README.md‎

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,90 @@
11
# lpcode
2-
Go package to generate Go code
2+
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/thorsphere/lpcode)](https://goreportcard.com/report/github.com/thorsphere/lpcode)
4+
[![CodeFactor](https://www.codefactor.io/repository/github/thorsphere/lpcode/badge)](https://www.codefactor.io/repository/github/thorsphere/lpcode)
5+
![OSS Lifecycle](https://img.shields.io/osslifecycle/thorsphere/lpcode)
6+
7+
[![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/thorsphere/lpcode)](https://pkg.go.dev/mod/github.com/thorsphere/lpcode)
8+
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/thorsphere/lpcode)
9+
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/thorsphere/lpcode)
10+
11+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/thorsphere/lpcode)
12+
![GitHub last commit](https://img.shields.io/github/last-commit/thorsphere/lpcode)
13+
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/thorsphere/lpcode)
14+
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/thorsphere/lpcode)
15+
![GitHub Top Language](https://img.shields.io/github/languages/top/thorsphere/lpcode)
16+
![GitHub](https://img.shields.io/github/license/thorsphere/lpcode)
17+
18+
[Go](https://go.dev/) package for programmatic Go code generation that tries to keep it simple ([KISS principle](https://en.wikipedia.org/wiki/KISS_principle)). The package is designed primarily to support the [tserrgen](https://github.com/thorsphere/tserrgen) code generator.
19+
20+
- **Simple**: A simple and fluent API with method chaining
21+
- **Formatted**: Automatic gofmt integration for clean output
22+
- **Tested**: Well-tested with unit tests with high code coverage
23+
- **Dependencies**: Minimal dependencies and only depends on [Go Standard Library](https://pkg.go.dev/std), [tsfio](https://pkg.go.dev/github.com/thorsphere/tsfio) and [tserr](https://pkg.go.dev/github.com/thorsphere/tserr)
24+
25+
## Usage
26+
27+
In the Go app, the package is imported with
28+
29+
```go
30+
import "github.com/thorsphere/lpcode"
31+
```
32+
33+
A Codefile represents a code file with an interface that provides methods to start, write and finish the code file. A utility for managing the lifecycle of code files.
34+
35+
```go
36+
func NewCodefile(dn tsfio.Directory, fn tsfio.Filename) (*Codefile, error)
37+
func (cf *Codefile) StartFile() error
38+
func (cf *Codefile) WriteCode(c *Code) error
39+
func (cf *Codefile) FinishFile() error
40+
```
41+
42+
There are helper functions for formatting, retrieving the code file filepath and for retrieving its contents as a string.
43+
44+
```go
45+
func (cf *Codefile) Format() error
46+
func (cf *Codefile) Filepath() tsfio.Filename
47+
func (cf *Codefile) String() string
48+
```
49+
50+
A Code contains the source code as string. A builder for constructing Go source code strings using method chaining. The Code type offers a range of methods for generating common Go syntax. The stored source code is amended by using its methods. The source code can be retrieved with String and formatted with Format.
51+
52+
```go
53+
func NewCode() *Code
54+
func (code *Code) LineComment(c string) *Code
55+
func (code *Code) FuncEnd() *Code
56+
func (code *Code) BlockEnd() *Code
57+
func (code *Code) Call(n string) *Code
58+
func (code *Code) ParamEndln() *Code
59+
func (code *Code) ParamEnd() *Code
60+
func (code *Code) Func1(a *Func1Args) *Code
61+
func (code *Code) TypeStruct(n string) *Code
62+
func (code *Code) VarSpec(a *VarSpecArgs) *Code
63+
func (code *Code) List() *Code
64+
func (code *Code) Listln() *Code
65+
func (code *Code) SelField(a *SelArgs) *Code
66+
func (code *Code) SelMethod(a *SelArgs) *Code
67+
func (code *Code) If(a *IfArgs) *Code
68+
func (code *Code) IfErr(a *IfErrArgs) *Code
69+
func (code *Code) Return() *Code
70+
func (code *Code) Addr() *Code
71+
func (code *Code) Ident(n string) *Code
72+
func (code *Code) Assignment(a *AssignmentArgs) *Code
73+
func (code *Code) CompositeLit(LiteralType string) *Code
74+
func (code *Code) ShortVarDecl(a *ShortVarDeclArgs) *Code
75+
func (code *Code) KeyedElement(a *KeyedElementArgs) *Code
76+
func (code *Code) Testvariables(t *Testvars) *Code
77+
func (code *Code) Format() error
78+
func (code *Code) String() string
79+
```
80+
81+
## Example
82+
83+
## Links
84+
85+
[Godoc](https://pkg.go.dev/github.com/thorsphere/lpcode)
86+
87+
[Go Report Card](https://goreportcard.com/report/github.com/thorsphere/lpcode)
88+
89+
[Open Source Insights](https://deps.dev/go/github.com%2Fthorsphere%2Flpcode)
90+

‎SECURITY.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you think you've identified a security issue, please send an email with all relevant details
6+
to security at thorsphere.com. Please do not report the issue publicly.
7+
8+
## Security Vulnerability Response
9+
10+
If the security report moves to a fix and a new release, it will be referred to in the release notes.

0 commit comments

Comments
 (0)