Skip to content

Commit 223c8ff

Browse files
committed
Design proposal
0 parents  commit 223c8ff

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2362
-0
lines changed

.czrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{ "path": "cz-conventional-changelog" }

.editorconfig

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

.env.sample

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# shellcheck disable=SC2034,SC2148
2+
# tools/bats
3+
SRC_DIR="${PWD}/dist"
4+
BATS_LIBS_DIR=/usr/lib
5+
# :tools/bats

.gitattributes

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Common settings that generally should always be used with your language specific settings
2+
3+
# Auto detect text files and perform LF normalization
4+
* text=auto
5+
6+
#
7+
# The above will handle all files NOT found below
8+
#
9+
10+
# Documents
11+
*.bibtex text diff=bibtex
12+
*.doc diff=astextplain
13+
*.DOC diff=astextplain
14+
*.docx diff=astextplain
15+
*.DOCX diff=astextplain
16+
*.dot diff=astextplain
17+
*.DOT diff=astextplain
18+
*.pdf diff=astextplain
19+
*.PDF diff=astextplain
20+
*.rtf diff=astextplain
21+
*.RTF diff=astextplain
22+
*.md text diff=markdown
23+
*.mdx text diff=markdown
24+
*.tex text diff=tex
25+
*.adoc text
26+
*.textile text
27+
*.mustache text
28+
*.csv text
29+
*.tab text
30+
*.tsv text
31+
*.txt text
32+
*.sql text
33+
*.epub diff=astextplain
34+
35+
# Graphics
36+
*.png binary
37+
*.jpg binary
38+
*.jpeg binary
39+
*.gif binary
40+
*.tif binary
41+
*.tiff binary
42+
*.ico binary
43+
# SVG treated as text by default.
44+
*.svg text
45+
# If you want to treat it as binary,
46+
# use the following line instead.
47+
# *.svg binary
48+
*.eps binary
49+
50+
# Scripts
51+
*.bash text eol=lf
52+
*.fish text eol=lf
53+
*.sh text eol=lf
54+
*.zsh text eol=lf
55+
# These are explicitly windows files and should use crlf
56+
*.bat text eol=crlf
57+
*.cmd text eol=crlf
58+
*.ps1 text eol=crlf
59+
60+
# Serialisation
61+
*.json text
62+
*.toml text
63+
*.xml text
64+
*.yaml text
65+
*.yml text
66+
67+
# Archives
68+
*.7z binary
69+
*.gz binary
70+
*.tar binary
71+
*.tgz binary
72+
*.zip binary
73+
74+
# Text files where line endings should be preserved
75+
*.patch -text
76+
77+
#
78+
# Exclude files from exporting
79+
#
80+
81+
.gitattributes export-ignore
82+
.gitignore export-ignore
83+
.gitkeep export-ignore

.githooks/commit-msg

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env sh
2+
3+
commitlint --edit "${1}"

.githooks/pre-commit

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/usr/bin/env sh
2+
3+
HERE="$(cd "$(dirname "$0")" && pwd)"
4+
pre-commit hook-impl --config=.pre-commit-config.yaml --hook-type=pre-commit --hook-dir "$HERE" -- "$@"
5+
./tools/update-readme
6+
7+
git add README.md

.github/labels.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
- color: d73a4a
2+
description: Something isn't working
3+
name: bug
4+
5+
- color: 0075CA
6+
description: Improvements or additions to documentation
7+
name: documentation
8+
9+
- color: cfd3d7
10+
description: This issue or pull request already exists
11+
name: duplicate
12+
13+
- color: a2eeef
14+
description: New feature or request
15+
name: enhancement
16+
17+
- color: ebc602
18+
description: New feature
19+
name: feature
20+
21+
- color: fef2c0
22+
description: New feature request
23+
name: feature request
24+
25+
- color: 7057ff
26+
description: Good for newcomers
27+
name: good first issue
28+
29+
- color: "008672"
30+
description: Extra attention is needed
31+
name: help wanted
32+
33+
- color: e4e669
34+
description: This doesn't seem right
35+
name: invalid
36+
37+
- color: d876e3
38+
description: Further information is requested
39+
name: question
40+
41+
- color: ffffff
42+
description: This will not be worked on
43+
name: wontfix

.github/workflows/sync-labels.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Sync labels
2+
on:
3+
push:
4+
branches:
5+
- master
6+
paths:
7+
- .github/labels.yml
8+
workflow_dispatch:
9+
10+
jobs:
11+
labels:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
- uses: micnncim/action-label-syncer@v1.3.0
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.SYNC_LABEL_TOKEN }}
18+
with:
19+
manifest: .github/labels.yml

.gitignore

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Visual Studio Code
2+
/.vscode/*
3+
!.vscode/settings.json
4+
!.vscode/tasks.json
5+
!.vscode/launch.json
6+
!.vscode/extensions.json
7+
!.vscode/*.code-snippets
8+
/.VSCodeCounter
9+
/.history/
10+
11+
# Built Visual Studio Code Extensions
12+
*.vsix
13+
14+
/.env
15+
/dist/.env
16+
/TODO
17+
/test.bash

.pre-commit-config.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.4.0
4+
hooks:
5+
- id: check-merge-conflict
6+
- id: check-yaml
7+
- id: end-of-file-fixer
8+
- id: trailing-whitespace
9+
- id: check-executables-have-shebangs
10+
- id: check-symlinks
11+
12+
- repo: https://github.com/jumanjihouse/pre-commit-hooks
13+
rev: 3.0.0
14+
hooks:
15+
- id: shfmt
16+
- id: shellcheck
17+
types: [bash]

.shellcheckrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
external-sources=true

.vscode/bash.code-snippets

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
// Place your snippets for shellscript here. Each snippet is defined under a snippet name and has a prefix, body and
3+
// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
4+
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the
5+
// same ids are connected.
6+
// Example:
7+
"if.argument-empty": {
8+
"prefix": "if argument empty",
9+
"body": [
10+
"if [[ -z \"\\$${1:variable}\" ]]; then",
11+
" err \"Argument '${2:variable}' must not be empty\"",
12+
" return \"\\$ERR_INVAL_ARG\"",
13+
"fi",
14+
"$0"
15+
],
16+
"description": "Check if argument is empty"
17+
}
18+
}

.vscode/launch.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"type": "bashdb",
9+
"request": "launch",
10+
"name": "Bash-Debug (dotfiles)",
11+
"env": {
12+
"DESTDIR": ""
13+
},
14+
"program": "${workspaceFolder}/dist/usr/bin/dotfiles"
15+
},
16+
]
17+
}

.vscode/settings.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"files.associations": {
3+
"*.zunit": "bats"
4+
},
5+
"search.exclude": {
6+
"dist/lib/**": true,
7+
},
8+
"files.exclude": {
9+
"dist/lib/**": true
10+
},
11+
"todo-tree.tree.showBadges": true,
12+
"chatgpt.promptPrefix.addTests": "Implement tests for the following bash code using the testing framework BATS, use bats assert library for assertions, prefix all tests names with the name of function under test including the function parenthesis. use assert_success instead of '[ \"$status\" -eq 0 ]', use assert_output instead '[ \"$output\" = \"<value...>\" ]'",
13+
"spellright.language": [
14+
"en-US-10-1."
15+
],
16+
"spellright.documentTypes": [
17+
"markdown",
18+
"latex",
19+
"plaintext"
20+
]
21+
}

.ydf.env.sample

Whitespace-only changes.

0 commit comments

Comments
 (0)