add --preset base

ysawa0 · ysawa0 · commit e9464328dab5 · 2024-05-12T14:01:01.000-07:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -79,7 +79,7 @@ repos:
     hooks:
       - id: flake8 # Lints Python code for errors and code style issues based on PEP8.
         args:
-          - --config=.cpa/flake8.cfg
+          - --config=.ci/flake8.cfg
         types:
           - python
         exclude: templates/
@@ -103,7 +103,7 @@ repos:
     hooks:
       - id: prettier # An opinionated code formatter supporting multiple languages.
         name: prettier
-        args: [--config, .cpa/prettier.json, --write]
+        args: [--config, .ci/prettier.json, --write]
         types_or:
           - css
           - scss
@@ -112,7 +112,7 @@ repos:
           - javascript
           - yaml
           - markdown
-        exclude: templates/.pre-commit-config.yaml|templates/.github/workflows/ci.yaml
+        exclude: templates/.pre-commit-config.yaml|templates/.github/workflows/ci.yaml|templates/base/ci.yaml
 
   #############################################################################
   # Rust
diff --git a/example/python/.pre-commit-config.yaml b/example/python/.pre-commit-config.yaml
@@ -77,7 +77,7 @@ repos:
     hooks:
       - id: flake8 # Lints Python code for errors and code style issues based on PEP8.
         args:
-          - --config=.cpa/flake8.cfg
+          - --config=.ci/flake8.cfg
         types:
           - python
 
@@ -100,7 +100,7 @@ repos:
     hooks:
       - id: prettier # An opinionated code formatter supporting multiple languages.
         name: prettier
-        args: [--config, .cpa/prettier.json, --write]
+        args: [--config, .ci/prettier.json, --write]
         types_or:
           - css
           - scss
diff --git a/example/python/.vscode/settings.json b/example/python/.vscode/settings.json
@@ -4,6 +4,6 @@
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "ms-python.black-formatter"
   },
-  "flake8.args": ["--config=.cpa/flake8.cfg"],
+  "flake8.args": ["--config=.ci/flake8.cfg"],
   "files.insertFinalNewline": true
 }
diff --git a/example/rust/.pre-commit-config.yaml b/example/rust/.pre-commit-config.yaml
@@ -59,7 +59,7 @@ repos:
     hooks:
       - id: prettier # An opinionated code formatter supporting multiple languages.
         name: prettier
-        args: [--config, .cpa/prettier.json, --write]
+        args: [--config, .ci/prettier.json, --write]
         types_or:
           - css
           - scss
diff --git a/example/rust/.vscode/settings.json b/example/rust/.vscode/settings.json
@@ -4,6 +4,6 @@
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "ms-python.black-formatter"
   },
-  "flake8.args": ["--config=.cpa/flake8.cfg"],
+  "flake8.args": ["--config=.ci/flake8.cfg"],
   "files.insertFinalNewline": true
 }
diff --git a/src/main.rs b/src/main.rs
@@ -3,7 +3,7 @@ mod presets;
 use std::process;
 
 use clap::Parser;
-use presets::{common, python, rust};
+use presets::{base, common, python, rust};
 use regex::Regex;
 
 #[derive(Parser)]
@@ -46,6 +46,13 @@ pub struct Language {
 
 #[allow(clippy::needless_return)]
 fn validate_preset(preset: &str) -> Language {
+    if preset == "base" {
+        return Language {
+            language: "base".to_string(),
+            ver: "".to_string(),
+        };
+    }
+
     if preset == "rust" {
         return Language {
             language: "rust".to_string(),
@@ -78,6 +85,8 @@ fn main() {
             } else if lang.language == "rust" {
                 let prefix = common(&args.name, create, &lang);
                 rust(&args.name, &prefix);
+            } else if lang.language == "base" {
+                let _prefix = base(&args.name, create, &lang);
             } else {
                 eprintln!("Preset: {:?} not supported", args.preset);
             }
@@ -93,6 +102,8 @@ fn main() {
             } else if lang.language == "rust" {
                 let prefix = common(&args.name, create, &lang);
                 rust(&args.name, &prefix);
+            } else if lang.language == "base" {
+                let _prefix = base(&args.name, create, &lang);
             } else {
                 eprintln!("Preset: {:?} not supported", args.preset);
             }
diff --git a/src/presets.rs b/src/presets.rs
@@ -45,7 +45,11 @@ pub struct Makefile {}
 pub struct GhCI {}
 
 #[derive(Template)]
-#[template(path = ".cpa/prettier.json", escape = "none")]
+#[template(path = "base/ci.yaml", escape = "none")]
+pub struct GhCIBase {}
+
+#[derive(Template)]
+#[template(path = ".ci/prettier.json", escape = "none")]
 pub struct Prettier {}
 
 #[derive(Template)]
@@ -54,17 +58,19 @@ pub struct PreCommitConfig {
     pub language: String,
 }
 
+#[derive(Template)]
+#[template(path = "base/.pre-commit-config.yaml", escape = "none")]
+pub struct PreCommitConfigBase {
+    pub language: String,
+}
+
 ////////////////////////////////////
 // PYTHON
 ////////////////////////////////////
 #[derive(Template)]
 #[template(path = "python/Dockerfile", escape = "none")]
 pub struct PyDockerfile {}
 
-#[derive(Template)]
-#[template(path = "python/main.py", escape = "none")]
-pub struct PyMain {}
-
 #[derive(Template)]
 #[template(path = "python/pyproject.toml", escape = "none")]
 pub struct PyProject {
@@ -74,7 +80,7 @@ pub struct PyProject {
 }
 
 #[derive(Template)]
-#[template(path = ".cpa/flake8.cfg", escape = "none")]
+#[template(path = ".ci/flake8.cfg", escape = "none")]
 pub struct Flake8 {}
 
 ////////////////////////////////////
@@ -98,7 +104,7 @@ pub fn common(name: &str, create: bool, lang: &Language) -> String {
     let prefix: String = if create { format!("./{}", name) } else { "./".to_string() };
 
     // Create needed dirs
-    let _ = fs::create_dir_all(format!("{}/.cpa", prefix));
+    let _ = fs::create_dir_all(format!("{}/.ci", prefix));
     let _ = fs::create_dir_all(format!("{}/.vscode", prefix));
     let _ = fs::create_dir_all(format!("{}/.github/workflows", prefix));
 
@@ -110,7 +116,7 @@ pub fn common(name: &str, create: bool, lang: &Language) -> String {
         language: lang.language.to_string(),
     }
     .write(&prefix, ".pre-commit-config.yaml");
-    Prettier {}.write(&prefix, ".cpa/prettier.json");
+    Prettier {}.write(&prefix, ".ci/prettier.json");
     VSCodeSettings {}.write(&prefix, ".vscode/settings.json");
     VSCodeExtensions {}.write(&prefix, ".vscode/extensions.json");
     prefix
@@ -120,8 +126,7 @@ pub fn python(name: &str, prefix: &str, lang: &Language) {
     let black_target_ver = format!("py{}", lang.ver.replace('.', ""));
 
     // Render Python-specific files
-    Flake8 {}.write(prefix, ".cpa/flake8.cfg");
-    PyMain {}.write(prefix, "main.py");
+    Flake8 {}.write(prefix, ".ci/flake8.cfg");
     PyDockerfile {}.write(prefix, "Dockerfile");
 
     let pyproj: PyProject = PyProject {
@@ -140,3 +145,22 @@ pub fn rust(name: &str, prefix: &str) {
     CargoToml { name: name.to_string() }.write(prefix, "Cargo.toml");
     RustFmt {}.write(prefix, "rustfmt.toml");
 }
+
+pub fn base(name: &str, create: bool, lang: &Language) -> String {
+    let prefix: String = if create { format!("./{}", name) } else { "./".to_string() };
+
+    // Create needed dirs
+    let _ = fs::create_dir_all(format!("{}/.ci", prefix));
+    let _ = fs::create_dir_all(format!("{}/.github/workflows", prefix));
+
+    // Render common files
+    GhCIBase {}.write(&prefix, ".github/workflows/ci.yaml");
+    GitIgnore {}.write(&prefix, ".gitignore");
+    Makefile {}.write(&prefix, "Makefile");
+    PreCommitConfigBase {
+        language: lang.language.to_string(),
+    }
+    .write(&prefix, ".pre-commit-config.yaml");
+    Prettier {}.write(&prefix, ".ci/prettier.json");
+    prefix
+}
diff --git a/templates/.ci/flake8.cfg b/templates/.ci/flake8.cfg
diff --git a/templates/.ci/prettier.json b/templates/.ci/prettier.json
diff --git a/templates/.github/workflows/ci.yaml b/templates/.github/workflows/ci.yaml
@@ -3,10 +3,6 @@ name: CI
 
 on:
   pull_request: # Start the job on all PRs
-    branches: [master, main]
-    types: [synchronize, opened, reopened, ready_for_review]
-  push: # Start the job on all main branch push
-    branches: [master, main]
 
 jobs:
   precommit:
diff --git a/templates/.pre-commit-config.yaml b/templates/.pre-commit-config.yaml
@@ -77,7 +77,7 @@ repos:
     hooks:
       - id: flake8 # Lints Python code for errors and code style issues based on PEP8.
         args:
-          - --config=.cpa/flake8.cfg
+          - --config=.ci/flake8.cfg
         types:
           - python
 
@@ -110,7 +110,7 @@ repos:
     hooks:
       - id: prettier # An opinionated code formatter supporting multiple languages.
         name: prettier
-        args: [--config, .cpa/prettier.json, --write]
+        args: [--config, .ci/prettier.json, --write]
         types_or:
           - css
           - scss
diff --git a/templates/.vscode/settings.json b/templates/.vscode/settings.json
@@ -4,6 +4,6 @@
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "ms-python.black-formatter"
   },
-  "flake8.args": ["--config=.cpa/flake8.cfg"],
+  "flake8.args": ["--config=.ci/flake8.cfg"],
   "files.insertFinalNewline": true
 }
diff --git a/templates/base/.pre-commit-config.yaml b/templates/base/.pre-commit-config.yaml
@@ -0,0 +1,52 @@
+default_language_version:
+  python: python3
+
+repos:
+  #############################################################################
+  # Misc
+  #############################################################################
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict # Searches for merge conflict markers within files.
+      - id: check-added-large-files # Blocks commits that add large files. Default limit is 500kB.
+        # Can be configured with args, e.g., '--maxkb=1000' to change the limit.
+        # exclude: 'your_dir/.*'
+        # args: ['--maxkb=5000']
+      - id: check-case-conflict # Identifies potential case-insensitive file name conflicts.
+      - id: check-ast # Validates the syntax of Python files.
+      - id: check-symlinks # Detects broken symlinks.
+      - id: trailing-whitespace # Removes any trailing whitespace at the end of lines.
+      - id: end-of-file-fixer # Ensures files end with a single newline or are empty.
+
+  #############################################################################
+  # JSON, TOML
+  #############################################################################
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-json # Validates JSON files to ensure they are properly formatted and syntactically correct.
+        types: [json]
+
+  #############################################################################
+  # Shell
+  #############################################################################
+  - repo: https://github.com/jumanjihouse/pre-commit-hooks
+    rev: 3.0.0
+    hooks:
+      - id: shfmt # Formats shell scripts to a standard convention using shfmt.
+      - id: shellcheck # Lints shell scripts to identify syntax and usage errors, with a specified severity of 'warning'.
+        args:
+          - --severity=warning
+  #############################################################################
+  # CSS, Markdown, JavaScript, TypeScript, YAML style formatter
+  #############################################################################
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier # An opinionated code formatter supporting multiple languages.
+        name: prettier
+        args: [--config, .ci/prettier.json, --write]
+        types_or:
+          - yaml
+          - markdown
diff --git a/templates/base/ci.yaml b/templates/base/ci.yaml
@@ -0,0 +1,84 @@
+{% raw -%}
+name: CI
+
+on:
+  pull_request: # Start the job on all PRs
+
+jobs:
+  precommit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Set shfmt version environment variable
+        run: echo "SHFMT_VERSION=v3.7.0" >> $GITHUB_ENV
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Cache shfmt binary
+        uses: actions/cache@v3
+        with:
+          path: /usr/local/bin/shfmt
+          key: ${{ runner.os }}-shfmt-${{ env.SHFMT_VERSION }}
+          restore-keys: |
+            ${{ runner.os }}-shfmt-${{ env.SHFMT_VERSION }}
+            ${{ runner.os }}-shfmt-
+
+      - name: Cache Pre-Commit environments
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pc-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pc-${{ hashFiles('.pre-commit-config.yaml') }}
+            ${{ runner.os }}-pc-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install pre-commit
+          pre-commit install
+
+      - name: Install shfmt
+        run: |
+          SHFMT_VERSION=${{ env.SHFMT_VERSION }}
+          SHFMT_BIN="shfmt_${SHFMT_VERSION}_linux_amd64"
+          if [[ ! -f /usr/local/bin/shfmt ]]; then
+            wget -O shfmt "https://github.com/mvdan/sh/releases/download/${SHFMT_VERSION}/${SHFMT_BIN}"
+            chmod +x shfmt
+            sudo mv shfmt /usr/local/bin/
+          fi
+          sudo apt-get install shellcheck
+
+      - name: Run pre-commits
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          REPO_NAME=$(echo $GITHUB_REPOSITORY | sed 's/^.*\///')
+          DEFAULT_BRANCH=$(curl -H "Authorization: token $GITHUB_TOKEN" \
+            "https://api.github.com/repos/$GITHUB_REPOSITORY" | jq -r '.default_branch')
+
+          git fetch
+          CUR_SHA=$(git log --pretty=tformat:"%H" -n1 . | tail -n1)
+
+          echo "Default branch is $DEFAULT_BRANCH"
+          echo "Current SHA is $CUR_SHA"
+
+          if [[ $GITHUB_REF == "refs/heads/$DEFAULT_BRANCH" ]]; then
+            pre-commit run --all
+          else
+            pre-commit run --from-ref origin/$DEFAULT_BRANCH --to-ref $CUR_SHA
+          fi
+{%- endraw %}
diff --git a/templates/pyproject.toml b/templates/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`"editor.formatOnSave": true,`
`5`	`5`	`"editor.defaultFormatter": "ms-python.black-formatter"`
`6`	`6`	`},`
`7`		`- "flake8.args": ["--config=.cpa/flake8.cfg"],`
	`7`	`+ "flake8.args": ["--config=.ci/flake8.cfg"],`
`8`	`8`	`"files.insertFinalNewline": true`
`9`	`9`	`}`