Skip to content

Add plugin: Daily File Logger #5614

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

ashlovepink
Copy link

@ashlovepink ashlovepink commented Mar 6, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/ashlovepink/daily-file-logger

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux
    • Android (if applicable)
    • iOS (if applicable)
  • My GitHub release contains all required files (as individual files, not just in the source.zip / source.tar.gz)
    • main.js
    • manifest.json
    • styles.css (optional)
  • GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
  • The id in my manifest.json matches the id in the community-plugins.json file.
  • My README.md describes the plugin's purpose and provides clear usage instructions.
  • I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
  • I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
  • I have added a license in the LICENSE file.
  • My project respects and is compatible with the original license of any code from other plugins that I'm using.
    I have given proper attribution to these other projects in my README.md.

@ObsidianReviewBot
Copy link
Collaborator

The automated review has not found any issues with your code, ready for manual review.

@LeCheenaX
Copy link
Contributor

Great contribution! Would you like to offer some valuable suggestions on my similar alternative?
可以给我的仓库提点建议吗:https://github.com/LeCheenaX/WordFlow-Tracker

@Zachatoo
Copy link
Collaborator

Zachatoo commented Mar 15, 2025

Your repo is missing the source code for your plugin. Please either put the source files into the repo, or invite me to the repo that has the files if the plugin is closed source.

@Zachatoo Zachatoo added Changes requested Installation not recommended Submission does not conform to developer policies, or includes potentially dangerous code. and removed Ready for review labels Mar 15, 2025
@ashlovepink
Copy link
Author

Your repo is missing the source code for your plugin. Please either put the source files into the repo, or invite me to the repo that has the files if the plugin is closed source.

Hi, I’ve uploaded the source code (main.js and manifest.json) to the repo. Please let me know if there’s anything else needed. Thank you!

@Zachatoo
Copy link
Collaborator

Looks like you've uploaded the main.js file that is generated from your main.ts file, which makes several parts of your plugin harder to review due to characters being replaced. Please upload the main.ts file and remove the main.js file from your repo so I can properly review. Thanks!

@ashlovepink
Copy link
Author

Looks like you've uploaded the main.js file that is generated from your main.ts file, which makes several parts of your plugin harder to review due to characters being replaced. Please upload the main.ts file and remove the main.js file from your repo so I can properly review. Thanks!

Thanks for the feedback! I've removed the main.js file and uploaded the main.ts file instead. Let me know if there's anything else I can improve!

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Expected ',' or '}' after property value in JSON at position 584610


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

@Zachatoo
Copy link
Collaborator

setTimeout(() => {
Use Workspace.onLayoutReady() to wait for the layout to be ready instead of using setTimeout().

new Setting(containerEl), new Setting(containerEl)
Prefer to use AbstractInputSuggest when letting a user select a file/folder to add type-ahead support.

this.plugin.settings.diaryFolder = value;, this.plugin.settings.diaryTemplatePath = value;
Use normalizePath to clean up user defined paths

await this.app.vault.modify(diaryFile, diaryContent);, await this.app.vault.modify(existingFile, diaryContent);
Prefer to use Vault.process() instead of Vault.modify() to modify a file in the background

let diaryFile = this.app.vault.getAbstractFileByPath(diaryPath);
When using Vault.getAbstractFileByPath, the result will be either a TFile, TFolder, or null. Your current code does not account for all of these scenarios. If you are only expecting a TFile, prefer to use Vault.getFileByPath. If you are only expecting a TFolder, prefer to use Vault.getFolderByPath. Note that you'll also need to update your minAppVersion to at least 1.5.7 to safely use either of these APIs.

return await this.app.vault.read(templateFile);
Prefer to use Vault.cachedRead() over Vault.read() when you only want to read a file and not modify it

@Zachatoo Zachatoo removed the Installation not recommended Submission does not conform to developer policies, or includes potentially dangerous code. label Mar 26, 2025
@Zachatoo Zachatoo added the Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made label Mar 26, 2025
Copy link

Hi there, as this PR has not seen any activity in the last 30 days, it will be closed in 15 days unless there are any updates.

@github-actions github-actions bot added the stale label Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made Changes requested plugin stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants