Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement - Mark a file as reviewed #17

Open
Wilkins opened this issue Jul 27, 2017 · 1 comment
Open

Enhancement - Mark a file as reviewed #17

Wilkins opened this issue Jul 27, 2017 · 1 comment

Comments

@Wilkins
Copy link

Wilkins commented Jul 27, 2017

Hi,
Your tool is great.
But I have a big project to migrate, and I can't do it in one shot. So I progressively check files.

But when some alerts are not identified with the * (or they are identified but I don't care), I have no way to say "Ok this file has been reviewed", so phpmig does not need to care about it anymore.
So they popup everytime I run phpmig

I suggest phpmig watch for a "@phpmig-reviewed" tag in comments in the X first lines of the file. And if the tag exists, phpmig just ignore that file.

Or maybe create a ~/.phpmigignore file with absolute paths and phpmig watch for it and ignore files in that file.

Thank you.

@monque
Copy link
Owner

monque commented Jul 31, 2017

Thanks for your useful advice.

I'll try to explain this problem. This problem was considered during development but didn't have any solution that good enough.

According to this advice, your usage may like this,

  1. Run a phpmig full check, lots of spots outputted
  2. Fix some, ignore some, but not all spots or files

(repeat, until no spot output)

Whether adding some tag in comments or recording by the ignore file, all users are expecting the result that ALL FILES and SPOTS are PROCESSED.

If that is true, think this workflow

  1. Run a full check, save the original result to result.orig
  2. Process some files
    2.1 Fix spot
    2.2 Mark spots which are ignored in result.orig
  3. Run a full check, save result to result.now
  4. Diff these two result files

(repeat 2 - 4, until the result of diff are all marked ignored)

Is this workflow useful for your usage?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants