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

File Actions Menu dev docs #31668

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Aaron-Junker
Copy link
Collaborator

Summary of the Pull Request

PR Checklist

  • Closes: #xxx
  • Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • Tests: Added/updated and all pass
  • Localization: All end user facing strings can be localized
  • Dev docs: Added/updated
  • New binaries: Added on the required places
  • Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

| `FileActionsMenuPowerRenameAction` | When PowerRename is launched via File Actions Menu | |
| `FileActionsMenuImageResizerAction` | When Image Resizer is launched via File Actions Menu | |
| `FileActionsMenuFileLocksmithAction` | When File Locksmith is launched via File Actions Menu | |
| `FileActionsMenuCopyContentAsCEscapedStringActionInvokedEvent` | When the "Copy file content → As C escaped string" action is invoked | |

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

CEscaped is not a recognized word. (unrecognized-spelling)

## Sending telemetry events

Telemetry events that implement `FileActionsMenuProgressConflictEvent` are sent with the `TelemetryHelper.LogEvent` method. The `selectedItems` parameter is an array of the selected items. For more information, see the [Helpers docs](Helpers.md#void-logeventtt-e-string-selecteditems-where-t--eventbase-ifileactionsmenuiteminvokedevent).

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

eventbase is not a recognized word. (unrecognized-spelling)

## Sending telemetry events

Telemetry events that implement `FileActionsMenuProgressConflictEvent` are sent with the `TelemetryHelper.LogEvent` method. The `selectedItems` parameter is an array of the selected items. For more information, see the [Helpers docs](Helpers.md#void-logeventtt-e-string-selecteditems-where-t--eventbase-ifileactionsmenuiteminvokedevent).

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

ifileactionsmenuiteminvokedevent is not a recognized word. (unrecognized-spelling)

## Sending telemetry events

Telemetry events that implement `FileActionsMenuProgressConflictEvent` are sent with the `TelemetryHelper.LogEvent` method. The `selectedItems` parameter is an array of the selected items. For more information, see the [Helpers docs](Helpers.md#void-logeventtt-e-string-selecteditems-where-t--eventbase-ifileactionsmenuiteminvokedevent).

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

logeventtt is not a recognized word. (unrecognized-spelling)

## Sending telemetry events

Telemetry events that implement `FileActionsMenuProgressConflictEvent` are sent with the `TelemetryHelper.LogEvent` method. The `selectedItems` parameter is an array of the selected items. For more information, see the [Helpers docs](Helpers.md#void-logeventtt-e-string-selecteditems-where-t--eventbase-ifileactionsmenuiteminvokedevent).

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

selecteditems is not a recognized word. (unrecognized-spelling)

This comment has been minimized.

This comment has been minimized.

Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check-spelling found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (18)
apng
CEscaped
Checkabable
clipbaord
dictionairy
eventbase
ifileactionsmenuiteminvokedevent
jxl
logeventtt
mnt
oriiginal
pjp
pjpeg
selecteditems
seperated
seperator
uninstaller
whetever
Previously acknowledged words that are now absent COMMANDTITLE FILELOCKSMITHLIB OOBEPT 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:microsoft/PowerToys.git repository
on the dev/aaron-junker/FileActionsMenuDocs branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/8726639449/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (1873) from .github/actions/spell-check/expect.txt and unrecognized words (18)

Dictionary Entries Covers Uniquely
cspell:r/src/r.txt 543 1 1
cspell:cpp/src/people.txt 23 1
cspell:cpp/src/ecosystem.txt 51 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:r/src/r.txt
          cspell:cpp/src/people.txt
          cspell:cpp/src/ecosystem.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@Jay-o-Way
Copy link
Collaborator

Hey @Aaron-Junker l, how's this going?

@Aaron-Junker
Copy link
Collaborator Author

Hey @Aaron-Junker l, how's this going?

Waiting for the main PR to be merged, so I can add links to the files. Otherwise it should be finished

@Aaron-Junker Aaron-Junker mentioned this pull request Sep 22, 2024
14 tasks
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

Successfully merging this pull request may close these issues.

2 participants