Merge pull request #2 from fastapi-mvc/update_generator

Update generator

Author: rszamszur

.envrc

@@ -1 +1 @@
-use nix
+use flake

.generator.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 3c38a44
+_commit: 0.2.0
 _src_path: https://github.com/fastapi-mvc/copier-generator
 copyright_date: 2022
 generator: controller

README.md

@@ -13,14 +13,18 @@ Prerequisites:
 * copier 6.2.0 or later
 
 ```shell
-copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/project
+copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/controller
 ```
 
 ## Using Nix
 
+Prerequisites:
+
+* Nix 2.8.x or later installed [How to install Nix](https://nixos.org/download.html)
+
 ```shell
-nix-shell shell.nix
-copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/project
+nix develop
+copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/controller
 ```
 
 ## Updating
@@ -29,13 +33,14 @@ To update your generator with the changes from the [upstream](https://github.com
 
 ```shell
 ./update.sh
+# Or
+nix run .#update
 ```
 
 This action will not update/override your template and its configuration, but rather generators common files:
 
-* Environment (`pyproject.toml` and `poetry.lock`)
-* `README.md`
 * Nix expression files
+* `README.md`
 * dotfiles
 * `LICENSE`
 
@@ -49,5 +54,7 @@ List of excluded files/paths:
 Lastly, you can pass extra copier CLI options should you choose:
 
 ```shell
-./update.sh -x README.md
+./update.sh -x README.md --vcs-ref=custom_branch
+# Or
+nix run .#update -- -x README.md --vcs-ref=custom_branch
 ```

default.nix

@@ -0,0 +1,68 @@
+{
+  description = "Fastapi-mvc generator flake";
+  nixConfig.bash-prompt = ''\n\[\033[1;32m\][nix-develop:\w]\$\[\033[0m\] '';
+
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    fastapi-mvc.url = "github:fastapi-mvc/fastapi-mvc?ref=0.25.0";
+    nixpkgs.follows = "fastapi-mvc/nixpkgs";
+  };
+
+  outputs = { self, nixpkgs, flake-utils, fastapi-mvc }:
+    {
+      overlays.default = nixpkgs.lib.composeManyExtensions [
+        fastapi-mvc.overlays.default
+      ];
+    } // (flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [ self.overlays.default ];
+        };
+      in
+      rec {
+        apps = {
+          fastapi-mvc = flake-utils.lib.mkApp { drv = pkgs.fastapi-mvc; };
+          copier = {
+            type = "app";
+            program = toString (pkgs.writeScript "copier" ''
+              export PATH="${pkgs.lib.makeBinPath [
+                pkgs.fastapi-mvc.dependencyEnv
+                pkgs.git
+                pkgs.coreutils
+              ]}"
+              copier $@
+            '');
+          };
+          update = {
+            type = "app";
+            program = toString (pkgs.writeScript "update" ''
+              export PATH="${pkgs.lib.makeBinPath [
+                pkgs.fastapi-mvc.dependencyEnv
+                pkgs.git
+                pkgs.coreutils
+              ]}"
+              copier -x template/** -x copier.yml -x *.py -x CHANGELOG.md \
+              $@ \
+              -d generator=controller \
+              -d nix=True \
+              -d license=MIT \
+              -d repo_url=https://github.com/fastapi-mvc/copier-controller \
+              -d copyright_date=2022 \
+              -a .generator.yml \
+              update ./.
+            '');
+          };
+        };
+
+        devShells = {
+          default = pkgs.fastapi-mvc-dev.env.overrideAttrs (oldAttrs: {
+            buildInputs = [
+              pkgs.git
+              pkgs.coreutils
+              pkgs.poetry
+            ];
+          });
+        };
+      }));
+}