fix missing EOF newlines in gen'd files (#10)

* fix missing newline on gend files

* fix missing newline on gend files

* fix missing newline on gend files

* fix missing newline on gend files

* clean

* fix missing newline on gend files

* refactor file rendering to common method

* clean

* clean

* debug

* clean

* clean

* clean

* clean

* clean

Author: ysawa0

.pre-commit-config.yaml

@@ -18,6 +18,7 @@ repos:
       - 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.
+        exclude: templates/
 
   #############################################################################
   # JSON, TOML
@@ -71,6 +72,7 @@ repos:
           - pyproject.toml
         types:
           - python
+        exclude: templates/
 
   - repo: https://github.com/pycqa/flake8
     rev: 6.1.0
@@ -80,6 +82,7 @@ repos:
           - --config=.cpa/flake8.cfg
         types:
           - python
+        exclude: templates/
 
   #  - repo: https://github.com/astral-sh/ruff-pre-commit
   #    rev: v0.1.4

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "cpa"
-version = "0.0.7"
-edition = "2018"
+version = "0.0.9"
+edition = "2021"
 
 [dependencies]
 askama = "0.12.1"

Cargo.toml

@@ -0,0 +1,5 @@
+[general]
+# Directories to search for templates, relative to the crate root.
+dirs = ["templates"]
+# Unless you add a `-` in a block, whitespace characters won't be trimmed.
+whitespace = "preserve"

askama.toml

@@ -1,7 +1,10 @@
 mod python;
 
+use std::process;
+
 use clap::Parser;
 use python::setup_preset;
+use regex::Regex;
 
 #[derive(Parser)]
 #[clap(
@@ -34,20 +37,30 @@ struct UpdateArgs {
     preset: String,
 }
 
+fn check_pyver(preset: &str) {
+    let re = Regex::new(r"python(3\.\d+|4\.\d+)").unwrap();
+    if re.captures(preset).is_none() {
+        eprintln!("Python version not recognized in --preset, invalid input. Expected format: 'python3.xx'");
+        process::exit(1);
+    };
+}
+
 fn main() {
     match Cli::parse() {
         Cli::Create(args) => {
             println!("Creating project with name: {}", args.name);
             println!("Using preset: {:?} ", args.preset);
             if args.preset.starts_with("python") {
-                setup_preset(args.preset, args.name, true);
+                check_pyver(&args.preset);
+                setup_preset(&args.preset, args.name, true);
             } else {
                 eprintln!("Preset: {:?} not supported", args.preset);
             }
         }
         Cli::Update(args) => {
             println!("Updating project with preset: {:?}", args.preset);
-            setup_preset(args.preset, "".to_string(), false);
+            check_pyver(&args.preset);
+            setup_preset(&args.preset, "".to_string(), false);
         }
     }
 }

src/main.rs

@@ -7,6 +7,24 @@ use std::{
 use askama::Template;
 use regex::Regex;
 
+trait CPATemplate {
+    fn write(&self, prefix: &str, path: &str);
+}
+
+// Implement convenience trait for any type that implements `askama::Template`
+impl<T: Template> CPATemplate for T {
+    fn write(&self, prefix: &str, path: &str) {
+        let content = append_eof(self.render().expect("Failed to render file."));
+        let mut f = File::create(format!("{}/{}", prefix, path)).expect("Could not create file");
+        f.write_all(content.as_bytes()).expect("Could not write to file");
+    }
+}
+
+fn append_eof(mut s: String) -> String {
+    s.push('\n');
+    s
+}
+
 #[derive(Template)]
 #[template(path = ".gitignore", escape = "none")]
 struct GitIgnore {}
@@ -57,9 +75,9 @@ struct Prettier {}
 #[template(path = ".github/workflows/ci.yaml", escape = "none")]
 struct GHWorkflowCI {}
 
-pub fn setup_preset(mut preset: String, name: String, create: bool) {
+pub fn setup_preset(mut preset: &str, name: String, create: bool) {
     if preset == "python" {
-        preset = "python3.10".to_string();
+        preset = "python3.10";
     }
     let mut prefix: String = "./".to_string();
     if create {
@@ -71,77 +89,25 @@ pub fn setup_preset(mut preset: String, name: String, create: bool) {
     let _ = fs::create_dir_all(format!("{}/.vscode", prefix));
     let _ = fs::create_dir_all(format!("{}/.github/workflows", prefix));
 
-    // Render Github Actions CI
-    File::create(format!("{}/.github/workflows/ci.yaml", prefix))
-        .and_then(|mut file| file.write_all(GHWorkflowCI {}.render().expect("Render fail: ci.yaml").as_bytes()))
-        .expect("Write fail: ci.yaml");
-
-    // Render .vscode/settings.json
-    File::create(format!("{}/.vscode/settings.json", prefix))
-        .and_then(|mut file| file.write_all(VSCodeSettings {}.render().expect("Render fail: .vscode/settings.json").as_bytes()))
-        .expect("Write fail: .vscode/settings.json");
-
-    // Render .vscode/extensions.json
-    File::create(format!("{}/.vscode/extensions.json", prefix))
-        .and_then(|mut file| {
-            file.write_all(
-                VSCodeExtensions {}
-                    .render()
-                    .expect("Render fail: .vscode/extensions.json")
-                    .as_bytes(),
-            )
-        })
-        .expect("Write fail: .vscode/extensions.json");
-
-    // Render .gitignore
-    File::create(format!("{}/.gitignore", prefix))
-        .and_then(|mut file| file.write_all(GitIgnore {}.render().expect("Render fail: .gitignore").as_bytes()))
-        .expect("Write fail: .gitignore");
-
-    // Render Makefile
-    File::create(format!("{}/Makefile", prefix))
-        .and_then(|mut file| file.write_all(Makefile {}.render().expect("Render fail: Makefile").as_bytes()))
-        .expect("Write fail: Makefile");
-
-    // Render Dockerfile
-    File::create(format!("{}/Dockerfile", prefix))
-        .and_then(|mut file| file.write_all(Dockerfile {}.render().expect("Render fail: Dockerfile").as_bytes()))
-        .expect("Write fail: Dockerfile");
-
-    // Render main.py
-    File::create(format!("{}/main.py", prefix))
-        .and_then(|mut file| file.write_all(MainPy {}.render().expect("Render fail").as_bytes()))
-        .expect("Render fail: main.py");
-
-    // Render pre-commit conf
-    File::create(format!("{}/.pre-commit-config.yaml", prefix))
-        .and_then(|mut file| {
-            file.write_all(
-                PreCommitConfig { python: true }
-                    .render()
-                    .expect("Render fail: .pre-commit-config.yaml")
-                    .as_bytes(),
-            )
-        })
-        .expect("Write fail: .pre-commit-config.yaml");
-
-    // Render Flake8 conf
-    File::create(format!("{}/.cpa/flake8.cfg", prefix))
-        .and_then(|mut file| file.write_all(Flake8 {}.render().expect("Render fail: flake8.cfg").as_bytes()))
-        .expect("Write fail: flake8.cfg");
-
-    // Render Prettier conf
-    File::create(format!("{}/.cpa/prettier.json", prefix))
-        .and_then(|mut file| file.write_all(Prettier {}.render().expect("Render fail: prettier.json").as_bytes()))
-        .expect("Write fail: prettier.json");
+    // Render files
+    GHWorkflowCI {}.write(&prefix, ".github/workflows/ci.yaml");
+    VSCodeSettings {}.write(&prefix, ".vscode/settings.json");
+    VSCodeExtensions {}.write(&prefix, ".vscode/extensions.json");
+    GitIgnore {}.write(&prefix, ".gitignore");
+    Makefile {}.write(&prefix, "Makefile");
+    Dockerfile {}.write(&prefix, "Dockerfile");
+    MainPy {}.write(&prefix, "main.py");
+    PreCommitConfig { python: true }.write(&prefix, ".pre-commit-config.yaml");
+    Flake8 {}.write(&prefix, ".cpa/flake8.cfg");
+    Prettier {}.write(&prefix, ".cpa/prettier.json");
 
     // Render Poetry conf
     let re = Regex::new(r"python(3\.\d+|4\.\d+)").unwrap();
-    let (python_ver, black_target_ver) = if let Some(caps) = re.captures(&preset) {
+    let (python_ver, black_target_ver) = if let Some(caps) = re.captures(preset) {
         let ver = caps[1].to_string();
         (ver.clone(), format!("py{}", ver.replace('.', "")))
     } else {
-        eprintln!("Python version not recognized in --preset, invalid input");
+        eprintln!("Python version not recognized in --preset, invalid input. Expected format: 'python3.xx'");
         process::exit(1);
     };
 
@@ -150,8 +116,6 @@ pub fn setup_preset(mut preset: String, name: String, create: bool) {
         python_ver,
         black_target_ver,
     };
-    let out_pyproj: String = pyproj.render().expect("Failed to render");
-    let mut f_pyproj = File::create(format!("{}/pyproject.toml", prefix)).expect("Could not create file");
-    f_pyproj.write_all(out_pyproj.as_bytes()).expect("Could not write to file");
+    pyproj.write(&prefix, "pyproject.toml");
     println!("Project created at: {}", prefix)
 }

src/python.rs

@@ -1,4 +1,4 @@
-{% raw %}
+{% raw -%}
 name: CI
 
 on:
@@ -85,4 +85,4 @@ jobs:
           else
             pre-commit run --from-ref origin/$DEFAULT_BRANCH --to-ref $CUR_SHA
           fi
-{% endraw %}
+{%- endraw %}

templates/.github/workflows/ci.yaml

@@ -40,8 +40,7 @@ repos:
       - id: shellcheck # Lints shell scripts to identify syntax and usage errors, with a specified severity of 'warning'.
         args:
           - --severity=warning
-
-{% if python %}
+{% if python +%}
   #############################################################################
   # Python
   #############################################################################
@@ -92,8 +91,7 @@ repos:
   #   hooks:
   #     - id: poetry-check # Makes sure the poetry configuration does not get committed in a broken state.
   #     - id: poetry-lock # Ensures the poetry.lock file is up-to-date with the pyproject.toml changes.
-
-{% endif %}
+{%+ endif %}
   #############################################################################
   # CSS, Markdown, JavaScript, TypeScript, YAML style formatter
   #############################################################################