xref: /expo/packages/@expo/config-plugins/build/utils/plugin-resolver.js.map (revision 61a61550)

{"version":3,"file":"plugin-resolver.js","names":["pluginFileName","findUpPackageJson","root","packageJson","findUp","sync","cwd","assert","resolvePluginForModule","projectRoot","modulePath","resolved","resolveFrom","silent","PluginError","moduleNameIsDirectFileReference","isPluginFile","filePath","findUpPlugin","pathIsFilePath","name","match","slashCount","split","path","sep","length","startsWith","resolveExpoPluginFile","pluginModuleFile","fileExists","moduleRoot","dirname","pluginFile","normalizeStaticPlugin","plugin","Array","isArray","undefined","assertInternalProjectRoot","resolveConfigPluginFunction","pluginReference","resolveConfigPluginFunctionWithInfo","result","requirePluginFile","error","SyntaxError","learnMoreLink","pluginError","message","stack","resolveConfigPluginExport","default","require"],"sources":["../../src/utils/plugin-resolver.ts"],"sourcesContent":["import assert from 'assert';\nimport findUp from 'find-up';\nimport * as path from 'path';\nimport resolveFrom from 'resolve-from';\n\nimport { ConfigPlugin, StaticPlugin } from '../Plugin.types';\nimport { PluginError } from './errors';\nimport { fileExists } from './modules';\n\n// Default plugin entry file name.\nexport const pluginFileName = 'app.plugin.js';\n\nfunction findUpPackageJson(root: string): string {\n  const packageJson = findUp.sync('package.json', { cwd: root });\n  assert(packageJson, `No package.json found for module \"${root}\"`);\n  return packageJson;\n}\n\nexport function resolvePluginForModule(projectRoot: string, modulePath: string) {\n  const resolved = resolveFrom.silent(projectRoot, modulePath);\n  if (!resolved) {\n    throw new PluginError(\n      `Failed to resolve plugin for module \"${modulePath}\" relative to \"${projectRoot}\"`,\n      'PLUGIN_NOT_FOUND'\n    );\n  }\n  // If the modulePath is something like `@bacon/package/index.js` or `expo-foo/build/app`\n  // then skip resolving the module `app.plugin.js`\n  if (moduleNameIsDirectFileReference(modulePath)) {\n    return { isPluginFile: false, filePath: resolved };\n  }\n  return findUpPlugin(resolved);\n}\n\n// TODO: Test windows\nfunction pathIsFilePath(name: string): boolean {\n  // Matches lines starting with: . / ~/\n  return !!name.match(/^(\\.|~\\/|\\/)/g);\n}\n\nexport function moduleNameIsDirectFileReference(name: string): boolean {\n  if (pathIsFilePath(name)) {\n    return true;\n  }\n\n  const slashCount = name.split(path.sep)?.length;\n  // Orgs (like @expo/config ) should have more than one slash to be a direct file.\n  if (name.startsWith('@')) {\n    return slashCount > 2;\n  }\n\n  // Regular packages should be considered direct reference if they have more than one slash.\n  return slashCount > 1;\n}\n\nfunction resolveExpoPluginFile(root: string): string | null {\n  // Find the expo plugin root file\n  const pluginModuleFile = resolveFrom.silent(\n    root,\n    // use ./ so it isn't resolved as a node module\n    `./${pluginFileName}`\n  );\n\n  // If the default expo plugin file exists use it.\n  if (pluginModuleFile && fileExists(pluginModuleFile)) {\n    return pluginModuleFile;\n  }\n  return null;\n}\n\nfunction findUpPlugin(root: string): { filePath: string; isPluginFile: boolean } {\n  // Get the closest package.json to the node module\n  const packageJson = findUpPackageJson(root);\n  // resolve the root folder for the node module\n  const moduleRoot = path.dirname(packageJson);\n  // use whatever the initial resolved file was ex: `node_modules/my-package/index.js` or `./something.js`\n  const pluginFile = resolveExpoPluginFile(moduleRoot);\n  return { filePath: pluginFile ?? root, isPluginFile: !!pluginFile };\n}\n\nexport function normalizeStaticPlugin(plugin: StaticPlugin | ConfigPlugin | string): StaticPlugin {\n  if (Array.isArray(plugin)) {\n    assert(\n      plugin.length > 0 && plugin.length < 3,\n      `Wrong number of arguments provided for static config plugin, expected either 1 or 2, got ${plugin.length}`\n    );\n    return plugin;\n  }\n  return [plugin, undefined];\n}\n\nexport function assertInternalProjectRoot(projectRoot?: string): asserts projectRoot {\n  assert(\n    projectRoot,\n    `Unexpected: Config \\`_internal.projectRoot\\` isn't defined by expo-cli, this is a bug.`\n  );\n}\n\n// Resolve the module function and assert type\nexport function resolveConfigPluginFunction(projectRoot: string, pluginReference: string) {\n  const { plugin } = resolveConfigPluginFunctionWithInfo(projectRoot, pluginReference);\n  return plugin;\n}\n\n// Resolve the module function and assert type\nexport function resolveConfigPluginFunctionWithInfo(projectRoot: string, pluginReference: string) {\n  const { filePath: pluginFile, isPluginFile } = resolvePluginForModule(\n    projectRoot,\n    pluginReference\n  );\n  let result: any;\n  try {\n    result = requirePluginFile(pluginFile);\n  } catch (error) {\n    if (error instanceof SyntaxError) {\n      const learnMoreLink = `Learn more: https://docs.expo.dev/guides/config-plugins/#creating-a-plugin`;\n      // If the plugin reference is a node module, and that node module has a syntax error, then it probably doesn't have an official config plugin.\n      if (!isPluginFile && !moduleNameIsDirectFileReference(pluginReference)) {\n        const pluginError = new PluginError(\n          `Package \"${pluginReference}\" does not contain a valid config plugin.\\n${learnMoreLink}\\n\\n${error.message}`,\n          'INVALID_PLUGIN_IMPORT'\n        );\n        pluginError.stack = error.stack;\n        throw pluginError;\n      }\n    }\n    throw error;\n  }\n\n  const plugin = resolveConfigPluginExport({\n    plugin: result,\n    pluginFile,\n    pluginReference,\n    isPluginFile,\n  });\n  return { plugin, pluginFile, pluginReference, isPluginFile };\n}\n\n/**\n * - Resolve the exported contents of an Expo config (be it default or module.exports)\n * - Assert no promise exports\n * - Return config type\n * - Serialize config\n *\n * @param props.plugin plugin results\n * @param props.pluginFile plugin file path\n * @param props.pluginReference the string used to reference the plugin\n * @param props.isPluginFile is file path from the app.plugin.js module root\n */\nexport function resolveConfigPluginExport({\n  plugin,\n  pluginFile,\n  pluginReference,\n  isPluginFile,\n}: {\n  plugin: any;\n  pluginFile: string;\n  pluginReference: string;\n  isPluginFile: boolean;\n}): ConfigPlugin<unknown> {\n  if (plugin.default != null) {\n    plugin = plugin.default;\n  }\n  if (typeof plugin !== 'function') {\n    const learnMoreLink = `Learn more: https://docs.expo.dev/guides/config-plugins/#creating-a-plugin`;\n    // If the plugin reference is a node module, and that node module does not export a function then it probably doesn't have a config plugin.\n    if (!isPluginFile && !moduleNameIsDirectFileReference(pluginReference)) {\n      throw new PluginError(\n        `Package \"${pluginReference}\" does not contain a valid config plugin. Module must export a function from file: ${pluginFile}\\n${learnMoreLink}`,\n        'INVALID_PLUGIN_TYPE'\n      );\n    }\n    throw new PluginError(\n      `Plugin \"${pluginReference}\" must export a function from file: ${pluginFile}. ${learnMoreLink}`,\n      'INVALID_PLUGIN_TYPE'\n    );\n  }\n\n  return plugin;\n}\n\nfunction requirePluginFile(filePath: string): any {\n  try {\n    return require(filePath);\n  } catch (error) {\n    // TODO: Improve error messages\n    throw error;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;;;;;;;AAEA;AACO,MAAMA,cAAc,GAAG,eAAvB;;;AAEP,SAASC,iBAAT,CAA2BC,IAA3B,EAAiD;EAC/C,MAAMC,WAAW,GAAGC,iBAAA,CAAOC,IAAP,CAAY,cAAZ,EAA4B;IAAEC,GAAG,EAAEJ;EAAP,CAA5B,CAApB;;EACA,IAAAK,iBAAA,EAAOJ,WAAP,EAAqB,qCAAoCD,IAAK,GAA9D;EACA,OAAOC,WAAP;AACD;;AAEM,SAASK,sBAAT,CAAgCC,WAAhC,EAAqDC,UAArD,EAAyE;EAC9E,MAAMC,QAAQ,GAAGC,sBAAA,CAAYC,MAAZ,CAAmBJ,WAAnB,EAAgCC,UAAhC,CAAjB;;EACA,IAAI,CAACC,QAAL,EAAe;IACb,MAAM,KAAIG,qBAAJ,EACH,wCAAuCJ,UAAW,kBAAiBD,WAAY,GAD5E,EAEJ,kBAFI,CAAN;EAID,CAP6E,CAQ9E;EACA;;;EACA,IAAIM,+BAA+B,CAACL,UAAD,CAAnC,EAAiD;IAC/C,OAAO;MAAEM,YAAY,EAAE,KAAhB;MAAuBC,QAAQ,EAAEN;IAAjC,CAAP;EACD;;EACD,OAAOO,YAAY,CAACP,QAAD,CAAnB;AACD,C,CAED;;;AACA,SAASQ,cAAT,CAAwBC,IAAxB,EAA+C;EAC7C;EACA,OAAO,CAAC,CAACA,IAAI,CAACC,KAAL,CAAW,eAAX,CAAT;AACD;;AAEM,SAASN,+BAAT,CAAyCK,IAAzC,EAAgE;EAAA;;EACrE,IAAID,cAAc,CAACC,IAAD,CAAlB,EAA0B;IACxB,OAAO,IAAP;EACD;;EAED,MAAME,UAAU,kBAAGF,IAAI,CAACG,KAAL,CAAWC,IAAI,GAACC,GAAhB,CAAH,gDAAG,YAAsBC,MAAzC,CALqE,CAMrE;;EACA,IAAIN,IAAI,CAACO,UAAL,CAAgB,GAAhB,CAAJ,EAA0B;IACxB,OAAOL,UAAU,GAAG,CAApB;EACD,CAToE,CAWrE;;;EACA,OAAOA,UAAU,GAAG,CAApB;AACD;;AAED,SAASM,qBAAT,CAA+B1B,IAA/B,EAA4D;EAC1D;EACA,MAAM2B,gBAAgB,GAAGjB,sBAAA,CAAYC,MAAZ,CACvBX,IADuB,EAEvB;EACC,KAAIF,cAAe,EAHG,CAAzB,CAF0D,CAQ1D;;;EACA,IAAI6B,gBAAgB,IAAI,IAAAC,qBAAA,EAAWD,gBAAX,CAAxB,EAAsD;IACpD,OAAOA,gBAAP;EACD;;EACD,OAAO,IAAP;AACD;;AAED,SAASX,YAAT,CAAsBhB,IAAtB,EAAiF;EAC/E;EACA,MAAMC,WAAW,GAAGF,iBAAiB,CAACC,IAAD,CAArC,CAF+E,CAG/E;;EACA,MAAM6B,UAAU,GAAGP,IAAI,GAACQ,OAAL,CAAa7B,WAAb,CAAnB,CAJ+E,CAK/E;;EACA,MAAM8B,UAAU,GAAGL,qBAAqB,CAACG,UAAD,CAAxC;EACA,OAAO;IAAEd,QAAQ,EAAEgB,UAAF,aAAEA,UAAF,cAAEA,UAAF,GAAgB/B,IAA1B;IAAgCc,YAAY,EAAE,CAAC,CAACiB;EAAhD,CAAP;AACD;;AAEM,SAASC,qBAAT,CAA+BC,MAA/B,EAA2F;EAChG,IAAIC,KAAK,CAACC,OAAN,CAAcF,MAAd,CAAJ,EAA2B;IACzB,IAAA5B,iBAAA,EACE4B,MAAM,CAACT,MAAP,GAAgB,CAAhB,IAAqBS,MAAM,CAACT,MAAP,GAAgB,CADvC,EAEG,4FAA2FS,MAAM,CAACT,MAAO,EAF5G;IAIA,OAAOS,MAAP;EACD;;EACD,OAAO,CAACA,MAAD,EAASG,SAAT,CAAP;AACD;;AAEM,SAASC,yBAAT,CAAmC9B,WAAnC,EAA8E;EACnF,IAAAF,iBAAA,EACEE,WADF,EAEG,wFAFH;AAID,C,CAED;;;AACO,SAAS+B,2BAAT,CAAqC/B,WAArC,EAA0DgC,eAA1D,EAAmF;EACxF,MAAM;IAAEN;EAAF,IAAaO,mCAAmC,CAACjC,WAAD,EAAcgC,eAAd,CAAtD;EACA,OAAON,MAAP;AACD,C,CAED;;;AACO,SAASO,mCAAT,CAA6CjC,WAA7C,EAAkEgC,eAAlE,EAA2F;EAChG,MAAM;IAAExB,QAAQ,EAAEgB,UAAZ;IAAwBjB;EAAxB,IAAyCR,sBAAsB,CACnEC,WADmE,EAEnEgC,eAFmE,CAArE;EAIA,IAAIE,MAAJ;;EACA,IAAI;IACFA,MAAM,GAAGC,iBAAiB,CAACX,UAAD,CAA1B;EACD,CAFD,CAEE,OAAOY,KAAP,EAAc;IACd,IAAIA,KAAK,YAAYC,WAArB,EAAkC;MAChC,MAAMC,aAAa,GAAI,4EAAvB,CADgC,CAEhC;;MACA,IAAI,CAAC/B,YAAD,IAAiB,CAACD,+BAA+B,CAAC0B,eAAD,CAArD,EAAwE;QACtE,MAAMO,WAAW,GAAG,KAAIlC,qBAAJ,EACjB,YAAW2B,eAAgB,8CAA6CM,aAAc,OAAMF,KAAK,CAACI,OAAQ,EADzF,EAElB,uBAFkB,CAApB;QAIAD,WAAW,CAACE,KAAZ,GAAoBL,KAAK,CAACK,KAA1B;QACA,MAAMF,WAAN;MACD;IACF;;IACD,MAAMH,KAAN;EACD;;EAED,MAAMV,MAAM,GAAGgB,yBAAyB,CAAC;IACvChB,MAAM,EAAEQ,MAD+B;IAEvCV,UAFuC;IAGvCQ,eAHuC;IAIvCzB;EAJuC,CAAD,CAAxC;EAMA,OAAO;IAAEmB,MAAF;IAAUF,UAAV;IAAsBQ,eAAtB;IAAuCzB;EAAvC,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASmC,yBAAT,CAAmC;EACxChB,MADwC;EAExCF,UAFwC;EAGxCQ,eAHwC;EAIxCzB;AAJwC,CAAnC,EAUmB;EACxB,IAAImB,MAAM,CAACiB,OAAP,IAAkB,IAAtB,EAA4B;IAC1BjB,MAAM,GAAGA,MAAM,CAACiB,OAAhB;EACD;;EACD,IAAI,OAAOjB,MAAP,KAAkB,UAAtB,EAAkC;IAChC,MAAMY,aAAa,GAAI,4EAAvB,CADgC,CAEhC;;IACA,IAAI,CAAC/B,YAAD,IAAiB,CAACD,+BAA+B,CAAC0B,eAAD,CAArD,EAAwE;MACtE,MAAM,KAAI3B,qBAAJ,EACH,YAAW2B,eAAgB,sFAAqFR,UAAW,KAAIc,aAAc,EAD1I,EAEJ,qBAFI,CAAN;IAID;;IACD,MAAM,KAAIjC,qBAAJ,EACH,WAAU2B,eAAgB,uCAAsCR,UAAW,KAAIc,aAAc,EAD1F,EAEJ,qBAFI,CAAN;EAID;;EAED,OAAOZ,MAAP;AACD;;AAED,SAASS,iBAAT,CAA2B3B,QAA3B,EAAkD;EAChD,IAAI;IACF,OAAOoC,OAAO,CAACpC,QAAD,CAAd;EACD,CAFD,CAEE,OAAO4B,KAAP,EAAc;IACd;IACA,MAAMA,KAAN;EACD;AACF"}