update Hooks readme #29
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main changes are:
1. Updated the file naming convention from `users.js` to `users_processDocument.js`.
2. Specified that the hook file should be in the same directory as the `firestore2json.js` script.
3. Fixed a typo in the first example (changed `recordCounter` to `recordCounters`).
These changes should help prevent confusion and ensure that users create their hook files with the correct name and in the right location. The script is looking for a hook file with a specific naming convention:
```
if (fs.existsSync(`./${args[0]}_processDocument.js`)) {
processDocument = require(`./${args[0]}_processDocument.js`);
}
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Docs update
What is the current behavior?
The current documentation incorrectly states the naming convention for hook files and doesn't specify their location. There's also a typo in one of the examples.
What is the new behavior?
This PR updates the documentation to:
users.jstousers_processDocument.js.firestore2json.jsscript.recordCountertorecordCounters).These changes align the documentation with the actual script behavior: