get-require-targets.js 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. /**
  2. * @author Toru Nagashima
  3. * See LICENSE file in root directory for full license.
  4. */
  5. "use strict"
  6. const path = require("path")
  7. const { getStringIfConstant } = require("eslint-utils")
  8. const resolve = require("resolve")
  9. const getResolvePaths = require("./get-resolve-paths")
  10. const getTryExtensions = require("./get-try-extensions")
  11. const ImportTarget = require("./import-target")
  12. const stripImportPathParams = require("./strip-import-path-params")
  13. /**
  14. * Checks whether or not a given node is a callee.
  15. *
  16. * @param {ASTNode} node - A node to check.
  17. * @returns {boolean} `true` if the node is a callee.
  18. */
  19. function isCallee(node) {
  20. return node.parent.type === "CallExpression" && node.parent.callee === node
  21. }
  22. /**
  23. * Gets references of "require".
  24. *
  25. * @param {escope.Scope} scope - The global scope.
  26. * @returns {escope.Reference[]} References of "require".
  27. */
  28. function getReferencesOfRequire(scope) {
  29. const variable = scope.set.get("require")
  30. if (!variable) {
  31. // Not found.
  32. return []
  33. }
  34. return variable.references
  35. }
  36. /**
  37. * Gets a list of `require()` targets.
  38. *
  39. * Core modules of Node.js (e.g. `fs`, `http`) are excluded.
  40. *
  41. * @param {RuleContext} context - The rule context.
  42. * @param {boolean} includeCore - The flag to include core modules.
  43. * @returns {ImportTarget[]} A list of found target's information.
  44. */
  45. module.exports = function getRequireTargets(context, includeCore) {
  46. const retv = []
  47. const basedir = path.dirname(path.resolve(context.getFilename()))
  48. const paths = getResolvePaths(context)
  49. const references = getReferencesOfRequire(context.getScope())
  50. const extensions = getTryExtensions(context)
  51. const options = { basedir, paths, extensions }
  52. for (const reference of references) {
  53. const node = reference.identifier
  54. // Skips if it's not a call of `require`.
  55. if (!isCallee(node)) {
  56. continue
  57. }
  58. // Gets the target module.
  59. const targetNode = node.parent.arguments[0]
  60. const rawName = getStringIfConstant(targetNode)
  61. const name = rawName && stripImportPathParams(rawName)
  62. if (name && (includeCore || !resolve.isCore(name))) {
  63. retv.push(new ImportTarget(targetNode, name, options))
  64. }
  65. }
  66. return retv
  67. }