scriptSetupRanges.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.getStartEnd = exports.findBindingVars = exports.parseBindingRanges = exports.parseScriptSetupRanges = void 0;
  4. function parseScriptSetupRanges(ts, ast, vueCompilerOptions) {
  5. let foundNonImportExportNode = false;
  6. let importSectionEndOffset = 0;
  7. const props = {};
  8. const slots = {};
  9. const emits = {};
  10. const expose = {};
  11. const definePropProposalA = vueCompilerOptions.experimentalDefinePropProposal === 'kevinEdition' || ast.getFullText().trimStart().startsWith('// @experimentalDefinePropProposal=kevinEdition');
  12. const definePropProposalB = vueCompilerOptions.experimentalDefinePropProposal === 'johnsonEdition' || ast.getFullText().trimStart().startsWith('// @experimentalDefinePropProposal=johnsonEdition');
  13. const defineProp = [];
  14. const bindings = parseBindingRanges(ts, ast);
  15. const text = ast.getFullText();
  16. const leadingCommentEndOffset = ts.getLeadingCommentRanges(text, 0)?.reverse()[0].end ?? 0;
  17. ast.forEachChild(node => {
  18. const isTypeExport = (ts.isTypeAliasDeclaration(node) || ts.isInterfaceDeclaration(node)) && node.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword);
  19. if (!foundNonImportExportNode
  20. && !ts.isImportDeclaration(node)
  21. && !isTypeExport
  22. && !ts.isEmptyStatement(node)
  23. // fix https://github.com/vuejs/language-tools/issues/1223
  24. && !ts.isImportEqualsDeclaration(node)) {
  25. const commentRanges = ts.getLeadingCommentRanges(text, node.getFullStart());
  26. if (commentRanges?.length) {
  27. const commentRange = commentRanges.sort((a, b) => a.pos - b.pos)[0];
  28. importSectionEndOffset = commentRange.pos;
  29. }
  30. else {
  31. importSectionEndOffset = node.getStart(ast);
  32. }
  33. foundNonImportExportNode = true;
  34. }
  35. });
  36. ast.forEachChild(child => visitNode(child, [ast]));
  37. return {
  38. leadingCommentEndOffset,
  39. importSectionEndOffset,
  40. bindings,
  41. props,
  42. slots,
  43. emits,
  44. expose,
  45. defineProp,
  46. };
  47. function _getStartEnd(node) {
  48. return getStartEnd(node, ast);
  49. }
  50. function parseDefineFunction(node) {
  51. return {
  52. ..._getStartEnd(node),
  53. arg: node.arguments.length ? _getStartEnd(node.arguments[0]) : undefined,
  54. typeArg: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
  55. };
  56. }
  57. function visitNode(node, parents) {
  58. const parent = parents[parents.length - 1];
  59. if (ts.isCallExpression(node)
  60. && ts.isIdentifier(node.expression)) {
  61. const callText = node.expression.getText(ast);
  62. if (vueCompilerOptions.macros.defineModel.includes(callText)) {
  63. let name;
  64. let options;
  65. if (node.arguments.length >= 2) {
  66. name = _getStartEnd(node.arguments[0]);
  67. options = node.arguments[1];
  68. }
  69. else if (node.arguments.length >= 1) {
  70. if (ts.isStringLiteral(node.arguments[0])) {
  71. name = _getStartEnd(node.arguments[0]);
  72. }
  73. else {
  74. options = node.arguments[0];
  75. }
  76. }
  77. let required = false;
  78. if (options && ts.isObjectLiteralExpression(options)) {
  79. for (const property of options.properties) {
  80. if (ts.isPropertyAssignment(property) && ts.isIdentifier(property.name) && property.name.getText(ast) === 'required' && property.initializer.kind === ts.SyntaxKind.TrueKeyword) {
  81. required = true;
  82. break;
  83. }
  84. }
  85. }
  86. defineProp.push({
  87. name,
  88. nameIsString: true,
  89. type: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
  90. defaultValue: undefined,
  91. required,
  92. });
  93. }
  94. else if (callText === 'defineProp') {
  95. if (definePropProposalA) {
  96. let required = false;
  97. if (node.arguments.length >= 2) {
  98. const secondArg = node.arguments[1];
  99. if (ts.isObjectLiteralExpression(secondArg)) {
  100. for (const property of secondArg.properties) {
  101. if (ts.isPropertyAssignment(property) && ts.isIdentifier(property.name) && property.name.getText(ast) === 'required' && property.initializer.kind === ts.SyntaxKind.TrueKeyword) {
  102. required = true;
  103. break;
  104. }
  105. }
  106. }
  107. }
  108. if (node.arguments.length >= 1) {
  109. defineProp.push({
  110. name: _getStartEnd(node.arguments[0]),
  111. nameIsString: true,
  112. type: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
  113. defaultValue: undefined,
  114. required,
  115. });
  116. }
  117. else if (ts.isVariableDeclaration(parent)) {
  118. defineProp.push({
  119. name: _getStartEnd(parent.name),
  120. nameIsString: false,
  121. type: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
  122. defaultValue: undefined,
  123. required,
  124. });
  125. }
  126. }
  127. else if (definePropProposalB && ts.isVariableDeclaration(parent)) {
  128. defineProp.push({
  129. name: _getStartEnd(parent.name),
  130. nameIsString: false,
  131. defaultValue: node.arguments.length >= 1 ? _getStartEnd(node.arguments[0]) : undefined,
  132. type: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
  133. required: node.arguments.length >= 2 && node.arguments[1].kind === ts.SyntaxKind.TrueKeyword,
  134. });
  135. }
  136. }
  137. else if (vueCompilerOptions.macros.defineSlots.includes(callText)) {
  138. slots.define = parseDefineFunction(node);
  139. if (ts.isVariableDeclaration(parent)) {
  140. slots.name = parent.name.getText(ast);
  141. }
  142. }
  143. else if (vueCompilerOptions.macros.defineEmits.includes(callText)) {
  144. emits.define = parseDefineFunction(node);
  145. if (ts.isVariableDeclaration(parent)) {
  146. emits.name = parent.name.getText(ast);
  147. }
  148. }
  149. else if (vueCompilerOptions.macros.defineExpose.includes(callText)) {
  150. expose.define = parseDefineFunction(node);
  151. }
  152. else if (vueCompilerOptions.macros.defineProps.includes(callText)) {
  153. let statementRange;
  154. for (let i = parents.length - 1; i >= 0; i--) {
  155. if (ts.isStatement(parents[i])) {
  156. const statement = parents[i];
  157. statement.forEachChild(child => {
  158. const range = _getStartEnd(child);
  159. statementRange ??= range;
  160. statementRange.end = range.end;
  161. });
  162. break;
  163. }
  164. }
  165. if (!statementRange) {
  166. statementRange = _getStartEnd(node);
  167. }
  168. props.define = {
  169. ...parseDefineFunction(node),
  170. statement: statementRange,
  171. };
  172. if (ts.isVariableDeclaration(parent)) {
  173. props.name = parent.name.getText(ast);
  174. }
  175. if (node.arguments.length) {
  176. props.define.arg = _getStartEnd(node.arguments[0]);
  177. }
  178. if (node.typeArguments?.length) {
  179. props.define.typeArg = _getStartEnd(node.typeArguments[0]);
  180. }
  181. }
  182. else if (vueCompilerOptions.macros.withDefaults.includes(callText)) {
  183. props.withDefaults = _getStartEnd(node);
  184. if (node.arguments.length >= 2) {
  185. const arg = node.arguments[1];
  186. props.withDefaults.arg = _getStartEnd(arg);
  187. }
  188. if (ts.isVariableDeclaration(parent)) {
  189. props.name = parent.name.getText(ast);
  190. }
  191. }
  192. }
  193. node.forEachChild(child => {
  194. parents.push(node);
  195. visitNode(child, parents);
  196. parents.pop();
  197. });
  198. }
  199. }
  200. exports.parseScriptSetupRanges = parseScriptSetupRanges;
  201. function parseBindingRanges(ts, sourceFile) {
  202. const bindings = [];
  203. sourceFile.forEachChild(node => {
  204. if (ts.isVariableStatement(node)) {
  205. for (const node_2 of node.declarationList.declarations) {
  206. const vars = _findBindingVars(node_2.name);
  207. for (const _var of vars) {
  208. bindings.push(_var);
  209. }
  210. }
  211. }
  212. else if (ts.isFunctionDeclaration(node)) {
  213. if (node.name && ts.isIdentifier(node.name)) {
  214. bindings.push(_getStartEnd(node.name));
  215. }
  216. }
  217. else if (ts.isClassDeclaration(node)) {
  218. if (node.name) {
  219. bindings.push(_getStartEnd(node.name));
  220. }
  221. }
  222. else if (ts.isEnumDeclaration(node)) {
  223. bindings.push(_getStartEnd(node.name));
  224. }
  225. if (ts.isImportDeclaration(node)) {
  226. if (node.importClause && !node.importClause.isTypeOnly) {
  227. if (node.importClause.name) {
  228. bindings.push(_getStartEnd(node.importClause.name));
  229. }
  230. if (node.importClause.namedBindings) {
  231. if (ts.isNamedImports(node.importClause.namedBindings)) {
  232. for (const element of node.importClause.namedBindings.elements) {
  233. bindings.push(_getStartEnd(element.name));
  234. }
  235. }
  236. else if (ts.isNamespaceImport(node.importClause.namedBindings)) {
  237. bindings.push(_getStartEnd(node.importClause.namedBindings.name));
  238. }
  239. }
  240. }
  241. }
  242. });
  243. return bindings;
  244. function _getStartEnd(node) {
  245. return getStartEnd(node, sourceFile);
  246. }
  247. function _findBindingVars(left) {
  248. return findBindingVars(ts, left, sourceFile);
  249. }
  250. }
  251. exports.parseBindingRanges = parseBindingRanges;
  252. function findBindingVars(ts, left, sourceFile) {
  253. const vars = [];
  254. worker(left);
  255. return vars;
  256. function worker(_node) {
  257. if (ts.isIdentifier(_node)) {
  258. vars.push(getStartEnd(_node, sourceFile));
  259. }
  260. // { ? } = ...
  261. // [ ? ] = ...
  262. else if (ts.isObjectBindingPattern(_node) || ts.isArrayBindingPattern(_node)) {
  263. for (const property of _node.elements) {
  264. if (ts.isBindingElement(property)) {
  265. worker(property.name);
  266. }
  267. }
  268. }
  269. // { foo: ? } = ...
  270. else if (ts.isPropertyAssignment(_node)) {
  271. worker(_node.initializer);
  272. }
  273. // { foo } = ...
  274. else if (ts.isShorthandPropertyAssignment(_node)) {
  275. vars.push(getStartEnd(_node.name, sourceFile));
  276. }
  277. // { ...? } = ...
  278. // [ ...? ] = ...
  279. else if (ts.isSpreadAssignment(_node) || ts.isSpreadElement(_node)) {
  280. worker(_node.expression);
  281. }
  282. }
  283. }
  284. exports.findBindingVars = findBindingVars;
  285. function getStartEnd(node, sourceFile) {
  286. return {
  287. start: node.getStart(sourceFile),
  288. end: node.getEnd(),
  289. };
  290. }
  291. exports.getStartEnd = getStartEnd;
  292. //# sourceMappingURL=scriptSetupRanges.js.map