Skip to content

Commit

Permalink
feat(theme): Manage themes create, list, install (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
germainlefebvre4 authored Jan 10, 2025
1 parent 2499eb9 commit 4a61a47
Show file tree
Hide file tree
Showing 48 changed files with 1,109 additions and 511 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ test.y*ml
test.html
test.pdf

# Themes
/themes/

# Generated directory
/generated/

Expand All @@ -24,4 +27,5 @@ cv.html
# Documentation
.venv/

# Goreleaser
dist/
325 changes: 325 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
---
# This file contains all available configuration options
# with their default values.

# options for analysis running
run:
# default concurrency is a available CPU number
concurrency: 7

# timeout for analysis, e.g. 30s, 5m, default is 1m
timeout: 5m

# exit code when at least one issue was found, default is 1
issues-exit-code: 1

# include test files or not, default is true
tests: true

modules-download-mode: mod

# output configuration options
output:

# print lines of code with issue, default is true
print-issued-lines: true

# print linter name in the end of issue text, default is true
print-linter-name: true

# make issues output unique by line, default is true
uniq-by-line: true

# all available settings of specific linters
linters-settings:
depguard:
rules:
log:
deny:
- pkg: "gopkg.in/DataDog/dd-trace-go.v1/internal/log"
desc: "use github.com/sirupsen/logrus instead"
- pkg: "github.com/bombsimon/logrusr/v2"
desc: "use github.com/sirupsen/logrus instead"
- pkg: "github.com/opentracing/opentracing-go/log"
desc: "use github.com/sirupsen/logrus instead"
- pkg: "gopkg.in/DataDog/dd-trace-go.v1/contrib/sirupsen/logrus"
desc: "use github.com/sirupsen/logrus instead"
list-mode: lax
files:
- "!**/cmd/ctrlplane_backend/ctrlplane_backend.go"
yaml:
deny:
- pkg: "github.com/goccy/go-yaml"
desc: "use github.com/goccy/go-yaml instead"
- pkg: "gopkg.in/yaml.v3"
desc: "use github.com/goccy/go-yaml instead"
- pkg: "github.com/spf13/viper/internal/encoding/yaml"
desc: "use github.com/goccy/go-yaml instead"
- pkg: "k8s.io/apimachinery/pkg/util/yaml"
desc: "use github.com/goccy/go-yaml instead"
list-mode: lax
dogsled:
# checks assignments with too many blank identifiers; default is 2
max-blank-identifiers: 2
dupl:
# tokens count to trigger issue, 150 by default
threshold: 100
errcheck:
# report about not checking of errors in type assertions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: true

# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
check-blank: true
funlen:
lines: 100 # TODO: We should reduce these value in time
statements: 60
gocognit:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10
nestif:
# minimal complexity of if statements to report, 5 by default
min-complexity: 4
goconst:
# minimal length of string constant, 3 by default
min-len: 3
# minimal occurrences count to trigger, 3 by default
min-occurrences: 3
gocritic:
# Which checks should be enabled; can't be combined with 'disabled-checks';
# See https://go-critic.github.io/overview#checks-overview
# To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
# By default list of stable checks is used.
enabled-checks:
- rangeValCopy

# Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
disabled-checks:
- regexpMust

# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- performance
disabled-tags:
- experimental

settings: # settings passed to gocritic
captLocal: # must be valid enabled check name
paramsOnly: true
rangeValCopy:
sizeThreshold: 32
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 15
godot:
# check all top-level comments, not only declarations
check-all: false
godox:
# report any comments starting with keywords, this is useful for TODO or FIXME comments that
# might be left in the code accidentally and should be resolved before merging
keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
- NOTE
- OPTIMIZE # marks code that should be optimized before merging
- HACK # marks hack-arounds that should be removed before merging
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true
goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
local-prefixes: github.com/adeo/aap-core-backend/
govet:

# settings per analyzer
settings:
printf: # analyzer name, run `go tool vet help` to see all analyzers
funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf

# enable or disable analyzers by name
enable-all: false
disable:
- atomicalign
- shadow
disable-all: false
lll:
# max line length, lines longer will be reported. Default is 120.
# '\t' is counted as 1 character by default, and can be changed with the tab-width option
line-length: 120
# tab width in spaces. Default to 1.
tab-width: 1
misspell:
# Correct spellings using locale preferences for US or UK.
# Default is to use a neutral variety of English.
# Setting locale to US will correct the British spelling of 'colour' to 'color'.
locale: US
ignore-words:
- someword
nakedret:
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30
max-func-lines: 30
prealloc:
# XXX: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.

# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
# True by default.
simple: true
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default
rowserrcheck:
packages:
- github.com/jmoiron/sqlx
testpackage:
# regexp pattern to skip files
skip-regexp: (export|internal)_test\.go
unparam:
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false
whitespace:
multi-if: false # Enforces newlines (or comments) after every multi-line if statement
multi-func: false # Enforces newlines (or comments) after every multi-line function signature
wsl:
# If true append is only allowed to be cuddled if appending value is
# matching variables, fields or types on line above. Default is true.
strict-append: true
# Allow calls and assignments to be cuddled as long as the lines have any
# matching variables, fields or types. Default is true.
allow-assign-and-call: true
# Allow multiline assignments to be cuddled. Default is true.
allow-multiline-assign: true
# Allow declarations (var) to be cuddled.
allow-cuddle-declarations: false
# Allow trailing comments in ending of blocks
allow-trailing-comment: false
# Force newlines in end of case at this limit (0 = never).
force-case-trailing-whitespace: 0
# Force cuddling of err checks with err var assignment
force-err-cuddling: false
# Allow leading comments to be separated with empty liens
allow-separated-leading-comment: false

linters:
enable:
- depguard
- staticcheck
- errcheck
- errorlint
- govet
- prealloc
- goconst
- gocyclo
- goimports
- misspell
- unused
- usestdlibvars
- gosec
- gocheckcompilerdirectives
- ineffassign
- unparam
- unconvert
- funlen #to add
# - stylecheck or revive to add
disable-all: false
presets:
- bugs
- unused
fast: false

issues:
# List of regexps of issue texts to exclude, empty list by default.
# But independently from this option we use default exclude patterns,
# it can be disabled by `exclude-use-default: false`. To list all
# excluded by default patterns execute `golangci-lint run --help`
exclude:
- abcdef

# Excluding configuration per-path, per-linter, per-text and per-source
exclude-rules:
# Exclude some linters from running on tests files.
- path: .*_test\.go$
linters:
- funlen
- goimports
- gocyclo
- errcheck
- dupl
- gosec
- noctx
- errchkjson
- musttag
- goconst
- path: .*_mock\.go$
linters:
- funlen
- goimports
- gocyclo
- errcheck
- dupl
- gosec
- noctx
- errchkjson
- musttag
- goconst
- path: .*test.*\.go$
linters:
- funlen
- goimports
- gocyclo
- errcheck
- dupl
- gosec
- noctx
- errchkjson
- musttag
- goconst
- path: .*.go$
linters:
- bodyclose

# Exclude known linters from partially hard-vendored code,
# which is impossible to exclude via "nolint" comments.
- path: internal/hmac/
text: "weak cryptographic primitive"
linters:
- gosec

# Exclude some staticcheck messages
- linters:
- staticcheck
text: "SA9003:"
- linters:
- staticcheck
text: "G601:"
# Exclude lll issues for long lines with go:generate
- linters:
- lll
source: "^//go:generate "

# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
# Default value for this option is true.
exclude-use-default: false

# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-issues-per-linter: 0

# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 0

# Show only new issues: if there are unstaged changes or untracked files,
# only those changes are analyzed, else only changes in HEAD~ are analyzed.
# It's a super-useful option for integration of golangci-lint into existing
# large codebase. It's not practical to fix all existing issues at the moment
# of integration: much better don't allow issues in new code.
# Default is false.
new: false
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ mkdocs:
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
- requirements: docs/requirements.txt
21 changes: 17 additions & 4 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,25 @@
"args": [
"generate",
// "serve",
"--input=cv.yml",
"--output=generated/",
"--theme=default",
"--format=pdf",
// "--input=cv.yml",
// "--output=generated/",
// "--theme=default",
// "--format=pdf",
// "--watch",
// "--verbose",

// "themes",
// "list",

// "themes",
// "install",
// "github.com/germainlefebvre4/cvwonder-theme-default",

// "themes",
// "create",
// "--name=default-theme",
// "--name='My New Theme'",
// "--name=\"My New Theme\"",
],
"debugAdapter": "dlv-dap",
"env": {
Expand Down
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,16 @@ run:

build: ## Build
go build -o cvwonder ./cmd/cvwonder
chmod +x cvwonder

doc-install:
poetry --directory docs/ lock && poetry --directory docs/ install

doc:
poetry --directory docs/ run mkdocs serve --config-file docs/mkdocs.yml

goreleser-check:
goreleaser check

goreleser-release:
goreleaser release --snapshot --clean
Loading

0 comments on commit 4a61a47

Please sign in to comment.