Skip to content

Commit 4ab6014

Browse files
committed
feat: basic setup
0 parents  commit 4ab6014

7 files changed

+237
-0
lines changed

.editorconfig

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Editor configuration, see http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
indent_style = space
7+
indent_size = 2
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
end_of_line = lf
11+
12+
[*.md]
13+
max_line_length = off
14+
trim_trailing_whitespace = false
15+
16+
[Makefile]
17+
indent_style = tab

.gitignore

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Editors
2+
.vscode/
3+
*.swp
4+
5+
# OS artifacts
6+
.DS_Store
7+
Thumbs.db
8+
9+
# vscode-sops
10+
.decrypted~*.yaml
11+
*.agekey
12+
.env
13+
.envrc
14+
15+
# Local .terraform directories
16+
**/.terraform/*
17+
18+
# .tfstate files
19+
*.tfstate
20+
*.tfstate.*
21+
22+
# Crash log files
23+
crash.log
24+
25+
# Exclude all .tfvars files, which are likely to contain sentitive data, such as
26+
# password, private keys, and other secrets. These should not be part of version
27+
# control as they are data points which are potentially sensitive and subject
28+
# to change depending on the environment.
29+
#
30+
*.tfvars
31+
32+
# Ignore override files as they are usually used to override resources locally and so
33+
# are not checked in
34+
override.tf
35+
override.tf.json
36+
*_override.tf
37+
*_override.tf.json
38+
39+
# Include override files you do wish to add to version control using negated pattern
40+
#
41+
# !example_override.tf
42+
43+
# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
44+
# example: *tfplan*
45+
46+
# Ignore CLI configuration files
47+
.terraformrc
48+
terraform.rc
49+
50+
.terraform.lock.hcl

.markdownlint.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
default: true
3+
4+
# MD013/line-length - Line length
5+
MD013:
6+
# Number of characters
7+
line_length: 240
8+
# Number of characters for headings
9+
heading_line_length: 80
10+
# Number of characters for code blocks
11+
code_block_line_length: 120
12+
# Include code blocks
13+
code_blocks: true
14+
# Include tables
15+
tables: true
16+
# Include headings
17+
headings: true
18+
# Include headings
19+
headers: true
20+
# Strict length checking
21+
strict: false
22+
# Stern length checking
23+
stern: false

.pre-commit-config.yaml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
fail_fast: false
3+
default_stages:
4+
- commit
5+
- push
6+
7+
repos:
8+
- repo: https://github.com/thlorenz/doctoc
9+
rev: v2.2.0
10+
hooks:
11+
- id: doctoc
12+
args:
13+
- --update-only
14+
- --maxlevel
15+
- "3"
16+
- --github
17+
- --notitle
18+
19+
- repo: https://github.com/pre-commit/pre-commit-hooks
20+
rev: v4.5.0
21+
hooks:
22+
- id: check-merge-conflict
23+
- id: check-added-large-files
24+
args:
25+
- --maxkb=100
26+
- id: check-case-conflict
27+
- id: check-executables-have-shebangs
28+
- id: check-json
29+
- id: check-symlinks
30+
- id: check-xml
31+
- id: detect-private-key
32+
- id: end-of-file-fixer
33+
- id: fix-byte-order-marker
34+
- id: mixed-line-ending
35+
args:
36+
- --fix=auto
37+
- id: trailing-whitespace
38+
args:
39+
- --markdown-linebreak-ext=md
40+
- id: no-commit-to-branch
41+
args: ["--branch", "main"]
42+
43+
- repo: https://github.com/Lucas-C/pre-commit-hooks
44+
rev: v1.5.4
45+
hooks:
46+
- id: remove-crlf
47+
- id: remove-tabs
48+
49+
- repo: https://github.com/sirosen/fix-smartquotes
50+
rev: 0.2.0
51+
hooks:
52+
- id: fix-smartquotes
53+
54+
- repo: https://github.com/igorshubovych/markdownlint-cli
55+
rev: v0.37.0
56+
hooks:
57+
- id: markdownlint-fix
58+
args:
59+
- --config
60+
- .markdownlint.yaml
61+
62+
- repo: https://github.com/k8s-at-home/sops-pre-commit
63+
rev: v2.1.1
64+
hooks:
65+
- id: forbid-secrets
66+
67+
- repo: https://github.com/pre-commit/mirrors-prettier
68+
rev: v3.1.0
69+
hooks:
70+
- id: prettier
71+
args:
72+
- --ignore-path
73+
- .prettierignore
74+
- --config
75+
- .prettierrc.yaml
76+
77+
- repo: https://github.com/zricethezav/gitleaks
78+
rev: v8.18.1
79+
hooks:
80+
- id: gitleaks-docker

.prettierignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.sops.*
2+
**/.terraform/**
3+
terraform.tfstate*

.prettierrc.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
trailingComma: "es5"
3+
tabWidth: 2
4+
semi: false
5+
singleQuote: false

README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
<!-- markdownlint-disable MD041 -->
2+
<!-- markdownlint-disable MD033 -->
3+
<!-- markdownlint-disable MD028 -->
4+
5+
<!-- PROJECT SHIELDS -->
6+
<!--
7+
*** I'm using markdown "reference style" links for readability.
8+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
9+
*** See the bottom of this document for the declaration of the reference variables
10+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
11+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
12+
-->
13+
14+
[![pre-commit][pre-commit-shield]][pre-commit-url]
15+
16+
# tyriis.dev static page
17+
18+
<details>
19+
<summary style="font-size:1.2em;">Table of Contents</summary>
20+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
21+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
22+
23+
- [Getting Started](#getting-started)
24+
- [Prerequisties](#prerequisties)
25+
- [Configuration](#configuration)
26+
- [Known Issues](#known-issues)
27+
28+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
29+
</details>
30+
31+
## Getting Started
32+
33+
### Prerequisties
34+
35+
| Tool | Role |
36+
| ------------------------ | ------------------------------------------ |
37+
| [pre-commit][pre-commit] | QA improvement to check code before commit |
38+
| [prettier][prettier-url] | scan security in terraform definitions |
39+
40+
## Configuration
41+
42+
<!-- TBD -->
43+
44+
## Known Issues
45+
46+
<!-- TBD -->
47+
48+
<!-- MARKDOWN LINKS & IMAGES -->
49+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
50+
51+
<!-- Links -->
52+
53+
[pre-commit]: https://pre-commit.com/
54+
[prettier-url]: https://prettier.io/
55+
56+
<!-- Badges -->
57+
58+
[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=for-the-badge
59+
[pre-commit-url]: https://github.com/pre-commit/pre-commit

0 commit comments

Comments
 (0)