chore: refine nox commands (#47)

Signed-off-by: l.feng <[email protected]>

docs/conf.py

@@ -23,7 +23,7 @@
 
 project = "Serious Scaffold Pybind11"
 copyright = "2024 Serious Scaffold"
-author = "msclock"
+author = "l.feng"
 
 # -- General configuration ---------------------------------------------------
 

includes/copier-answers-sample.yml

@@ -1,8 +1,9 @@
 # Default values for verifying the current project structure
 author_email: [email protected]
-author_name: msclock
+author_name: l.feng
 codecov_notify_builds: 1
 codecov_threshold: 5%
+compiled: true
 copyright_holder: Serious Scaffold
 copyright_license: MIT License
 copyright_year: 2024

noxfile.py

@@ -45,9 +45,8 @@ def tests(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def docs(session: nox.Session) -> None:
     """
-    Build the docs. Pass "--serve" to serve. Pass "-b linkcheck" to check links.
+    Build the docs. Pass "-- --help" to show helps.
     """
-
     parser = argparse.ArgumentParser()
     parser.add_argument("--serve", action="store_true", help="Serve after building")
     parser.add_argument(
@@ -96,10 +95,22 @@ def build(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def template(session: nox.Session) -> None:
     """
-    Build template for the current repo only.
+    Build template from current repo. Pass "-- --help" to show helps.
     """
     import os
 
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-r", "--vcs-ref", default="HEAD", help="Git reference to generate."
+    )
+    parser.add_argument(
+        "--data-file",
+        default="includes/copier-answers-sample.yml",
+        help="Load data from a YAML file.",
+    )
+    parser.add_argument("--dest", default=".", help="Destination to generate.")
+    args, posargs = parser.parse_known_args(session.posargs)
+
     excludes = [".", ".git", "template", "includes", ".nox", "copier.yml"]
     for dir_item in os.listdir("."):
         if dir_item in excludes:
@@ -115,12 +126,12 @@ def template(session: nox.Session) -> None:
         "copier",
         "copy",
         "-r",
-        "HEAD",
+        args.vcs_ref,
         "--data-file",
-        "includes/copier-answers-sample.yml",
-        *session.posargs,
-        "-f",
-        ".",
+        args.data_file,
         ".",
+        args.dest,
+        *posargs,
     )
+
     Path(".copier-answers.yml").unlink()

pyproject.toml

@@ -7,7 +7,7 @@ name = "ss_pybind11"
 description = "A template of serious scaffold family based on pybind11."
 readme = "README.md"
 license = { text = "MIT" }
-authors = [{ email = "[email protected]", name = "msclock" }]
+authors = [{ email = "[email protected]", name = "l.feng" }]
 requires-python = ">=3.8"
 classifiers = [
   "Intended Audience :: Science/Research",

template/noxfile.py.jinja

@@ -45,9 +45,8 @@ def tests(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def docs(session: nox.Session) -> None:
     """
-    Build the docs. Pass "--serve" to serve. Pass "-b linkcheck" to check links.
+    Build the docs. Pass "-- --help" to show helps.
     """
-
     parser = argparse.ArgumentParser()
     parser.add_argument("--serve", action="store_true", help="Serve after building")
     parser.add_argument(
@@ -117,10 +116,22 @@ def build(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def template(session: nox.Session) -> None:
     """
-    Build template for the current repo only.
+    Build template from current repo. Pass "-- --help" to show helps.
     """
     import os
 
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-r", "--vcs-ref", default="HEAD", help="Git reference to generate."
+    )
+    parser.add_argument(
+        "--data-file",
+        default="includes/copier-answers-sample.yml",
+        help="Load data from a YAML file.",
+    )
+    parser.add_argument("--dest", default=".", help="Destination to generate.")
+    args, posargs = parser.parse_known_args(session.posargs)
+
     excludes = [".", ".git", "template", "includes", ".nox", "copier.yml"]
     for dir_item in os.listdir("."):
         if dir_item in excludes:
@@ -136,13 +147,13 @@ def template(session: nox.Session) -> None:
         "copier",
         "copy",
         "-r",
-        "HEAD",
+        args.vcs_ref,
         "--data-file",
-        "includes/copier-answers-sample.yml",
-        *session.posargs,
-        "-f",
-        ".",
+        args.data_file,
         ".",
+        args.dest,
+        *posargs,
     )
+
     Path(".copier-answers.yml").unlink()
 [%- endif %]