Book: Script to lint for copypasta'd file paths that should be generic

[steveklabnik]

One thing we do when showing errors is show file:///projects/bindings in Cargo's output. It'd be nice to somehow catch that this is always the text we use, as it's really easy to copy/paste something and forget to change it.

[carols10cents]

I think the requirements for this are:

• This should be a script that can be run on a directory of .md files
• If the script sees a line containing file://, it should check for the text following that to be /projects/
• If the text following file:// is anything BUT /projects/, print to stderr the filename, line number, and line content (but continue processing the rest of that file and other following files)
• If any lines containing file:// not followed by /projects/ have been found, the whole script should exit with a nonzero exit status so that we can hook this into travis and have travis fail if we forget this

Is that what you had in mind, @steveklabnik? I'm thinking about tweeting/getting this in TWiR for some help :)

[carols10cents]

Here's an example (source):

If there's a directory src that contains a file modules.md that contains this text:

$ cargo build
   Compiling modules v0.1.0 (file:///home/steve/tmp/modules)
src/foo.rs:1:1: 2:2 warning: function is never used: `it_works`,
#[warn(dead_code)] on by default
src/foo.rs:1 fn it_works() {

And I ran whatever-this-script-is src, I would expect to see:

Found lines that need fixed:

modules.md:2    Compiling modules v0.1.0 (file:///home/steve/tmp/modules)

and have the command exit with a nonzero status.

[steveklabnik]

@carols10cents yup, exactly!

[carols10cents]

Also, do we care if this is implemented in bash, rust, ruby, perl, etc etc? I don't really, it should be easy enough to read/modify in whatever.

[steveklabnik]

It would be nice if it was in Rust so that we don't introduce Yet Another Dependency.

[ereichert]

Should it only scan .md files regardless if other files are present?

Do you want the program in a new repo or part of this repo?

[bronzdoc]

I would like to help with this as a way to start learning rust :)

[carols10cents]

Should it only scan .md files regardless if other files are present?

Yep!

Do you want the program in a new repo or part of this repo?

In this repo please :)

Yinz are watching the TWiR repo like hawks! :)

[steveklabnik]

Hey @ereichert @bronzdoc !

Should it only scan .md files regardless if other files are present?

Yes, because they're the source text, other things are generated from them.

Do you want the program in a new repo or part of this repo?

In this one would be cool!

[ereichert]

If someone doesn't get it done before tonight I'll get on it.

[carols10cents]

I'm not going to "reserve" this for anyone-- please don't worry about duplicating work, especially if you're doing this for learning! ❤️ Or perhaps collaborate!

We also might have more little things like this in the future!

[ereichert]

@bronzdoc if you want to write it I'd be happy to mentor.

[steveklabnik]

We also might have more little things like this in the future!

Agreed. There's probably a lot of little things that would be cool to lint.

[bronzdoc]

That would be awesome @ereichert thank you.

[carols10cents]

Oops this didn't get closed!! This was fixed in #177 :)

[helpingothers4u2]

On helping others that's the year I started my page on Facebook helping others.

[czeronigeria]

@ereichert please i am new to github aspering frontend web developer would need mentorship still learning on udacity

[angelhen2020]

I would like to contribute 👾

[rogers0404]

Hi, I would like to contribute

[qcockroach]

Hello everyone. I'm newbie here. Can anyone give clue how to become a contributor of projects ?

[steveklabnik]

@angelhen2020 @rogers0404 @MrVirm hi, this issue is closed because the bug was already fixed. It also seems like you're looking for a general "how to get involved on github", but that's not what we do here, we're working on this specific project, which doesn't take a lot of external contribution.

I'm going to lock this issue, but it feels like folks are coming from somewhere. I don't know where this is linked from that suggests the wrong thing.