@ripple-ts/eslint-parser 0.2.153

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dominic Gannaway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# @ripple-ts/eslint-parser
+
+ESLint parser for Ripple (.ripple files). This parser enables ESLint to understand and lint `.ripple` files by leveraging Ripple's built-in compiler.
+
+## Installation
+
+```bash
+pnpm add --save-dev '@ripple-ts/eslint-parser' ripple
+# or
+npm install --save-dev '@ripple-ts/eslint-parser' ripple
+# or
+yarn add --dev '@ripple-ts/eslint-parser' ripple
+```
+
+**Note:** This parser requires `ripple` as a peer dependency.
+
+## Usage
+
+### Flat Config (ESLint 9+)
+
+```js
+// eslint.config.js
+import rippleParser from '@ripple-ts/eslint-parser';
+import ripplePlugin from '@ripple-ts/eslint-plugin';
+
+export default [
+  {
+    files: ['**/*.ripple'],
+    languageOptions: {
+      parser: rippleParser,
+    },
+    plugins: {
+      ripple: ripplePlugin,
+    },
+    rules: {
+      ...ripplePlugin.configs.recommended.rules,
+    },
+  },
+];
+```
+
+### Legacy Config (.eslintrc)
+
+```json
+{
+  "overrides": [
+    {
+      "files": ["*.ripple"],
+      "parser": "@ripple-ts/eslint-parser",
+      "plugins": ["ripple"],
+      "extends": ["plugin:ripple/recommended"]
+    }
+  ]
+}
+```
+
+## How It Works
+
+This parser uses Ripple's compiler (`ripple/compiler`) to parse `.ripple` files into an ESTree-compatible AST that ESLint can analyze. The Ripple compiler already outputs ESTree-compliant ASTs, making integration straightforward.
+
+The parser:
+
+1. Loads the Ripple compiler
+2. Parses the `.ripple` source code
+3. Returns the ESTree AST to ESLint
+4. Allows ESLint rules to analyze Ripple-specific patterns
+
+## Supported Syntax
+
+The parser supports all Ripple syntax including:
+
+- `component` declarations
+- `track()` reactive values
+- `@` unboxing operator
+- `#[]` and `#{}` reactive collections
+- JSX-like templating inside components
+- All standard JavaScript/TypeScript syntax
+
+## Example
+
+Given a `.ripple` file:
+
+```ripple
+import { track } from 'ripple';
+
+export component Counter() {
+  let count = track(0);
+
+  <div>
+    <button onClick={() => @count++}>Increment</button>
+    <span>{@count}</span>
+  </div>
+}
+```
+
+The parser will successfully parse this and allow ESLint rules (like those from `@ripple-ts/eslint-plugin`) to check for:
+
+- Track calls at module scope
+- Missing @ operators
+- Component export requirements
+- And more
+
+## Limitations
+
+- The parser requires Node.js runtime as it uses `require()` to load the Ripple compiler
+- Browser-based linting is not currently supported
+
+## Related Packages
+
+- [@ripple-ts/eslint-plugin](https://www.npmjs.com/package/@ripple-ts/eslint-plugin) - ESLint rules for Ripple
+- [ripple](https://ripple-ts.com) - The Ripple framework
+- [@ripple-ts/vite-plugin](https://www.npmjs.com/package/@ripple-ts/vite-plugin) - Vite plugin for Ripple
+- [@ripple-ts/prettier-plugin](https://www.npmjs.com/package/@ripple-ts/prettier-plugin) - Prettier plugin for Ripple
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { Program } from "estree";
+import { Linter } from "eslint";
+
+//#region src/index.d.ts
+interface ParseResult {
+  ast: Program;
+  services?: Record<string, any>;
+  scopeManager?: any;
+  visitorKeys?: Record<string, string[]>;
+}
+/**
+ * ESLint parser for Ripple (.ripple) files
+ *
+ * This parser uses Ripple's built-in compiler to parse .ripple files
+ * and returns an ESTree-compatible AST for ESLint to analyze.
+ */
+declare function parseForESLint(code: string, options?: Linter.ParserOptions): ParseResult;
+/**
+ * Legacy parse function for older ESLint versions
+ */
+declare function parse(code: string, options?: Linter.ParserOptions): Program;
+declare global {
+  var __RIPPLE_COMPILER__: {
+    parse: (source: string) => Program;
+    compile: (source: string, filename: string, options?: any) => any;
+  };
+}
+declare const _default: {
+  parseForESLint: typeof parseForESLint;
+  parse: typeof parse;
+};
+//#endregion
+export { _default as default, parse, parseForESLint };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;UAIU,WAAA;OACJ;EADI,QAAA,CAAA,EAEE,MAFS,CAAA,MAAA,EAAA,GAAA,CAAA;EAAA,YAAA,CAAA,EAAA,GAAA;aACf,CAAA,EAGS,MAHT,CAAA,MAAA,EAAA,MAAA,EAAA,CAAA;;;;AA4EN;;;;AAAyF,iBAAzE,cAAA,CAAyE,IAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAlC,MAAA,CAAO,aAA2B,CAAA,EAAX,WAAW;AA2CzF;;;AAAqE,iBAArD,KAAA,CAAqD,IAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAvB,MAAA,CAAO,aAAgB,CAAA,EAAA,OAAA;QAAO,MAAA,CAAA;EAG3E,IAAA,mBAAA,EAAA;IAAA,KAAA,EAAA,CAAA,MAAA,EAAA,MAAA,EAAA,GAmC4B,OAnC5B;IAmC4B,OAAA,EAAA,CAAA,MAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GAAA,EAAA,GAAA,GAAA;EAAO,CAAA;;AAAA,cAAA,QAAA,EAAA"}

package/dist/index.js

@@ -0,0 +1,123 @@
+import { createRequire } from "module";
+
+//#region src/index.ts
+/**
+* Recursively walks the AST and ensures all nodes have range and loc properties
+* ESLint's scope analyzer requires these properties on ALL nodes
+*/
+function ensureNodeProperties(node, code) {
+	if (!node || typeof node !== "object") return;
+	if (node.start !== void 0 && node.end !== void 0 && !node.range) node.range = [node.start, node.end];
+	if (!node.loc && node.start !== void 0 && node.end !== void 0) {
+		const lines = code.split("\n");
+		let currentPos = 0;
+		let startLine = 1;
+		let startColumn = 0;
+		let endLine = 1;
+		let endColumn = 0;
+		for (let i = 0; i < lines.length; i++) {
+			const lineLength = lines[i].length + 1;
+			if (currentPos + lineLength > node.start) {
+				startLine = i + 1;
+				startColumn = node.start - currentPos;
+				break;
+			}
+			currentPos += lineLength;
+		}
+		currentPos = 0;
+		for (let i = 0; i < lines.length; i++) {
+			const lineLength = lines[i].length + 1;
+			if (currentPos + lineLength > node.end) {
+				endLine = i + 1;
+				endColumn = node.end - currentPos;
+				break;
+			}
+			currentPos += lineLength;
+		}
+		node.loc = {
+			start: {
+				line: startLine,
+				column: startColumn
+			},
+			end: {
+				line: endLine,
+				column: endColumn
+			}
+		};
+	}
+	for (const key in node) {
+		if (key === "parent" || key === "loc" || key === "range") continue;
+		const value = node[key];
+		if (Array.isArray(value)) value.forEach((child) => ensureNodeProperties(child, code));
+		else if (value && typeof value === "object" && value.type) ensureNodeProperties(value, code);
+	}
+}
+/**
+* ESLint parser for Ripple (.ripple) files
+*
+* This parser uses Ripple's built-in compiler to parse .ripple files
+* and returns an ESTree-compatible AST for ESLint to analyze.
+*/
+function parseForESLint(code, options) {
+	try {
+		const ast = requireRippleCompiler().parse(code);
+		if (!ast) throw new Error("Parser returned null or undefined AST");
+		ensureNodeProperties(ast, code);
+		return {
+			ast: {
+				type: ast.type || "Program",
+				start: ast.start !== void 0 ? ast.start : 0,
+				end: ast.end !== void 0 ? ast.end : code.length,
+				loc: ast.loc || {
+					start: {
+						line: 1,
+						column: 0
+					},
+					end: {
+						line: code.split("\n").length,
+						column: 0
+					}
+				},
+				range: ast.range || [0, code.length],
+				body: ast.body || [],
+				sourceType: ast.sourceType || "module",
+				comments: ast.comments || [],
+				tokens: ast.tokens || []
+			},
+			services: {},
+			visitorKeys: void 0
+		};
+	} catch (error) {
+		throw new SyntaxError(`Failed to parse Ripple file: ${error.message || error}`);
+	}
+}
+/**
+* Legacy parse function for older ESLint versions
+*/
+function parse(code, options) {
+	return parseForESLint(code, options).ast;
+}
+/**
+* Helper to require the Ripple compiler
+* This handles both CommonJS and ESM environments
+*/
+function requireRippleCompiler() {
+	const globalRipple = globalThis.__RIPPLE_COMPILER__;
+	if (globalRipple && globalRipple.parse) return globalRipple;
+	try {
+		const ripple = createRequire(import.meta.url)("ripple/compiler");
+		if (!ripple || !ripple.parse) throw new Error("Ripple compiler loaded but parse function not found.");
+		globalThis.__RIPPLE_COMPILER__ = ripple;
+		return ripple;
+	} catch (error) {
+		throw new Error(`Failed to load Ripple compiler: ${error.message}. Make sure the "ripple" package is installed as a peer dependency.`);
+	}
+}
+var src_default = {
+	parseForESLint,
+	parse
+};
+
+//#endregion
+export { src_default as default, parse, parseForESLint };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["error: any"],"sources":["../src/index.ts"],"sourcesContent":["import type { Program } from 'estree';\nimport type { AST, Linter } from 'eslint';\nimport { createRequire } from 'module';\n\ninterface ParseResult {\n\tast: Program;\n\tservices?: Record<string, any>;\n\tscopeManager?: any;\n\tvisitorKeys?: Record<string, string[]>;\n}\n\n/**\n * Recursively walks the AST and ensures all nodes have range and loc properties\n * ESLint's scope analyzer requires these properties on ALL nodes\n */\nfunction ensureNodeProperties(node: any, code: string): void {\n\tif (!node || typeof node !== 'object') {\n\t\treturn;\n\t}\n\n\t// Ensure range property exists\n\tif (node.start !== undefined && node.end !== undefined && !node.range) {\n\t\tnode.range = [node.start, node.end];\n\t}\n\n\t// Ensure loc property exists\n\tif (!node.loc && node.start !== undefined && node.end !== undefined) {\n\t\tconst lines = code.split('\\n');\n\t\tlet currentPos = 0;\n\t\tlet startLine = 1;\n\t\tlet startColumn = 0;\n\t\tlet endLine = 1;\n\t\tlet endColumn = 0;\n\n\t\tfor (let i = 0; i < lines.length; i++) {\n\t\t\tconst lineLength = lines[i].length + 1;\n\t\t\tif (currentPos + lineLength > node.start) {\n\t\t\t\tstartLine = i + 1;\n\t\t\t\tstartColumn = node.start - currentPos;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcurrentPos += lineLength;\n\t\t}\n\n\t\tcurrentPos = 0;\n\t\tfor (let i = 0; i < lines.length; i++) {\n\t\t\tconst lineLength = lines[i].length + 1;\n\t\t\tif (currentPos + lineLength > node.end) {\n\t\t\t\tendLine = i + 1;\n\t\t\t\tendColumn = node.end - currentPos;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcurrentPos += lineLength;\n\t\t}\n\n\t\tnode.loc = {\n\t\t\tstart: { line: startLine, column: startColumn },\n\t\t\tend: { line: endLine, column: endColumn },\n\t\t};\n\t}\n\n\tfor (const key in node) {\n\t\tif (key === 'parent' || key === 'loc' || key === 'range') {\n\t\t\tcontinue; // Skip these to avoid infinite loops\n\t\t}\n\n\t\tconst value = node[key];\n\t\tif (Array.isArray(value)) {\n\t\t\tvalue.forEach((child) => ensureNodeProperties(child, code));\n\t\t} else if (value && typeof value === 'object' && value.type) {\n\t\t\tensureNodeProperties(value, code);\n\t\t}\n\t}\n}\n\n/**\n * ESLint parser for Ripple (.ripple) files\n *\n * This parser uses Ripple's built-in compiler to parse .ripple files\n * and returns an ESTree-compatible AST for ESLint to analyze.\n */\nexport function parseForESLint(code: string, options?: Linter.ParserOptions): ParseResult {\n\ttry {\n\t\t// Dynamically import the Ripple compiler\n\t\t// We use dynamic import to avoid bundling the entire compiler\n\t\tconst rippleCompiler = requireRippleCompiler();\n\n\t\t// Parse the Ripple source code using the Ripple compiler\n\t\tconst ast = rippleCompiler.parse(code);\n\t\tif (!ast) throw new Error('Parser returned null or undefined AST');\n\n\t\t// Recursively ensure all nodes have range and loc properties\n\t\tensureNodeProperties(ast, code);\n\n\t\t// Create a properly structured AST object ensuring all required properties exist\n\t\tconst result: any = {\n\t\t\ttype: ast.type || 'Program',\n\t\t\tstart: ast.start !== undefined ? ast.start : 0,\n\t\t\tend: ast.end !== undefined ? ast.end : code.length,\n\t\t\tloc: ast.loc || {\n\t\t\t\tstart: { line: 1, column: 0 },\n\t\t\t\tend: { line: code.split('\\n').length, column: 0 },\n\t\t\t},\n\t\t\trange: ast.range || [0, code.length],\n\t\t\tbody: ast.body || [],\n\t\t\tsourceType: ast.sourceType || 'module',\n\t\t\tcomments: ast.comments || [],\n\t\t\ttokens: ast.tokens || [],\n\t\t};\n\n\t\treturn {\n\t\t\tast: result,\n\t\t\tservices: {},\n\t\t\tvisitorKeys: undefined, // Use ESLint's default visitor keys\n\t\t};\n\t} catch (error: any) {\n\t\t// Transform Ripple parse errors to ESLint-compatible format\n\t\tthrow new SyntaxError(`Failed to parse Ripple file: ${error.message || error}`);\n\t}\n}\n\n/**\n * Legacy parse function for older ESLint versions\n */\nexport function parse(code: string, options?: Linter.ParserOptions): Program {\n\tconst result = parseForESLint(code, options);\n\treturn result.ast;\n}\n\n/**\n * Helper to require the Ripple compiler\n * This handles both CommonJS and ESM environments\n */\nfunction requireRippleCompiler(): any {\n\tconst globalRipple = (globalThis as any).__RIPPLE_COMPILER__;\n\tif (globalRipple && globalRipple.parse) {\n\t\treturn globalRipple;\n\t}\n\n\ttry {\n\t\t// Use createRequire to dynamically require the module\n\t\t// This works in both ESM and CommonJS contexts\n\t\tconst require = createRequire(import.meta.url);\n\t\tconst ripple = require('ripple/compiler');\n\n\t\tif (!ripple || !ripple.parse) {\n\t\t\tthrow new Error('Ripple compiler loaded but parse function not found.');\n\t\t}\n\n\t\t(globalThis as any).__RIPPLE_COMPILER__ = ripple;\n\n\t\treturn ripple;\n\t} catch (error: any) {\n\t\tthrow new Error(\n\t\t\t`Failed to load Ripple compiler: ${error.message}. ` +\n\t\t\t\t'Make sure the \"ripple\" package is installed as a peer dependency.',\n\t\t);\n\t}\n}\n\ndeclare global {\n\tvar __RIPPLE_COMPILER__: {\n\t\tparse: (source: string) => Program;\n\t\tcompile: (source: string, filename: string, options?: any) => any;\n\t};\n}\n\nexport default {\n\tparseForESLint,\n\tparse,\n};\n"],"mappings":";;;;;;;AAeA,SAAS,qBAAqB,MAAW,MAAoB;AAC5D,KAAI,CAAC,QAAQ,OAAO,SAAS,SAC5B;AAID,KAAI,KAAK,UAAU,UAAa,KAAK,QAAQ,UAAa,CAAC,KAAK,MAC/D,MAAK,QAAQ,CAAC,KAAK,OAAO,KAAK,IAAI;AAIpC,KAAI,CAAC,KAAK,OAAO,KAAK,UAAU,UAAa,KAAK,QAAQ,QAAW;EACpE,MAAM,QAAQ,KAAK,MAAM,KAAK;EAC9B,IAAI,aAAa;EACjB,IAAI,YAAY;EAChB,IAAI,cAAc;EAClB,IAAI,UAAU;EACd,IAAI,YAAY;AAEhB,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACtC,MAAM,aAAa,MAAM,GAAG,SAAS;AACrC,OAAI,aAAa,aAAa,KAAK,OAAO;AACzC,gBAAY,IAAI;AAChB,kBAAc,KAAK,QAAQ;AAC3B;;AAED,iBAAc;;AAGf,eAAa;AACb,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACtC,MAAM,aAAa,MAAM,GAAG,SAAS;AACrC,OAAI,aAAa,aAAa,KAAK,KAAK;AACvC,cAAU,IAAI;AACd,gBAAY,KAAK,MAAM;AACvB;;AAED,iBAAc;;AAGf,OAAK,MAAM;GACV,OAAO;IAAE,MAAM;IAAW,QAAQ;IAAa;GAC/C,KAAK;IAAE,MAAM;IAAS,QAAQ;IAAW;GACzC;;AAGF,MAAK,MAAM,OAAO,MAAM;AACvB,MAAI,QAAQ,YAAY,QAAQ,SAAS,QAAQ,QAChD;EAGD,MAAM,QAAQ,KAAK;AACnB,MAAI,MAAM,QAAQ,MAAM,CACvB,OAAM,SAAS,UAAU,qBAAqB,OAAO,KAAK,CAAC;WACjD,SAAS,OAAO,UAAU,YAAY,MAAM,KACtD,sBAAqB,OAAO,KAAK;;;;;;;;;AAWpC,SAAgB,eAAe,MAAc,SAA6C;AACzF,KAAI;EAMH,MAAM,MAHiB,uBAAuB,CAGnB,MAAM,KAAK;AACtC,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,wCAAwC;AAGlE,uBAAqB,KAAK,KAAK;AAkB/B,SAAO;GACN,KAhBmB;IACnB,MAAM,IAAI,QAAQ;IAClB,OAAO,IAAI,UAAU,SAAY,IAAI,QAAQ;IAC7C,KAAK,IAAI,QAAQ,SAAY,IAAI,MAAM,KAAK;IAC5C,KAAK,IAAI,OAAO;KACf,OAAO;MAAE,MAAM;MAAG,QAAQ;MAAG;KAC7B,KAAK;MAAE,MAAM,KAAK,MAAM,KAAK,CAAC;MAAQ,QAAQ;MAAG;KACjD;IACD,OAAO,IAAI,SAAS,CAAC,GAAG,KAAK,OAAO;IACpC,MAAM,IAAI,QAAQ,EAAE;IACpB,YAAY,IAAI,cAAc;IAC9B,UAAU,IAAI,YAAY,EAAE;IAC5B,QAAQ,IAAI,UAAU,EAAE;IACxB;GAIA,UAAU,EAAE;GACZ,aAAa;GACb;UACOA,OAAY;AAEpB,QAAM,IAAI,YAAY,gCAAgC,MAAM,WAAW,QAAQ;;;;;;AAOjF,SAAgB,MAAM,MAAc,SAAyC;AAE5E,QADe,eAAe,MAAM,QAAQ,CAC9B;;;;;;AAOf,SAAS,wBAA6B;CACrC,MAAM,eAAgB,WAAmB;AACzC,KAAI,gBAAgB,aAAa,MAChC,QAAO;AAGR,KAAI;EAIH,MAAM,SADU,cAAc,OAAO,KAAK,IAAI,CACvB,kBAAkB;AAEzC,MAAI,CAAC,UAAU,CAAC,OAAO,MACtB,OAAM,IAAI,MAAM,uDAAuD;AAGxE,EAAC,WAAmB,sBAAsB;AAE1C,SAAO;UACCA,OAAY;AACpB,QAAM,IAAI,MACT,mCAAmC,MAAM,QAAQ,qEAEjD;;;AAWH,kBAAe;CACd;CACA;CACA"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ripple-ts/eslint-parser",
+  "version": "0.2.153",
+  "description": "ESLint parser for Ripple (.ripple files)",
+  "type": "module",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ripple-TS/ripple.git",
+    "directory": "packages/eslint-parser"
+  },
+  "bugs": {
+    "url": "https://github.com/Ripple-TS/ripple/issues"
+  },
+  "homepage": "https://ripple-ts.com",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "eslint",
+    "parser",
+    "ripple"
+  ],
+  "author": "Dominic Gannaway",
+  "license": "MIT",
+  "peerDependencies": {
+    "eslint": ">=9.0.0",
+    "ripple": "*"
+  },
+  "dependencies": {
+    "acorn": "^8.15.0",
+    "acorn-typescript": "^1.4.13"
+  },
+  "devDependencies": {
+    "@types/eslint": "^9.6.1",
+    "@types/estree": "^1.0.8",
+    "@types/node": "^24.3.0",
+    "tsdown": "^0.15.4",
+    "typescript": "^5.9.2",
+    "ripple": "0.2.153"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
+}