Performed various cleanups (#27)

Author: spietras

.copier-answers.yaml

@@ -1,7 +1,7 @@
 ---
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 0.3.3
+_commit: 0.4.0
 _src_path: gh:quickplates/meta
 description: Generic project template 👤
-projectname: generic
+templatename: generic
 username: quickplates

.github/workflows/example.yaml

@@ -17,10 +17,10 @@ concurrency:
       - main
     # Run only on changes to relevant files
     paths:
+      - "src/**"
       - "copier.yaml"
       - "*.nix"
       - "flake.lock"
-      - "src/**"
       - "Taskfile.dist.yaml"
       - ".github/workflows/example.yaml"
 

.github/workflows/test.yaml

@@ -11,11 +11,11 @@ name: Test
       - main
     # Run only on changes to files relevant to tests
     paths:
+      - "src/**"
+      - "tests/**"
       - "copier.yaml"
       - "*.nix"
       - "flake.lock"
-      - "src/**"
-      - "tests/**"
       - "pytest.ini"
       - "Taskfile.dist.yaml"
       - ".github/workflows/test.yaml"
@@ -25,11 +25,11 @@ name: Test
       - main
     # Run only on changes to files relevant to tests
     paths:
+      - "src/**"
+      - "tests/**"
       - "copier.yaml"
       - "*.nix"
       - "flake.lock"
-      - "src/**"
-      - "tests/**"
       - "pytest.ini"
       - "Taskfile.dist.yaml"
       - ".github/workflows/test.yaml"

.trunk/configs/.eslintrc.cjs

@@ -11,7 +11,7 @@ runtimes:
   enabled:
     # Needed for gitleaks, shfmt, actionlint
     - go@1.19.5
-    # Needed for prettier, markdownlint, svgo, eslint
+    # Needed for prettier, markdownlint, svgo
     - node@18.12.1
     # Needed for yamllint, black, ruff
     - python@3.10.8
@@ -23,7 +23,6 @@ lint:
         - "**/*.jinja"
         # Ignore copier answers file
         - "**/.copier-answers.yaml"
-        - "**/.copier-answers.yml"
   definitions:
     # Nix formatting check (local)
     - name: nix-fmt-check
@@ -81,8 +80,6 @@ lint:
     - actionlint@1.6.24
     # SVG formatting
     - svgo@3.0.2
-    # JavaScript linting
-    - eslint@8.41.0
     # Python formatting
     - black@23.3.0
     - isort@5.12.0

.trunk/trunk.yaml

@@ -98,7 +98,8 @@ Here are the most common ones, using `Task`:
 - `task lint` - Run linting on all changed files
 
 Linting is automatically run on every pull request and push to the `main` branch.
-You can find the GitHub Actions workflow that does this in `.github/workflows/lint.yml`.
+You can find the GitHub Actions workflow that does this in
+[`.github/workflows/lint.yaml`](https://github.com/quickplates/generic/blob/main/.github/workflows/lint.yaml).
 
 If you use the Dev Container setup,
 you will have the `Trunk` extension installed in Visual Studio Code.
@@ -115,3 +116,7 @@ To run all tests, you can run:
 ```sh
 task test
 ```
+
+Testing is automatically run on every pull request and push to the `main` branch.
+You can find the GitHub Actions workflow that does this in
+[`.github/workflows/test.yaml`](https://github.com/quickplates/generic/blob/main/.github/workflows/test.yaml).

CONTRIBUTING.md

@@ -41,9 +41,9 @@ copier gh:quickplates/generic .
   with [`Docusaurus`](https://docusaurus.io)
 - continuous integration with [`GitHub Actions`](https://github.com/features/actions)
 
-## 💻 Contributing and Development
+## 💻 Development
 
-Read more about how to contribute and develop the project
+Read more about how to develop the project
 [here](https://github.com/quickplates/generic/blob/main/CONTRIBUTING.md).
 
 If you have any ideas on how to improve this template,

README.md

@@ -107,13 +107,13 @@ tasks:
         config
         --local
         user.name
-        'quickplates'
+        'test'
       - >
         git
         config
         --local
         user.email
-        'quickplates <quickplates@mail.spietras.dev>'
+        'test@example.org'
       - >
         git
         commit

Taskfile.dist.yaml

@@ -7,11 +7,16 @@ username:
 
 projectname:
   type: str
-  help: The name of your project
+  help: The name of the project
 
 description:
   type: str
-  help: A short description of your project
+  help: A short description of the project
+
+releases:
+  type: bool
+  help: Whether you plan to make releases
+  default: true
 
 docs:
   type: bool

copier.yaml

@@ -3,5 +3,4 @@
 {%- if docs %}
 docs/** -linguist-vendored linguist-documentation
 {%- endif %}
-tests/** -linguist-vendored linguist-documentation
 src/** -linguist-vendored