feat: Add cargo-doc-live by leomayleomay · Pull Request #246 · juspay/services-flake

leomayleomay · 2024-06-22T12:28:56Z

leomayleomay · 2024-06-22T12:29:42Z

@srid I've got an error when I try to run just test cargo-doc-live

22:28 $ just test cargo-doc-live
nix build ./test#checks.$(nix eval --impure --expr "builtins.currentSystem").cargo-doc-live --override-input services-flake . -L
warning: not writing modified lock file of flake 'git+file:///home/hao/services-flake?dir=test':
• Updated input 'services-flake':
    'github:juspay/services-flake/b23fd8fc01985a994b38acc40bc512abefbbcc3f?narHash=sha256-J0hWG7EAhwujMvhbBfnIc3gMxzPWjj3s5yJNH%2BmV5cs%3D' (2024-06-09)
  → 'git+file:///home/hao/services-flake?ref=refs/heads/add-cargo-doc-live&rev=7e2eb0943215c8d422deb6a3ead4d56e372ee9dd' (2024-06-22)
trace: warning: getExe: Package "browser-sync-3.0.2" does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, use getExe' to specify the name to the program, such as lib.getExe' foo "bar".
cargo-doc-live-test> + process-compose --no-server -t=false
cargo-doc-live-test> [cargo-doc-live1-cargo-doc ] error: No such file or directory (os error 2)
cargo-doc-live-test> [cargo-doc-live1-cargo-doc ]
cargo-doc-live-test> [cargo-doc-live1-cargo-doc ] error: No such file or directory (os error 2)

srid · 2024-06-22T19:12:45Z

nix/cargo-doc-live_test.nix

+{ pkgs, ... }: {
+  services.cargo-doc-live."cargo-doc-live1" = {
+    enable = true;
+    crateName = "simple";


But there's no crate named simple in this PR? This is probably why the PR is failing.

srid · 2024-06-22T19:13:35Z

Also, the CI never terminates after those error: No such file or directory (os error 2) errors. Can this be fixed so that it terminates immediately?

srid

You also want to add the new example to nixci configuration of the top-level flake.nix so it builds in the CI.

srid · 2024-06-23T18:08:10Z

example/cargo-doc-live/flake.nix

Could you add a ./example/cargo-doc-live/README.md that explains how to run it?

srid · 2024-06-23T18:09:39Z

example/cargo-doc-live/flake.nix

+        # `process-compose.foo` will add a flake package output called "foo".
+        # Therefore, this will add a default package that you can build using
+        # `nix build` and run using `nix run`.
+        process-compose."default" = { ... }:


Suggested change

process-compose."default" = { ... }:

process-compose."cargo-doc-live" = { ... }:

(The default package is usually the Rust package itself)

srid · 2024-06-23T18:11:31Z

nix/cargo-doc-live.nix

+
+    src = lib.mkOption {
+      type = types.path;
+      description = "The src of the cargo";


We need a default value.

srid · 2024-06-23T18:11:58Z

nix/cargo-doc-live.nix

+
+    src = lib.mkOption {
+      type = types.path;
+      description = "The src of the cargo";


Suggested change

description = "The src of the cargo";

description = "Path to the cargo project root";

srid · 2024-06-23T18:13:16Z

nix/cargo-doc-live.nix

+      default = {
+        processes =
+          {


The { in line 34 is indented inconsistently with the rest of the project (e.g.: see { in line 32). You should fix this in similar other places as well.

srid · 2024-06-23T18:14:40Z

nix/cargo-doc-live.nix

+                  let
+                    browser-sync = lib.getExe pkgs.nodePackages.browser-sync;
+                    cargo-watch = lib.getExe pkgs.cargo-watch;
+                    cargo = lib.getExe pkgs.cargo;
+                  in


Since these are in runtimeInputs already, we don't need these and can just reference the executables as is in the script text, no?

srid · 2024-06-23T18:15:43Z

nix/cargo-doc-live.nix

+                runtimeInputs = with pkgs; [ nodePackages.browser-sync ];
+                text =
+                  ''
+                    ${lib.getExe pkgs.nodePackages.browser-sync} start --port ${toString config.port} --ss target/doc -s target/doc \


Suggested change

${lib.getExe pkgs.nodePackages.browser-sync} start --port ${toString config.port} --ss target/doc -s target/doc \

browser-sync start --port ${toString config.port} --ss target/doc -s target/doc \

srid · 2024-06-23T18:16:54Z

doc/cargo-doc-live.md

@@ -0,0 +1,40 @@
+# cargo-doc-live
+
+[cargo-doc-live] is live server version of `cargo doc`.


Could you use the 1st paragraph and video from https://github.com/srid/cargo-doc-live in here?

srid · 2024-06-23T18:18:45Z

doc/cargo-doc-live.md

+
+{#crateName}
+
+### The crate to use when opening docs in browser


I know our docs elsewhere are more of skeleton, but we should get into the practice of fleshing out when writing new docs. Can you add some paragraphs to all these sections?

feat: Add cargo-doc-live

7e2eb09

leomayleomay mentioned this pull request Jun 22, 2024

Add rustDoc options and CI srid/cargo-doc-live#3

Open

srid reviewed Jun 22, 2024

View reviewed changes

Add missing inputs

109a6db

leomayleomay marked this pull request as ready for review June 23, 2024 10:26

leomayleomay requested a review from srid June 23, 2024 10:28

fix: Move test to example

3695662

leomayleomay force-pushed the add-cargo-doc-live branch from 079ba71 to 3695662 Compare June 23, 2024 10:58

Merge branch 'main' into add-cargo-doc-live

7a465f8

srid requested changes Jun 23, 2024

View reviewed changes

leomayleomay added 3 commits June 24, 2024 09:48

docs: address PR feedback - round 1

7877ddc

fix: add preHook to enter the correct directory

6de6f59

docs: add more doc

3745923

leomayleomay requested a review from srid June 24, 2024 02:25

leomayleomay added 2 commits June 24, 2024 16:41

fix: wait until browser-sync is ready

3fa26c0

fix: change the way of checking readiness

8a003fa

	process-compose."default" = { ... }:
	process-compose."cargo-doc-live" = { ... }:

	description = "The src of the cargo";
	description = "Path to the cargo project root";

	${lib.getExe pkgs.nodePackages.browser-sync} start --port ${toString config.port} --ss target/doc -s target/doc \
	browser-sync start --port ${toString config.port} --ss target/doc -s target/doc \

		@@ -0,0 +1,40 @@
		# cargo-doc-live

		[cargo-doc-live] is live server version of `cargo doc`.


		{#crateName}

		### The crate to use when opening docs in browser

Conversation

leomayleomay commented Jun 22, 2024

Uh oh!

leomayleomay commented Jun 22, 2024

Uh oh!

srid Jun 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srid commented Jun 22, 2024

Uh oh!

srid left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

srid Jun 22, 2024 •

edited

Loading