Auto-detection of GM_ APIs breaks use of GM_config w/ Tampermonkey

[darkrain42]

Upgrading from rollup-plugin-userscript 0.3.7 to 1.0.0 breaks a userscript that uses GM_config when the user-script is injected in Tampermonkey due to the auto-detection of "GM_" APIs (#9). (It appears to work OK in Firefox Developer Edition + Violentmonkey).

The resulting userscript block looks similar to:

// ==UserScript==
// @name        Example
// @version     1
// @author      example
// @match       https://example.com
// @sandbox     JavaScript
// @run-at      document-start
// @require     https://raw.githubusercontent.com/sizzlemctwizzle/GM_config/06f2015c04db3aaab9717298394ca4f025802873/gm_config.js#sha256=c8f95a548ad83bcc8d82d5c17b1cc76f953ef831a00ff94514ed5b7b76f75d91
// @grant       GM.getValue
// @grant       GM.info
// @grant       GM.setValue
// @grant       GM_addStyle
// @grant       GM_config
// @grant       GM_getValue
// @grant       GM_info
// @grant       GM_setValue
// @grant       unsafeWindow
// ==/UserScript==

rollup-plugin-userscript automatically added the GM_config grant. When TM tries to inject the userscript into a page, it errors out:

• Chrome: Uncaught SyntaxError: Failed to execute 'appendChild' on 'Node': Identifier 'GM_config' has already been declared (at userscript.html?name=[...]:51:5)
• Firefox: Uncaught SyntaxError: redeclaration of formal parameter GM_config

I can work around this in the rollup config, but it's ugly:

      userscript((meta) =>
        meta
          .replace(/^\/\/ @grant +GM_config\n/m, '')
          .replace('process.env.VERSION', pkg.version)
          .replace('process.env.AUTHOR', pkg.author);
      ),

[GameRoMan]

@netux could you take a look at this, please

[netux]

@darkrain42 what would you prefer to have? Maybe a second argument to userscript() with options to configure ignore grants?

      userscript(
        (meta) =>
          meta
            .replace(/^\/\/ @grant +GM_config\n/m, '')
            .replace('process.env.VERSION', pkg.version)
            .replace('process.env.AUTHOR', pkg.author),
        {
          ignoreAutomaticGrants: ['GM_config']
        }
      ),

[GameRoMan]

it probably shouldn't grant GM_config at all by default, I'm not sure. Or it's a bug in Tampermonkey, does it work in other ones?

[netux]

it probably shouldn't grant GM_config at all by default, I'm not sure.

So you are saying pretty much revert #9? Problem is #9 comes from a similar issue where some userscript managers have their own custom GM_* APIs, so it is isn't easy to go with the alternative of maintaining a curated list of them for this plugin (like it was before #9).

Or it's a bug in Tampermonkey, does it work in other ones?

Tampermonkey likes to be special and complain if a userscript is asking for an API it doesn't know about 😅. Of all the userscript managers I know, Tampermonkey is the only one that does this. But I wouldn't call it a bug on TM either.

[darkrain42]

@darkrain42 what would you prefer to have? Maybe a second argument to userscript() with options to configure ignore grants?

I think I'd suggest both:

• a list of known things to ignore (GM_config)
• an option like what you propose