svg-eslint-parser 0.0.0 → 0.0.2

package/README.md

@@ -11,7 +11,7 @@
 > [!IMPORTANT]
 > Status: Work In Progress, not ready for production.
 >
-> Api may change every release, Use at your own risk.
+> API is not stale now, Use at your own risk.
 
 ## Install
 
@@ -27,6 +27,12 @@ yarn add svg-eslint-parser -D
 pnpm add svg-eslint-parser -D
 ```
 
+## Playground
+
+You can try the parser in [playground](https://svg-eslint-parser.ntnyq.com/play).
+
+Feel free to open an issue if you have any suggestions or find any bugs.
+
 ## Links
 
 - [Scalable Vector Graphics (SVG) 2](https://www.w3.org/TR/SVG2/)

package/dist/index.cjs

@@ -20,10 +20,25 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  COMMENT_END: () => COMMENT_END,
+  COMMENT_START: () => COMMENT_START,
+  ConstructTreeContextTypes: () => ConstructTreeContextTypes,
+  DEPRECATED_SVG_ELEMENTS: () => DEPRECATED_SVG_ELEMENTS,
+  NodeTypes: () => NodeTypes,
   ParseError: () => ParseError,
+  RE_CLOSE_TAG_NAME: () => RE_CLOSE_TAG_NAME,
+  RE_INCOMPLETE_CLOSING_TAG: () => RE_INCOMPLETE_CLOSING_TAG,
+  RE_OPEN_TAG_NAME: () => RE_OPEN_TAG_NAME,
+  RE_OPEN_TAG_START: () => RE_OPEN_TAG_START,
+  SELF_CLOSING_ELEMENTS: () => SELF_CLOSING_ELEMENTS,
+  SPECIAL_CHAR: () => SPECIAL_CHAR,
+  SVG_ELEMENTS: () => SVG_ELEMENTS,
+  TokenTypes: () => TokenTypes,
+  TokenizerContextTypes: () => TokenizerContextTypes,
   VisitorKeys: () => VisitorKeys,
   meta: () => meta,
   name: () => name2,
+  parse: () => parse17,
   parseForESLint: () => parseForESLint,
   parseSVG: () => parseSVG
 });
@@ -31,7 +46,7 @@ module.exports = __toCommonJS(index_exports);
 
 // package.json
 var name = "svg-eslint-parser";
-var version = "0.0.0";
+var version = "0.0.2";
 
 // src/meta.ts
 var meta = {
@@ -53,22 +68,178 @@ var ParseError = class extends SyntaxError {
   }
 };
 
-// src/constants/char.ts
-var SPECIAL_CHAR = {
-  newline: "\n",
-  return: "\r",
-  space: " ",
-  tab: "	"
-};
-
 // src/constants/parse.ts
 var COMMENT_START = "<!--";
 var COMMENT_END = "-->";
 var RE_OPEN_TAG_START = /^<\w/;
 var RE_OPEN_TAG_NAME = /^<(\S+)/;
 var RE_CLOSE_TAG_NAME = /^<\/((?:.|\n)*)>$/;
+var RE_INCOMPLETE_CLOSING_TAG = /<\/[^>]+$/;
+
+// src/constants/nodeTypes.ts
+var NodeTypes = /* @__PURE__ */ ((NodeTypes2) => {
+  NodeTypes2["Program"] = "Program";
+  NodeTypes2["Document"] = "Document";
+  NodeTypes2["Text"] = "Text";
+  NodeTypes2["XMLDeclaration"] = "XMLDeclaration";
+  NodeTypes2["Doctype"] = "Doctype";
+  NodeTypes2["DoctypeOpen"] = "DoctypeOpen";
+  NodeTypes2["DoctypeClose"] = "DoctypeClose";
+  NodeTypes2["DoctypeAttribute"] = "DoctypeAttribute";
+  NodeTypes2["DoctypeAttributeValue"] = "DoctypeAttributeValue";
+  NodeTypes2["DoctypeAttributeWrapperEnd"] = "DoctypeAttributeWrapperEnd";
+  NodeTypes2["DoctypeAttributeWrapperStart"] = "DoctypeAttributeWrapperStart";
+  NodeTypes2["Tag"] = "Tag";
+  NodeTypes2["OpenTagStart"] = "OpenTagStart";
+  NodeTypes2["OpenTagEnd"] = "OpenTagEnd";
+  NodeTypes2["CloseTag"] = "CloseTag";
+  NodeTypes2["Comment"] = "Comment";
+  NodeTypes2["CommentOpen"] = "CommentOpen";
+  NodeTypes2["CommentClose"] = "CommentClose";
+  NodeTypes2["CommentContent"] = "CommentContent";
+  NodeTypes2["Attribute"] = "Attribute";
+  NodeTypes2["AttributeKey"] = "AttributeKey";
+  NodeTypes2["AttributeValue"] = "AttributeValue";
+  NodeTypes2["AttributeValueWrapperStart"] = "AttributeValueWrapperStart";
+  NodeTypes2["AttributeValueWrapperEnd"] = "AttributeValueWrapperEnd";
+  return NodeTypes2;
+})(NodeTypes || {});
+
+// src/constants/tokenTypes.ts
+var TokenTypes = /* @__PURE__ */ ((TokenTypes2) => {
+  TokenTypes2["Program"] = "Program";
+  TokenTypes2["Document"] = "Document";
+  TokenTypes2["Text"] = "Text";
+  TokenTypes2["Doctype"] = "Doctype";
+  TokenTypes2["DoctypeOpen"] = "DoctypeOpen";
+  TokenTypes2["DoctypeClose"] = "DoctypeClose";
+  TokenTypes2["DoctypeAttributeValue"] = "DoctypeAttributeValue";
+  TokenTypes2["DoctypeAttributeWrapperStart"] = "DoctypeAttributeWrapperStart";
+  TokenTypes2["DoctypeAttributeWrapperEnd"] = "DoctypeAttributeWrapperEnd";
+  TokenTypes2["Tag"] = "Tag";
+  TokenTypes2["OpenTagStart"] = "OpenTagStart";
+  TokenTypes2["OpenTagEnd"] = "OpenTagEnd";
+  TokenTypes2["CloseTag"] = "CloseTag";
+  TokenTypes2["Comment"] = "Comment";
+  TokenTypes2["CommentOpen"] = "CommentOpen";
+  TokenTypes2["CommentClose"] = "CommentClose";
+  TokenTypes2["CommentContent"] = "CommentContent";
+  TokenTypes2["Attribute"] = "Attribute";
+  TokenTypes2["AttributeKey"] = "AttributeKey";
+  TokenTypes2["AttributeValue"] = "AttributeValue";
+  TokenTypes2["AttributeAssignment"] = "AttributeAssignment";
+  TokenTypes2["AttributeValueWrapperStart"] = "AttributeValueWrapperStart";
+  TokenTypes2["AttributeValueWrapperEnd"] = "AttributeValueWrapperEnd";
+  return TokenTypes2;
+})(TokenTypes || {});
+
+// src/constants/specialChar.ts
+var SPECIAL_CHAR = {
+  closingCorner: `>`,
+  colon: `:`,
+  comma: `,`,
+  doubleQuote: `"`,
+  equal: `=`,
+  exclamation: `!`,
+  hyphen: `-`,
+  newline: `
+`,
+  openingCorner: `<`,
+  question: `?`,
+  return: `\r`,
+  singleQuote: `'`,
+  slash: `/`,
+  space: ` `,
+  tab: `	`
+};
 
 // src/constants/svgElements.ts
+var SVG_ELEMENTS = /* @__PURE__ */ new Set([
+  "a",
+  "animate",
+  "animateMotion",
+  "animateTransform",
+  "circle",
+  "clipPath",
+  // not listed in mdn docs
+  "color-profile",
+  "defs",
+  "desc",
+  "ellipse",
+  "feBlend",
+  "feColorMatrix",
+  "feComponentTransfer",
+  "feComposite",
+  "feConvolveMatrix",
+  "feDiffuseLighting",
+  "feDisplacementMap",
+  "feDistantLight",
+  "feDropShadow",
+  "feFlood",
+  "feFuncA",
+  "feFuncB",
+  "feFuncG",
+  "feFuncR",
+  "feGaussianBlur",
+  "feImage",
+  "feMerge",
+  "feMergeNode",
+  "feMorphology",
+  "feOffset",
+  "fePointLight",
+  "feSpecularLighting",
+  "feSpotLight",
+  "feTile",
+  "feTurbulence",
+  "filter",
+  "foreignObject",
+  "g",
+  "image",
+  "line",
+  "linearGradient",
+  "marker",
+  "mask",
+  "metadata",
+  "mpath",
+  "path",
+  "pattern",
+  "polygon",
+  "polyline",
+  "radialGradient",
+  "rect",
+  "script",
+  "set",
+  "stop",
+  "style",
+  "svg",
+  "switch",
+  "symbol",
+  "text",
+  "textPath",
+  "title",
+  "tspan",
+  "use",
+  "view"
+]);
+var DEPRECATED_SVG_ELEMENTS = /* @__PURE__ */ new Set([
+  "altGlyph",
+  "altGlyphDef",
+  "altGlyphItem",
+  "animateColor",
+  "cursor",
+  "font",
+  "font-face",
+  "font-face-format",
+  "font-face-name",
+  "font-face-src",
+  "font-face-uri",
+  "glyph",
+  "glyphRef",
+  "hkern",
+  "missing-glyph",
+  "tref",
+  "vkern"
+]);
 var SELF_CLOSING_ELEMENTS = /* @__PURE__ */ new Set([
   "animate",
   "animateMotion",
@@ -104,6 +275,43 @@ var SELF_CLOSING_ELEMENTS = /* @__PURE__ */ new Set([
   "view"
 ]);
 
+// src/constants/tokenizerContextTypes.ts
+var TokenizerContextTypes = /* @__PURE__ */ ((TokenizerContextTypes2) => {
+  TokenizerContextTypes2["Data"] = "Data";
+  TokenizerContextTypes2["OpenTagStart"] = "OpenTagStart";
+  TokenizerContextTypes2["OpenTagEnd"] = "OpenTagEnd";
+  TokenizerContextTypes2["CloseTag"] = "CloseTag";
+  TokenizerContextTypes2["Attributes"] = "Attributes";
+  TokenizerContextTypes2["AttributeKey"] = "AttributeKey";
+  TokenizerContextTypes2["AttributeValue"] = "AttributeValue";
+  TokenizerContextTypes2["AttributeValueBare"] = "AttributeValueBare";
+  TokenizerContextTypes2["AttributeValueWrapped"] = "AttributeValueWrapped";
+  TokenizerContextTypes2["CommentContent"] = "CommentContent";
+  TokenizerContextTypes2["CommentOpen"] = "CommentOpen";
+  TokenizerContextTypes2["CommentClose"] = "CommentClose";
+  TokenizerContextTypes2["DoctypeOpen"] = "DoctypeOpen";
+  TokenizerContextTypes2["DoctypeClose"] = "DoctypeClose";
+  TokenizerContextTypes2["DoctypeAttributes"] = "DoctypeAttributes";
+  TokenizerContextTypes2["DoctypeAttributeBare"] = "DoctypeAttributeBare";
+  TokenizerContextTypes2["DoctypeAttributeWrapped"] = "DoctypeAttributeWrapped";
+  return TokenizerContextTypes2;
+})(TokenizerContextTypes || {});
+
+// src/constants/constructTreeContextTypes.ts
+var ConstructTreeContextTypes = /* @__PURE__ */ ((ConstructTreeContextTypes2) => {
+  ConstructTreeContextTypes2["Tag"] = "Tag";
+  ConstructTreeContextTypes2["TagName"] = "TagName";
+  ConstructTreeContextTypes2["TagContent"] = "TagContent";
+  ConstructTreeContextTypes2["Attribute"] = "Attribute";
+  ConstructTreeContextTypes2["Attributes"] = "Attributes";
+  ConstructTreeContextTypes2["AttributeValue"] = "AttributeValue";
+  ConstructTreeContextTypes2["Doctype"] = "Doctype";
+  ConstructTreeContextTypes2["DoctypeAttribute"] = "DoctypeAttribute";
+  ConstructTreeContextTypes2["DoctypeAttributes"] = "DoctypeAttributes";
+  ConstructTreeContextTypes2["Comment"] = "Comment";
+  return ConstructTreeContextTypes2;
+})(ConstructTreeContextTypes || {});
+
 // src/utils/firstLast.ts
 function first(items) {
   return items[0];
@@ -206,6 +414,12 @@ function createNodeFrom(token) {
   return result;
 }
 
+// src/utils/getLastAttribute.ts
+function getLastAttribute(state) {
+  const attributes = state.currentNode.attributes;
+  return last(attributes);
+}
+
 // src/utils/parseOpenTagName.ts
 function parseOpenTagName(openTagStartTokenContent) {
   const match = openTagStartTokenContent.match(RE_OPEN_TAG_NAME);
@@ -242,12 +456,12 @@ function calculateTokenLocation(source, range) {
 function calculateTokenCharactersRange(state, options) {
   const startPosition = state.sourceCode.index() - (state.accumulatedContent.length() - 1) - state.decisionBuffer.length();
   let endPosition;
-  if (options.keepBuffer) {
+  if (!options.keepBuffer) {
     endPosition = state.sourceCode.index() - state.decisionBuffer.length();
   } else {
     endPosition = state.sourceCode.index();
   }
-  return [startPosition, endPosition];
+  return [startPosition, endPosition + 1];
 }
 
 // src/utils/calculateTokenPosition.ts
@@ -441,10 +655,6 @@ function construct5(token, state) {
   state.caretPosition++;
   return state;
 }
-function getLastAttribute(state) {
-  const attributes = state.currentNode.attributes;
-  return last(attributes);
-}
 function handleOpenTagEnd2(state) {
   state.currentContext = state.currentContext.parentRef;
   return state;
@@ -626,23 +836,19 @@ function construct8(token, state) {
   state.caretPosition++;
   return state;
 }
-function getLastAttribute2(state) {
-  const attributes = state.currentNode.attributes;
-  return last(attributes);
-}
 function handleValueEnd(state) {
   state.currentContext = state.currentContext.parentRef;
   return state;
 }
 function handleAttributeValue(state, token) {
-  const attribute = getLastAttribute2(state);
+  const attribute = getLastAttribute(state);
   attribute.value = createNodeFrom(token);
   updateNodeEnd(attribute, token);
   state.caretPosition++;
   return state;
 }
 function handleAttributeValueWrapperStart(state, token) {
-  const attribute = getLastAttribute2(state);
+  const attribute = getLastAttribute(state);
   attribute.startWrapper = createNodeFrom(token);
   if (!attribute.key) {
     attribute.range = cloneRange(token.range);
@@ -652,7 +858,7 @@ function handleAttributeValueWrapperStart(state, token) {
   return state;
 }
 function handleAttributeValueWrapperEnd(state, token) {
-  const attribute = getLastAttribute2(state);
+  const attribute = getLastAttribute(state);
   attribute.endWrapper = createNodeFrom(token);
   updateNodeEnd(attribute, token);
   state.caretPosition++;
@@ -680,16 +886,12 @@ function construct9(token, state) {
   state.caretPosition++;
   return state;
 }
-function getLastAttribute3(state) {
-  const attributes = state.currentNode.attributes;
-  return last(attributes);
-}
 function handleDoctypeClose2(state) {
   state.currentContext = state.currentContext.parentRef;
   return state;
 }
 function handleDoctypeAttributeWrapperStart(state, token) {
-  const attribute = getLastAttribute3(state);
+  const attribute = getLastAttribute(state);
   if (attribute.value !== void 0) {
     state.currentContext = state.currentContext.parentRef;
     return state;
@@ -700,7 +902,7 @@ function handleDoctypeAttributeWrapperStart(state, token) {
   return state;
 }
 function handleDoctypeAttributeWrapperEnd(state, token) {
-  const attribute = getLastAttribute3(state);
+  const attribute = getLastAttribute(state);
   attribute.endWrapper = createNodeFrom(token);
   updateNodeEnd(attribute, token);
   state.currentContext = state.currentContext.parentRef;
@@ -708,7 +910,7 @@ function handleDoctypeAttributeWrapperEnd(state, token) {
   return state;
 }
 function handleDoctypeAttributeValue(state, token) {
-  const attribute = getLastAttribute3(state);
+  const attribute = getLastAttribute(state);
   if (attribute.value !== void 0) {
     state.currentContext = state.currentContext.parentRef;
     return state;
@@ -880,7 +1082,7 @@ function parse(chars, state) {
   if (value === "</") {
     return parseOpeningCornerBraceWithSlash(state);
   }
-  if (value === "<" || value === "<!" || value === "<!-") {
+  if (value === SPECIAL_CHAR.openingCorner || value === "<!" || value === "<!-") {
     return state.sourceCode.next();
   }
   if (value === COMMENT_START) {
@@ -977,7 +1179,7 @@ __export(closeTag_exports, {
 });
 function parse2(chars, state) {
   const value = chars.value();
-  if (value === ">") {
+  if (value === SPECIAL_CHAR.closingCorner) {
     return parseClosingCornerBrace(state);
   }
   state.accumulatedContent.concatBuffer(state.decisionBuffer);
@@ -1005,10 +1207,10 @@ __export(attributes_exports2, {
 });
 function parse3(chars, state) {
   const value = chars.value();
-  if (value === ">" || value === "/") {
+  if (value === SPECIAL_CHAR.closingCorner || value === SPECIAL_CHAR.slash) {
     return parseTagEnd(state);
   }
-  if (value === "=") {
+  if (value === SPECIAL_CHAR.equal) {
     return parseEqual(state);
   }
   if (!isWhitespace(value)) {
@@ -1051,7 +1253,7 @@ __export(openTagEnd_exports, {
   parse: () => parse4
 });
 function parse4(chars, state) {
-  if (chars.value() === ">") {
+  if (chars.value() === SPECIAL_CHAR.closingCorner) {
     return parseClosingCornerBrace2(state);
   }
   state.accumulatedContent.concatBuffer(state.decisionBuffer);
@@ -1083,7 +1285,7 @@ function parse5(chars, state) {
   if (isWhitespace(value)) {
     return parseWhitespace(state);
   }
-  if (value === ">") {
+  if (value === SPECIAL_CHAR.closingCorner) {
     return parseClosingCornerBrace3(state);
   }
   state.decisionBuffer.clear();
@@ -1146,7 +1348,7 @@ function parse7(chars, state) {
 }
 function isKeyBreak(chars) {
   const value = chars.value();
-  return value === "=" || value === "/" || value === ">" || isWhitespace(value);
+  return value === SPECIAL_CHAR.equal || value === SPECIAL_CHAR.slash || value === SPECIAL_CHAR.closingCorner || isWhitespace(value);
 }
 function parseKeyEnd(state) {
   const position = calculateTokenPosition(state, { keepBuffer: false });
@@ -1167,10 +1369,11 @@ __export(openTagStart_exports, {
   parse: () => parse8
 });
 function parse8(chars, state) {
-  if (chars.value() === ">" || chars.value() === "/") {
+  const value = chars.value();
+  if (value === SPECIAL_CHAR.closingCorner || value === SPECIAL_CHAR.slash) {
     return parseTagEnd2(state);
   }
-  if (isWhitespace(chars.value())) {
+  if (isWhitespace(value)) {
     return parseWhitespace2(state);
   }
   state.accumulatedContent.concatBuffer(state.decisionBuffer);
@@ -1214,10 +1417,10 @@ __export(attributeValue_exports2, {
 });
 function parse9(chars, state) {
   const value = chars.value();
-  if (value === '"' || value === `'`) {
+  if (value === SPECIAL_CHAR.doubleQuote || value === SPECIAL_CHAR.singleQuote) {
     return parseWrapper(state);
   }
-  if (value === ">" || value === "/") {
+  if (value === SPECIAL_CHAR.closingCorner || value === SPECIAL_CHAR.slash) {
     return parseTagEnd3(state);
   }
   if (!isWhitespace(value)) {
@@ -1262,7 +1465,7 @@ __export(commentContent_exports, {
 });
 function parse10(chars, state) {
   const value = chars.value();
-  if (value === "-" || value === "--") {
+  if (value === SPECIAL_CHAR.hyphen || value === "--") {
     return state.sourceCode.next();
   }
   if (value === COMMENT_END) {
@@ -1300,10 +1503,10 @@ __export(doctypeAttributes_exports2, {
 });
 function parse11(chars, state) {
   const value = chars.value();
-  if (value === '"' || value === `'`) {
+  if (value === SPECIAL_CHAR.doubleQuote || value === SPECIAL_CHAR.singleQuote) {
     return parseWrapper2(state);
   }
-  if (value === ">") {
+  if (value === SPECIAL_CHAR.closingCorner) {
     return parseClosingCornerBrace4(state);
   }
   if (!isWhitespace(value)) {
@@ -1348,7 +1551,7 @@ __export(attributeValueBare_exports, {
 });
 function parse12(chars, state) {
   const value = chars.value();
-  if (isWhitespace(value) || value === ">" || value === "/") {
+  if (isWhitespace(value) || value === SPECIAL_CHAR.closingCorner || value === SPECIAL_CHAR.slash) {
     return parseValueEnd(state);
   }
   state.accumulatedContent.concatBuffer(state.decisionBuffer);
@@ -1375,7 +1578,7 @@ __export(doctypeAttributeBare_exports, {
 });
 function parse13(chars, state) {
   const value = chars.value();
-  if (isWhitespace(value) || value === ">") {
+  if (isWhitespace(value) || value === SPECIAL_CHAR.closingCorner) {
     return parseAttributeEnd(state);
   }
   state.accumulatedContent.concatBuffer(state.decisionBuffer);
@@ -1603,11 +1806,11 @@ var import_eslint_visitor_keys = require("eslint-visitor-keys");
 var keys = {
   Program: ["body"],
   Document: ["children"],
+  XMLDeclaration: [],
   Doctype: ["open", "close", "attributes"],
   DoctypeOpen: [],
   DoctypeClose: [],
   DoctypeAttribute: ["key"],
-  DoctypeAttributeKey: [],
   DoctypeAttributeValue: [],
   DoctypeAttributeWrapperEnd: [],
   DoctypeAttributeWrapperStart: [],
@@ -1696,12 +1899,28 @@ function parseSVG(code, options = {}) {
 }
 var name2 = meta.name;
 var VisitorKeys = visitorKeys;
+var parse17 = parseSVG;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  COMMENT_END,
+  COMMENT_START,
+  ConstructTreeContextTypes,
+  DEPRECATED_SVG_ELEMENTS,
+  NodeTypes,
   ParseError,
+  RE_CLOSE_TAG_NAME,
+  RE_INCOMPLETE_CLOSING_TAG,
+  RE_OPEN_TAG_NAME,
+  RE_OPEN_TAG_START,
+  SELF_CLOSING_ELEMENTS,
+  SPECIAL_CHAR,
+  SVG_ELEMENTS,
+  TokenTypes,
+  TokenizerContextTypes,
   VisitorKeys,
   meta,
   name,
+  parse,
   parseForESLint,
   parseSVG
 });