feat: convert to copier template (#3)

close #2

Author: msclock

.clang-format

@@ -2,116 +2,116 @@
 # https://clang.llvm.org/docs/ClangFormatStyleOptions.html
 ---
 Language: Cpp
-# 访问说明符(public、protected、private)不偏移
+# Do not offset access specifiers (public, protected, private)
 AccessModifierOffset: -4
-# 开括号(开圆括号、开尖括号、开方括号)后的参数换行需要对齐
+# Align parameters after opening brackets (round, angle, square)
 AlignAfterOpenBracket: Align
-# 连续赋值时，不对齐所有等号
+# Do not align consecutive assignments
 AlignConsecutiveAssignments: false
-# 连续声明时，不对齐所有声明的变量名
+# Do not align consecutive declarations
 AlignConsecutiveDeclarations: false
-# 对齐连续宏定义的样式
+# Align consecutive macros
 AlignConsecutiveMacros: true
-# 将转义的换行符(\)尽可能向左对齐
+# Align escaped newlines to the left
 AlignEscapedNewlines: Left
-# 水平对齐二元和三元表达式的操作数
+# Align operands of binary and ternary expressions horizontally
 AlignOperands: true
-# 对齐连续的尾部注释
+# Align trailing comments
 AlignTrailingComments: true
-# 允许函数的所有参数放到下一行
+# Allow all function arguments on the next line
 AllowAllArgumentsOnNextLine: false
 AllowAllConstructorInitializersOnNextLine: false
 AllowAllParametersOfDeclarationOnNextLine: false
-# 不允许短的代码块放在同一行，如 while 代码块
+# Do not allow short blocks (e.g., while blocks) on a single line
 AllowShortBlocksOnASingleLine: false
-# 不允许短的 case 标签代码块放在同一行
+# Do not allow short case labels on a single line
 AllowShortCaseLabelsOnASingleLine: false
-# 不允许在类外定义的非空函数放在同一行
+# Do not allow non-empty functions defined outside of a class on a single line
 AllowShortFunctionsOnASingleLine: Inline
-# 不允许短的 if 语句放在同一行
+# Do not allow short if statements on a single line
 AllowShortIfStatementsOnASingleLine: false
-# 不允许短的循环代码块放在同一行
+# Do not allow short loop blocks on a single line
 AllowShortLoopsOnASingleLine: false
-# 不要主动在函数定义返回类型处换行，除非超过行字符数限制必须换行
+# Do not break after the return type in function definitions, unless it exceeds the column limit
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
-# 不允许在多行 string 前换行
+# Do not break before multiline strings
 AlwaysBreakBeforeMultilineStrings: false
-# 总是在 template 声明后换行
+# Always break after template declarations
 AlwaysBreakTemplateDeclarations: Yes
-# 不要求函数实参换行时必须每个参数各自一行
+# Do not require each function argument to be on a separate line
 BinPackArguments: false
-# 不要求函数形参换行时必须每个参数各自一行
+# Do not require each function parameter to be on a separate line
 BinPackParameters: false
-# 配置大括号是否换行
+# Configure brace wrapping style
 BraceWrapping:
-  # case 标签后面大括号不换行
+  # Do not break after case labels
   AfterCaseLabel: false
-  # class 定义后面大括号不换行
+  # Do not break after class definitions
   AfterClass: false
-  # 控制语句后面大括号不换行
+  # Do not break after control statements
   AfterControlStatement: false
-  # enum 定义后面大括号不换行
+  # Do not break after enum definitions
   AfterEnum: false
-  # 函数定义后面大括号不换行
+  # Do not break after function definitions
   AfterFunction: false
-  # 命名空间定义后面大括号不换行
+  # Do not break after namespace definitions
   AfterNamespace: false
-  # struct 定义后面大括号不换行
+  # Do not break after struct definitions
   AfterStruct: false
-  # union 定义后面大括号不换行
+  # Do not break after union definitions
   AfterUnion: false
-  # extern 块后面大括号不换行
+  # Do not break after extern blocks
   AfterExternBlock: false
-  # catch 之前需要换行
+  # Break before catch statements
   BeforeCatch: true
-  # else 之前需要换行
+  # Break before else statements
   BeforeElse: true
-  # lambda 大括号不换行
+  # Do not break before lambda bodies
   BeforeLambdaBody: false
-  # while 之前需要换行
+  # Break before while statements
   BeforeWhile: true
-  # 不要缩进大括号
+  # Do not indent braces
   IndentBraces: false
-  # 空函数体可以在同一行
+  # Allow empty function bodies on a single line
   SplitEmptyFunction: false
-  # 空语句可以在同一行
+  # Allow empty statements on a single line
   SplitEmptyRecord: false
-  # 空命名空间可以在同一行
+  # Allow empty namespaces on a single line
   SplitEmptyNamespace: false
-# 需要换行时在二元操作符前换行，除了赋值操作符
+# Break before binary operators, except for assignment operators
 BreakBeforeBinaryOperators: NonAssignment
-# 在 BraceWrapping 中自定义
+# Customize break before braces in BraceWrapping
 BreakBeforeBraces: Custom
-# 继承列表换行时逗号不换行
+# Do not break after commas in inheritance lists
 BreakBeforeInheritanceComma: false
-# 继承列表换行时冒号换行，逗号不换行
+# Break before colons in inheritance lists, but not before commas
 BreakInheritanceList: BeforeColon
-# 在三元运算操作符之前换行
+# Break before ternary operators
 BreakBeforeTernaryOperators: true
-# 构造函数初始化列表换行时逗号不换行
+# Do not break after commas in constructor initializer lists
 BreakConstructorInitializersBeforeComma: false
-# 构造函数初始化列表换行时冒号换行，逗号不换行
+# Break before colons in constructor initializer lists, but not before commas
 BreakConstructorInitializers: BeforeColon
-# 允许断开字符串文字
+# Allow breaking string literals
 BreakStringLiterals: true
-# 每行字符数限制
+# Column limit for each line
 ColumnLimit: 120
 CommentPragmas: '^ IWYU pragma:'
-# 不允许不同的命名空间定义在同一行
+# Do not allow different namespaces to be defined on the same line
 CompactNamespaces: false
-# 构造函数初始化列表要么都在一行，要么每个变量一行
+# Constructor initializer lists should either be all on one line or one per line
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
-# 构造函数初始化列表需要 4 个缩进
+# Indent constructor initializer lists by 4 spaces
 ConstructorInitializerIndentWidth: 4
-# 换行后下一行需要 4 个 缩进
+# Indent continuation lines by 4 spaces
 ContinuationIndentWidth: 4
-# 变量初始化列表前后不需要空格
+# No spaces around variable initialization lists
 Cpp11BracedListStyle: true
 DerivePointerAlignment: true
 DisableFormat: false
 ExperimentalAutoDetectBinPacking: false
-# 自动为命名空间结尾处添加注释
+# Automatically add comments at the end of namespaces
 FixNamespaceComments: true
 ForEachMacros:
   - foreach
@@ -130,23 +130,23 @@ IncludeCategories:
   - Regex: .*
     Priority: 3
 IncludeIsMainRegex: ([-_](test|unittest))?$
-# switch 里的 case 需要缩进
+# Indent case labels inside switch statements
 IndentCaseLabels: true
-# extern 里的代码块需要缩进
+# Indent code blocks inside extern blocks
 IndentExternBlock: Indent
-# 预处理指令不能有缩进
+# Do not indent preprocessor directives
 IndentPPDirectives: None
-# 使用 4 个缩进
+# Use 4 spaces for indentation
 IndentWidth: 4
-# 函数声明、定义时在返回类型处换行时，下一行不要缩进
+# Do not indent wrapped function names after the return type
 IndentWrappedFunctionNames: false
-# 代码块开始处不要有空行
+# Do not keep empty lines at the start of code blocks
 KeepEmptyLinesAtTheStartOfBlocks: false
 MacroBlockBegin: ''
 MacroBlockEnd: ''
-# 不能有连续2个及以上的空行
+# Do not allow consecutive empty lines
 MaxEmptyLinesToKeep: 1
-# 命名空间内的内容不要缩进
+# Do not indent contents inside namespaces
 NamespaceIndentation: None
 PenaltyBreakAssignment: 2
 PenaltyBreakBeforeFirstCallParameter: 1
@@ -156,7 +156,7 @@ PenaltyBreakString: 1000
 PenaltyBreakTemplateDeclaration: 10
 PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 200
-# * & 紧挨类型名
+# * and & should be placed next to the type name
 PointerAlignment: Left
 RawStringFormats:
   - Language: Cpp
@@ -186,39 +186,39 @@ RawStringFormats:
       - ParseTextProtoOrDie
     CanonicalDelimiter: ''
     BasedOnStyle: google
-# 允许对注释重新排版
+# Allow reflowing of comments
 ReflowComments: true
-# 允许对 #include 排序
+# Allow sorting of #include statements
 SortIncludes: true
-# 允许对 using 声明排序
+# Allow sorting of using declarations
 SortUsingDeclarations: true
-# c 风格类型转换括号后不要有空格
+# Do not include spaces after C-style casts
 SpaceAfterCStyleCast: false
-# template 关键字后面需要一个空格
+# Require a space after the template keyword
 SpaceAfterTemplateKeyword: true
-# 赋值运算符两边需要空格
+# Require spaces around assignment operators
 SpaceBeforeAssignmentOperators: true
-# 变量初始化列表大括号前不要有空格
+# Do not include spaces before C++11 braced initializer lists
 SpaceBeforeCpp11BracedList: false
-# 构造函数初始化冒号前需要空格
+# Require a space before the colon in constructor initializers
 SpaceBeforeCtorInitializerColon: true
-# 继承语句冒号前需要一个空格
+# Require a space before the colon in inheritance statements
 SpaceBeforeInheritanceColon: true
-# 控制语句后面需要一个空格(if/for/while...)
+# Require a space after control statement keywords (if, for, while, etc.)
 SpaceBeforeParens: ControlStatements
-# 基于范围循环的冒号前需要一个空格
+# Require a space before the colon in range-based for loops
 SpaceBeforeRangeBasedForLoopColon: true
-# 不要在空的圆括号内添加空格
+# Do not include spaces inside empty parentheses
 SpaceInEmptyParentheses: false
-# 同行尾随注释 // 前面需要一个空格
+# Require a space before // in trailing comments
 SpacesBeforeTrailingComments: 1
-# 尖括号前后没有空格
+# Do not include spaces around angle brackets
 SpacesInAngles: false
-# c 风格类型转换的括号中前后没有空格
+# Do not include spaces around C-style cast parentheses
 SpacesInCStyleCastParentheses: false
-# 圆括号前后没有空格
+# Do not include spaces around parentheses
 SpacesInParentheses: false
-# 方括号前后没有空格
+# Do not include spaces around square brackets
 SpacesInSquareBrackets: false
 Standard: Auto
 StatementMacros:

.copier-answers.yml

@@ -0,0 +1,17 @@
+_commit: 12b9114
+_src_path: .
+author_email: '[email protected]
+
+    '
+author_name: msclock
+copyright_holder: msclock
+copyright_license: MIT License
+copyright_year: 2022-2023
+create_devcontainer: true
+docs_type: sphinx
+organization_name: msclock
+project_description: A development-focused Cpp project template.
+project_name: Cpp Scaffold
+repo_host_type: github.com
+repo_name: cpp-scaffold
+repo_namespace: msclock

.devcontainer/devcontainer.json

@@ -1,35 +1,35 @@
 // For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/cpp
 {
-    "name": "C++",
-    "image": "mcr.microsoft.com/devcontainers/base:jammy",
-    "capAdd": [
-        // Enable ptrace-based debugging for C++
-        "SYS_PTRACE"
-    ],
-    "securityOpt": [
-        "seccomp=unconfined"
-    ],
-    "containerEnv": {
-        "TZ": "Asia/Shanghai"
+  "name": "cpp-scaffold",
+  "image": "mcr.microsoft.com/devcontainers/base:jammy",
+  "capAdd": [
+    // Enable ptrace-based debugging for C++
+    "SYS_PTRACE"
+  ],
+  "securityOpt": [
+    "seccomp=unconfined"
+  ],
+  "containerEnv": {
+    "TZ": "Asia/Shanghai"
+  },
+  // https://github.com/devcontainers/features
+  // Using features in vscode requires access github with uncomment the below
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/python:1": {
+      "installTools": false
     },
-    // https://github.com/devcontainers/features
-    // Using features in vscode requires access github with uncomment the below
-    "features": {
-        "ghcr.io/devcontainers/features/docker-in-docker:2": {},
-        "ghcr.io/devcontainers/features/python:1": {
-            "installTools": false
-        },
-        "ghcr.io/dhoeric/features/act:1": {},
-        "ghcr.io/msclock/features/vcpkg:1": {},
-        "ghcr.io/devcontainers/features/common-utils:2": {
-            "username": "vscode"
-        }
-    },
-    // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": {
-        "git-completions": "echo 'source /usr/share/bash-completion/completions/git' >> ~/.bashrc"
-    },
-    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-    "remoteUser": "vscode"
+    "ghcr.io/dhoeric/features/act:1": {},
+    "ghcr.io/msclock/features/vcpkg:1": {},
+    "ghcr.io/devcontainers/features/common-utils:2": {
+      "username": "vscode"
+    }
+  },
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": {
+    "git-completions": "echo 'source /usr/share/bash-completion/completions/git' >> ~/.bashrc"
+  },
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  "remoteUser": "vscode"
 }

.editorconfig

@@ -1,8 +1,17 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
 root = true
 
 [*]
 end_of_line = lf
+charset = utf-8
+indent_size = 4
 indent_style = space
-indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.{yml,yaml,json,toml,jinja,css}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.github/workflows/lint.yml

@@ -1,12 +1,9 @@
 name: lint
+
 on:
   workflow_dispatch:
   push:
-    branches:
-      - master
   pull_request:
-    branches:
-      - master
 
 jobs:
   pre-commit:

.pre-commit-config.yaml

@@ -40,6 +40,10 @@ repos:
         args:
           - --autofix
           - --offset=2
+        exclude: |
+          (?x)(
+            .copier-answers.yml
+          )
 
   # Changes tabs to spaces
   - repo: https://github.com/Lucas-C/pre-commit-hooks