homebridge-appletv-enhanced

[maxileith]

Link To GitHub Repo

https://github.com/maxileith/homebridge-appletv-enhanced

Link To NPM Package

https://www.npmjs.com/package/homebridge-appletv-enhanced

Plugin Icon (Optional)

No response

[github-actions]

✅ Pre-checks completed successfully.

[maxileith]

Issues that relate to this request:

• Python package virtualenv as a dependency homebridge-apt-pkg#16
• Exclude a folder from Homebridge Backup as a plugin dev homebridge-config-ui-x#1955

[bwp91]

Hi @maxileith

your readme states the plugin only works on linux and (maybe) mac - ok.

i don't have a windows to test, but what happens if a windows user tries to install this plugin? at what point does it not work?

[maxileith]

npm won't allow a windows user to install the plugin. In the package.json is specified that the only allowed operating systems are MacOS and Linux.

https://docs.npmjs.com/cli/v10/configuring-npm/package-json#os

[maxileith]

And from the issues raised on GitHub I can tell that actually pretty many users are using MacOS. The issues that were raised by MacOS users in the past were mostly non Mac-specific. So I assume that it runs fine (the raised issues have of course been fixed). But I do not have a Mac to test ...

[bwp91]

In fact I had just been looking at that os option in the package json, but didn't know if it meant it refused to install on windows, or just printed a warning much like the engines option

[maxileith]

It refuses to install. E.g., when setting the os option to ["win32"] the following will happen when trying to install the package:

❯ npm install -g homebridge-appletv-enhanced-1.0.0.tgz
npm ERR! code EBADPLATFORM
npm ERR! notsup Unsupported platform for homebridge-appletv-enhanced@1.0.0: wanted {"os":"win32"} (current: {"os":"linux"})
npm ERR! notsup Valid os:  win32
npm ERR! notsup Actual os: linux

npm ERR! A complete log of this run can be found in: /home/maxileith/.npm/_logs/2023-12-29T18_38_13_224Z-debug-0.log

Of course, in the homebridge-appletv-enhanced package it is the other way around ("os": ["linux","darwin"]). The above was for demonstration purposes

[github-actions]

• General
  • The plugin must be of type dynamic platform.
  • The plugin must not offer the same nor less functionality than that of any existing verified plugin.
• Repo
  • The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.
  • A GitHub release should be created for every new version of your plugin, with release notes.
• Environment
  • The plugin must run on all supported LTS versions of Node.js, at the time of writing this is Node v18 and v20.
  • The plugin must successfully install and not start unless it is configured.
  • The plugin must not execute post-install scripts that modify the users' system in any way.
  • The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
• Codebase
  • The plugin must implement the Homebridge Plugin Settings GUI.
  • The plugin must not contain any analytics or calls that enable you to track the user.
  • If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
  • The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.

---

---

Comment /check to run checks again.

[bwp91]

The plugin must not execute post-install scripts that modify the users' system in any way.

Just checking on this one, your plugin only creates new files in the Homebridge storage directory right? it doesn't make any changes to file outside of this?

[maxileith]

it doesn't make any changes to file outside of this?

That is correct.

This is why I was raising homebridge/homebridge-apt-pkg#16 in the first place.