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

Add extra placeholder text on how to exclude files in the find-and-replace 3rd field #1036

Merged
merged 3 commits into from Aug 7, 2018

Conversation

Projects
None yet
2 participants
@luzpaz
Contributor

luzpaz commented Jul 27, 2018

Description of the Change

When the ctrl+shft+f is pressed the search and replace feature opens. The screenshot below shows the field that I'm proposing to edit (3rd field that allows users to specify what path they prefer to search)

image

Currently the placeholder for the 3rd field reads as follows:

File/directory pattern. eg. src to search in the "src" directory or *.js to search all JavaScript files

I'm proposing for the placeholder text to read as follows:

File/directory pattern. eg. src to search in the "src" directory; *.js to search all JavaScript files; !*.png to exclude all PNG files

Note: The screenshot's function is to show where I mean to replace the placeholder text. I tried to actually manipulate the UI in the js console but atom reported an error so apologies for not demoing what it would look like.

Ref: #149

Why Should This Be In find and replace?

I imagine that users wouldn't know that atom uses certain markup to dilienate (!*.js) what not to search. A user needs to dig around to find this out. I propose to educate the user on how to exclude files/directories in the placeholder text directly. I discovered this by searching the issue queue.

Benefits

Inform the user immediately through the placeholder how to achieve what they need

Possible Drawbacks

Someone might view this as 'bloaty' or 'crowded' even though for me it fits perfectly all on one line

Add extra placeholder text on how to exclude files
Educate the user on how atom excludes files/directories in the placeholder text directly. I discovered this by searching the issue queue.  
Ref: #149

@luzpaz luzpaz changed the title from Add extra placeholder text on how to exclude files in the to Add extra placeholder text on how to exclude files in the find-and-replace 3rd field Jul 27, 2018

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Jul 28, 2018

Contributor

Appveyor fails due to another issue unrelated to this PR

Contributor

luzpaz commented Jul 28, 2018

Appveyor fails due to another issue unrelated to this PR

@lee-dohm

This comment has been minimized.

Show comment
Hide comment
@lee-dohm

lee-dohm Jul 31, 2018

Member

Would you mind changing the eg. here to for example while you're at it?

Member

lee-dohm commented Jul 31, 2018

Would you mind changing the eg. here to for example while you're at it?

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Jul 31, 2018

Contributor

@lee-dohm what about the period after File/directory pattern. ? Are you asking for me to remove that as well?

File/directory pattern for example src to search in the "src" directory

Contributor

luzpaz commented Jul 31, 2018

@lee-dohm what about the period after File/directory pattern. ? Are you asking for me to remove that as well?

File/directory pattern for example src to search in the "src" directory

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Jul 31, 2018

Contributor

maybe using !*.png is not a great example? Perhaps using !*.js ? Also should I also mention a non-wildcard/glob negation example.. so using !src to exclude searching the "src" directory ?

File/directory pattern for example, src to search in the "src" directory; *.js to search all JavaScript files; !src to exclude searching in the "src" directory; !*.json to exclude all JSON files

Contributor

luzpaz commented Jul 31, 2018

maybe using !*.png is not a great example? Perhaps using !*.js ? Also should I also mention a non-wildcard/glob negation example.. so using !src to exclude searching the "src" directory ?

File/directory pattern for example, src to search in the "src" directory; *.js to search all JavaScript files; !src to exclude searching in the "src" directory; !*.json to exclude all JSON files

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Aug 4, 2018

Contributor

ping

Contributor

luzpaz commented Aug 4, 2018

ping

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Aug 6, 2018

Contributor

@lee-dohm thanks!
What do you think about this revision?

File/directory pattern: For example src to search in the "src" directory; *.js to search all JavaScript files; !src to exclude the "src" directory; !*.json to exclude all JSON files.

Contributor

luzpaz commented Aug 6, 2018

@lee-dohm thanks!
What do you think about this revision?

File/directory pattern: For example src to search in the "src" directory; *.js to search all JavaScript files; !src to exclude the "src" directory; !*.json to exclude all JSON files.

@lee-dohm

This comment has been minimized.

Show comment
Hide comment
@lee-dohm

lee-dohm Aug 6, 2018

Member

@luzpaz Surround the !*.json with backticks (`) and it looks good 👍

Member

lee-dohm commented Aug 6, 2018

@luzpaz Surround the !*.json with backticks (`) and it looks good 👍

@luzpaz

This comment has been minimized.

Show comment
Hide comment
@luzpaz

luzpaz Aug 7, 2018

Contributor

@lee-dohm please review f1d89f2

Contributor

luzpaz commented Aug 7, 2018

@lee-dohm please review f1d89f2

@lee-dohm lee-dohm merged commit a0822d5 into atom:master Aug 7, 2018

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@lee-dohm

This comment has been minimized.

Show comment
Hide comment
@lee-dohm

lee-dohm Aug 7, 2018

Member

Thanks for working through this with us @luzpaz 🙇

Member

lee-dohm commented Aug 7, 2018

Thanks for working through this with us @luzpaz 🙇

@luzpaz luzpaz deleted the luzpaz:exclude-files-help-text-in-placeholder-text branch Aug 7, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment