Skip to content

Conversation

ats4e
Copy link

@ats4e ats4e commented Mar 15, 2025

Adding Movie Companion Plugin.

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/ats4e/obsidian-movie-companion

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.

Adding Movie Companion Plugin.
Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Your latest Release is missing the main.js file.
❌ Your latest Release is missing the manifest.json file.


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.

@ats4e
Copy link
Author

ats4e commented Mar 15, 2025

file uploaded

@ats4e ats4e closed this Mar 15, 2025
@ats4e ats4e reopened this Mar 15, 2025
@ats4e ats4e closed this Mar 15, 2025
@ats4e ats4e reopened this Mar 15, 2025
@github-actions github-actions bot changed the title Update community-plugins.json Add plugin: Movie Companion Mar 15, 2025
@ObsidianReviewBot
Copy link
Collaborator

Thank you for your submission, an automated scan of your plugin code's revealed the following issues:

Required

[1]:Please remove the main.js file from the repo and add it to your .gitignore. Compiled release files shouldn't get mixed with source code in your commits and should go to the releases files instead.

[1][2][3][4][5][6][7][8][9][10][11][12]:You should change all instances of var to either const or let. var has function-level scope, so it can easily lead to bugs if you're not careful. Here's a pretty good guide with examples of why not to use var: why var is obsolete


Optional

[1][2]:Use app.fileManager.trashFile(file: TAbstractFile) instead, this will make sure that the file is deleted according to the users preferences.

[1]:Casting to any should be avoided as much as possible.


Do NOT open a new PR for re-validation.
Once you have pushed all of the required changes to your repo, the bot will update the labels on this PR within 6 hours.
If you think some of the required changes are incorrect, please comment with /skip and the reason why you think the results are incorrect.

@ObsidianReviewBot ObsidianReviewBot added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made and removed Ready for review labels Mar 16, 2025
@ats4e ats4e closed this Mar 20, 2025
@ats4e ats4e reopened this Mar 20, 2025
@ObsidianReviewBot ObsidianReviewBot added Ready for review and removed Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made labels Mar 21, 2025
@ObsidianReviewBot ObsidianReviewBot removed their assignment Mar 21, 2025
@ObsidianReviewBot
Copy link
Collaborator

Changes requested by bot have been made, ready for additional review by human.

@Zachatoo
Copy link
Collaborator

Please include the esbuild.config.mjs file in your repo.

"authorUrl": null,
Please remove unused optional manifest properties.

"supportedLanguages": ["en", "it", "es", "fr", "de", "pt", "ru", "zh", "ja"]
Do not use properties that are not documented in your plugin's manifest.

"searchCollection": "Search Collection",, "searchMovie": "Search Movie",, "selectPoster": "Select Poster",, "showCreateCollectionRibbonButton": "Add Ribbon Button for Manual Collection Creation",, "generalSettings": "General Settings",, "openNoteAfterCreation": "Open new Movie or Tv Show note",, "tmdbApiRetrieveApiKey": "Login and get your API Key here",, "createMovieNote": "Create new Movie Note",, "createCollectionNote": "Create new Collection Note", new Setting(containerEl).setName("TV Shows").setHeading();, .setName("New TV Shows file location"), .setDesc("New TV Shows notes will be placed here."), .setName("TV Show template file")
Use sentence case in UI (please update for other locales as well)

"generalSettings": "General Settings",
Avoid "settings" in settings headings (please update for other locales as well)

this.plugin.settings.movie_folder = new_folder;, this.plugin.settings.movie_template_file = new_template_file;, this.plugin.settings.tv_shows_folder = new_folder;, this.plugin.settings.tv_shows_template_file = new_template_file;, this.plugin.settings.collection_folder = new_folder;, this.plugin.settings.collection_template_file = new_template_file;, export function replaceIllegalCharsFromPath(text: string) {
Use normalizePath to clean up user defined paths or paths from external sources.

const system_locale = navigator.language.split('-')[0] || "en";
Please use getLanguage to get the user's current language.

if(this.settings.show_manual_create_collection_button_ribbon) {, const manualCollectionDesc = document.createDocumentFragment();
As of v1.1.0 of Obsidian, the ribbon can be customized within Obsidian. So users can choose what items to include and in what order all in one place. Because of this, we're recommending that new plugins avoid introducing their own toggles for ribbon items.

console.log(, console.log(renderable);
Please avoid unnecessary logging. If you need it for debugging purposes, add a check to only log during development.

await this.app.vault.delete(file);, await this.app.vault.delete(file);
Prefer to use FileManager.trashFile() to remove a file or folder according to the user's preferred 'trash' options.


Optional feedback:

Is there a need to be able to change the locale, instead of always using the user's locale from getLanguage()?

Prefer to use AbstractInputSuggest when letting a user select a file/folder to add type-ahead support, the current way you're doing it is outdated.

@Zachatoo Zachatoo self-assigned this Mar 26, 2025
@Zachatoo Zachatoo added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made and removed Ready for review labels Mar 26, 2025
@Zachatoo Zachatoo added the Minor changes requested PR can be merged after some final changes have been requested label Mar 26, 2025
Copy link

github-actions bot commented Apr 3, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: ankit-kapur/obsidian-kanban-status-updater-plugin. If you are submitting from a GitHub org, you need to be a public member of the org.


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.

@ats4e
Copy link
Author

ats4e commented Apr 3, 2025

Ok, I've made all of the required changes.

What about setting the language in the config? This is needed because people might have Obsidian in one language (e.g. en) but want to collect their movies in another (e.g. it).

@ats4e ats4e closed this Apr 16, 2025
@ats4e ats4e reopened this Apr 16, 2025
@ats4e
Copy link
Author

ats4e commented Apr 16, 2025

Hi @Zachatoo, is there anything else I can do?

@Zachatoo
Copy link
Collaborator

@ats4e Can you double check that you made all the requested changes? The bot looks through each link I made to your code and checks to see if you've made a change to that code.

If you believe you have made all the requested changes then I can check it on my end.

@ats4e
Copy link
Author

ats4e commented Apr 18, 2025

@ats4e Can you double check that you made all the requested changes? The bot looks through each link I made to your code and checks to see if you've made a change to that code.

If you believe you have made all the requested changes then I can check it on my end.

Hi @Zachatoo, I have checked all the controls I could. The only one I’m unable to verify is Android, as I don’t own any Android device.

@Zachatoo
Copy link
Collaborator

The bot checks each comment I make and compares it against your code to see if it changed. These are the comments that I made that did not change, so the bot did not move this forward.

new Setting(containerEl).setName("TV Shows").setHeading();, .setName("New TV Shows file location"), .setDesc("New TV Shows notes will be placed here."), .setName("TV Show template file")
Use sentence case in UI

function replaceIllegalCharsFromPath(text: string) {
Use normalizePath to clean up user defined paths or paths from external sources.

const manualCollectionDesc = document.createDocumentFragment();
As of v1.1.0 of Obsidian, the ribbon can be customized within Obsidian. So users can choose what items to include and in what order all in one place. Because of this, we're recommending that new plugins avoid introducing their own toggles for ribbon items.

console.log(
Please avoid unnecessary logging. If you need it for debugging purposes, add a check to only log during development.


Here are some additional comments:

const manualCollectionDesc = document.createDocumentFragment();
This block no longer makes any sense, it's just a setting to reload Obsidian, but there is no longer a need to reload Obsidian when changing any of your settings.

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 May 24, 2025
Copy link

github-actions bot commented Jun 8, 2025

Hi there, to keep things tidy, we're closing PRs after one and a half months of inactivity.
Feel free to create a new pull request when you're ready to continue. Thanks for your understanding!

@github-actions github-actions bot closed this Jun 8, 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 Minor changes requested PR can be merged after some final changes have been requested plugin stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants