Fix all lints currently disabled in scripts/sync.sh

[ia0]

We want to enable the following lints:

• rust.elided-lifetimes-in-paths
• rust.missing-debug-implementations (not sure if good thing)
• rust.missing-docs for all published libraries
• rust.unreachable-pub
• rust.unused-results

[devesh-2002]

May I take this issue?

[ia0]

Of course, that would be great. That's a good first issue. You can start by changing those 2 lines:

wasefire/scripts/sync.sh

Lines 33 to 34 in 5da7a5e

	# add_lint $file warn rust.elided-lifetimes-in-paths
	# add_lint $file warn rust.missing-debug-implementations

into (I'm removing missing-debug-implementations because I'm not yet convinced it's a good thing to have):

  case $crate in
    prelude) add_lint $file warn rust.elided-lifetimes-in-paths ;;
  esac

Then run ./scripts/sync.sh (note that you might need to run ./scripts/setup.sh the very first time you clone the repository). This will add the lint to the prelude Cargo.toml. Then you can run ./test.sh from the crates/prelude directory and fix any warning.

Once there are no warnings, you can create your first PR.

Then, you can add more and more crates to the case pattern, like:

  case $crate in
    board|prelude) add_lint $file warn rust.elided-lifetimes-in-paths ;;
  esac

And create one PR for each non-trivial crate (you can group multiple crates together if there's nothing or almost nothing to change).

The final state (i.e. when adding the last remaning crate) should simply be:

  add_lint $file warn rust.elided-lifetimes-in-paths

Thanks! Feel free to ask questions if you're blocked.

[devesh-2002]

Thank you @ia0 for the detailed instructions! I'll keep these in mind

[devesh-2002]

@ia0 , Hello. I ran ./scripts/setup.sh and then ./scripts/sync.sh. But it gives me a duplicate key error. Would you please guide me in resolving this error?

 error: invalid table header
duplicate key `lints` in document root
  --> crates/xtask/Cargo.toml:26:1
   |
26 | [lints]
   | ^
   |

[ia0]

To debug:

• Could you push your working directory to a branch on your fork?
• What is your operating system?
• What is your version of sed? (sed --version)
• What is your version of sh? (sh --version)
• What is the path where wasefire is cloned?

I suspect that one of those 2 lines doesn't behave as expected in your case:

wasefire/scripts/sync.sh

Lines 30 to 31 in d32a3d9

	sed -i '/^\[lints\]$/q' $file
	[ "$(tail -n1 $file)" = '[lints]' ] || printf '\n[lints]\n' >> $file