search

ioccc-src / mkiocccentry

Form an IOCCC submission as a compressed tarball file
Other
30 stars 6 forks source link

Enhancement: Directory ignore list confusing #1210

Closed SirWumpus closed 1 month ago

SirWumpus commented 1 month ago

Is there an existing issue for this?

Describe the enhancement

When you reach the point where you are prompted with a list of directories to ignore you are asked if this list is ok or not (Y/N). I had assumed that by saying N that I would be able to amend the list of ignored directories, but instead the mkiocccentry simply terminates. 

The following is a list of directories that will be ignored:

.git

Is this OK? [Yn]: n

Post IOCCC28, consider revisiting the UI and/or explanatory text to explain what happens when No is answered and if there is a prompt to amend the ignore list further down.

Relevant images, screenshots or other files

No response

Relevant links

No response

Anything else?

No response

lcn2 commented 1 month ago

If this is addressed before IOCCC28 "closes" (and that is a big IF), then the Important NOTE from issue 1209 needs to be considered.

xexyl commented 1 month ago

The only thing that is done: it aborts. I can add to the messages that it will just abort if that's helpful. Let me see if I can take care of that simply ...

xexyl commented 1 month ago

As for amending the ignore list: how do you mean? What we ignore we ignore and there's no way to ignore wha we ignore. :-)

SirWumpus commented 1 month ago

The only thing that is done: it aborts. I can add to the messages that it will just abort if that's helpful. Let me see if I can take care of that simply ...

I got trip up by this at every prompt that gives a Y/n request that says "Is this list OK? " instead of a more accurate Should we continue? or similar phrasing to continue. What is the point of asking the question if the only choice is to abort.

As for amending the ignore list: how do you mean? What we ignore we ignore and there's no way to ignore wha we ignore. :-)

There are directories NOT named .something, eg reference/, or other development files like *.tws (TextPad workspace) which appear in .gitignore that I don't want to include. So it would be nice to be able to amend the list of things it should not include, rather than assume everything that isn't hidden is fair game.

This places a burden on the developer to shuffle / rename stuff temporarily just to avoid including it. Maybe having the developer create their own file-list-manifest file (similar to the tar(1) -I/-T option), that is then validated.

Anyway, that would have to be a post-IOCCC28 thing to do cause. So far I've not been able to submit an entry cause every prompt that I answer N to, simple aborts, without telling me that is what will happens. Again a better prompt like Do you wish to continue? would imply that a negative would abort.

Also pausing to show various lists (ignore directories, files from ignored directories (why, directory was ignored why walk it??), directories to be created). Can't you build the list of what is included and prompt once to ask "Is this good? Continue?" rather than every minor step?

Not happy with the user experience of mkiocccentry. Could be streamlined a lot.

xexyl commented 1 month ago

The only thing that is done: it aborts. I can add to the messages that it will just abort if that's helpful. Let me see if I can take care of that simply ...

I got trip up by this at every prompt that gives a Y/n request that says "Is this list OK? " instead of a more accurate Should we continue? or similar phrasing to continue. What is the point of asking the question if the only choice is to abort.

As for amending the ignore list: how do you mean? What we ignore we ignore and there's no way to ignore wha we ignore. :-)

There are directories NOT named .something, eg reference/, or other development files like *.tws (TextPad workspace) which appear in .gitignore that I don't want to include. So it would be nice to be able to amend the list of things it should not include, rather than assume everything that isn't hidden is fair game.

This places a burden on the developer to shuffle / rename stuff temporarily just to avoid including it. Maybe having the developer create their own file-list-manifest file (similar to the tar(1) -I/-T option), that is then validated.

Anyway, that would have to be a post-IOCCC28 thing to do cause. So far I've not been able to submit an entry cause every prompt that I answer N to, simple aborts, without telling me that is what will happens. Again a better prompt like Do you wish to continue? would imply that a negative would abort.

Also pausing to show various lists (ignore directories, files from ignored directories (why, directory was ignored why walk it??), directories to be created). Can't you build the list of what is included and prompt once to ask "Is this good? Continue?" rather than every minor step?

Not happy with the user experience of mkiocccentry. Could be streamlined a lots.

You CAN ignore paths!

And it will show you the paths you wish to ignore.

Try -I path. Can be used more than once.

xexyl commented 1 month ago

As for .. 'do you wish to continue?' is a good idea. I also added text about what will happen if one does not agree. I'll change the prompt text though. After that just have to check the formatting of messages.

xexyl commented 1 month ago

Done with that .. testing look.

xexyl commented 1 month ago

I believe this issue will be resolved with the commit too .. we'll see. Checking other issues now.

xexyl commented 1 month ago

Unless I am very much mistaken commit https://github.com/ioccc-src/mkiocccentry/pull/1211/commits/7c1bc2ea72d46d617e04e823736336616739650e along with the -I path option I added earlier should resolve this issue.

Please let me know @SirWumpus. Also don't forget to install the tools when you get this pulled to your system!

SirWumpus commented 1 month ago

@xexyl Did you change all such prompt that abort if you answer negative? Or just the one cited in the OP?

xexyl commented 1 month ago

@xexyl Did you change all such prompt that abort if you answer negative? Or just the one cited in the OP?

If you answer 'no' to 'Do you wish to continue?' it will abort, telling you to what to do; otherwise it'll continue. Prior to each question it'll say the implications of what saying 'no' is.

SirWumpus commented 1 month ago

@xexyl Did you change all such prompt that abort if you answer negative? Or just the one cited in the OP?

If you answer 'no' to 'Do you wish to continue?' it will abort, telling you to what to do; otherwise it'll continue. Prior to each question it'll say the implications of what saying 'no' is.

That was not the answer to my question. There are several such prompts that abort; were they all addressed?

xexyl commented 1 month ago

@xexyl Did you change all such prompt that abort if you answer negative? Or just the one cited in the OP?

If you answer 'no' to 'Do you wish to continue?' it will abort, telling you to what to do; otherwise it'll continue. Prior to each question it'll say the implications of what saying 'no' is.

That was not the answer to my question. There are several such prompts that abort; were they all addressed?

Yes that's what I meant.

lcn2 commented 1 month ago

BTW: Resolving this issue is pending the successful resolution and extended testing of the resolution of issue https://github.com/ioccc-src/mkiocccentry/issues/1215.

lcn2 commented 1 month ago

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

lcn2 commented 1 month ago

In light of the new issue #1216 we will now close with issue, @SirWumpus , with our thanks to you for raising this important issue.

xexyl commented 1 month ago

In light of the new issue #1216 we will now close with issue, @SirWumpus , with our thanks to you for raising this important issue.

Well I already have a good fix for this .. and it includes the important fix of workdir in topdir.

Also I am not sure how this is relevant to the issue you linked to. This issue is about ignored directories being confusing (the prompting); the issue you linked to is not: it's instead a way to provide a list of files to ignore. These directories must always be ignored.

They are not the same thing @lcn2.

lcn2 commented 1 month ago

Based on GH-issuecomment-2708404969, we have corrected our mistake and reopened this IOCCC29 issue.

xexyl commented 1 month ago

Based on GH-issuecomment-2708404969, we have corrected our mistake and reopened this IOCCC29 issue.

Thanks. Although like I said I have a fix lined up for this along with the other changes. None of those would mean someone would have to update the tools btw. If they wanted to they could but it would not affect them - especially since we now have the min version checks.

lcn2 commented 1 month ago

After further reflection (as well as explaining by folk), this issue as been set as a ((TOP PRIORITY)) and is to be included in the pending new releases of this repo.

See also GH-issuecomment-2708487545.

If any changes are needed to the IOCCC guidelines or IOCCC FAQ in "the other repo" as a result of resolving this issue, please issue a PR in "the other repo" to do that.

xexyl commented 1 month ago

After further reflection (as well as explaining by folk), this issue as been set as a ((TOP PRIORITY)) and is to be included in the pending new releases of this repo.

See also GH-issuecomment-2708487545.

If any changes are needed to the IOCCC guidelines or IOCCC FAQ in "the other repo" as a result of resolving this issue, please issue a PR in "the other repo" to do that.

Nothing should be needed I think. Maybe the FAQ on the entire mkiocccentry process but if so it's minor.

I'll look at committing tomorrow.

lcn2 commented 1 month ago

Based on commit 768ed6aacd9e806a92ff30e1c81f005fbd23a088 this issue has been resolved.

Thank you to all who helped with this issue.