oxlint-plugin-effect 0.2.0 → 0.2.1

package/dist/vendor/effect-oxlint/SourceCode.d.ts

@@ -0,0 +1,180 @@
+import { RuleContext } from "./RuleContext.js";
+import * as Option from "effect/Option";
+import * as Effect from "effect/Effect";
+import { Comment, ESTree, LineColumn, Range, Scope, Token, Variable } from "@oxlint/plugins";
+
+//#region src/vendor/effect-oxlint/SourceCode.d.ts
+declare namespace SourceCode_d_exports {
+  export { commentsExistBetween, getAllComments, getAncestors, getCommentsAfter, getCommentsBefore, getCommentsInside, getDeclaredVariables, getFirstToken, getFirstTokenBetween, getIndexFromLoc, getJSDocComment, getLastToken, getLines, getLocFromIndex, getNodeByRangeIndex, getRange, getScope, getText, getTokenAfter, getTokenBefore, getTokenByRangeStart, getTokens, getTokensBetween, isGlobalReference, isSpaceBetween, markVariableAsUsed };
+}
+/**
+ * Get the source text for a node, optionally with surrounding characters.
+ *
+ * When called with no arguments, returns the entire source text.
+ * Pass an `Option<ESTree.Node>` to get text for a specific node.
+ *
+ * @since 0.2.0
+ */
+declare const getText: {
+  (): Effect.Effect<string, never, RuleContext>;
+  (node: Option.Option<ESTree.Node>, beforeCount?: number, afterCount?: number): Effect.Effect<string, never, RuleContext>;
+};
+/**
+ * Get the ancestor nodes of the given node, from innermost to outermost.
+ *
+ * Note: oxlint types `getAncestors` as returning `Node[]` where `Node`
+ * is the base `Span` interface. At runtime these are full `ESTree.Node`
+ * values — the cast bridges this upstream type gap at the FFI boundary.
+ *
+ * @since 0.2.0
+ */
+declare const getAncestors: (node: ESTree.Node) => Effect.Effect<ReadonlyArray<ESTree.Node>, never, RuleContext>;
+/**
+ * Get the AST node that contains the given source offset.
+ *
+ * Returns `Option.none()` when no node spans that offset.
+ *
+ * @since 0.2.0
+ */
+declare const getNodeByRangeIndex: (offset: number) => Effect.Effect<Option.Option<ESTree.Node>, never, RuleContext>;
+/**
+ * Convert a source offset (0-based) to a `{ line, column }` location.
+ *
+ * @since 0.2.0
+ */
+declare const getLocFromIndex: (offset: number) => Effect.Effect<LineColumn, never, RuleContext>;
+/**
+ * Convert a `{ line, column }` location to a source offset (0-based).
+ *
+ * @since 0.2.0
+ */
+declare const getIndexFromLoc: (loc: LineColumn) => Effect.Effect<number, never, RuleContext>;
+/**
+ * Get the range `[start, end]` for a node or token.
+ *
+ * @since 0.2.0
+ */
+declare const getRange: (nodeOrToken: ESTree.Node | Token | Comment) => Effect.Effect<Range, never, RuleContext>;
+/**
+ * Get the first token of a node.
+ *
+ * @since 0.2.0
+ */
+declare const getFirstToken: (node: ESTree.Node) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Get the last token of a node.
+ *
+ * @since 0.2.0
+ */
+declare const getLastToken: (node: ESTree.Node) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Get all tokens for a node.
+ *
+ * @since 0.2.0
+ */
+declare const getTokens: (node: ESTree.Node) => Effect.Effect<ReadonlyArray<Token>, never, RuleContext>;
+/**
+ * Get the token before a node or token.
+ *
+ * @since 0.2.0
+ */
+declare const getTokenBefore: (nodeOrToken: ESTree.Node | Token | Comment) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Get the token after a node or token.
+ *
+ * @since 0.2.0
+ */
+declare const getTokenAfter: (nodeOrToken: ESTree.Node | Token | Comment) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Get all tokens between two nodes/tokens.
+ *
+ * @since 0.2.0
+ */
+declare const getTokensBetween: (left: ESTree.Node | Token | Comment, right: ESTree.Node | Token | Comment) => Effect.Effect<ReadonlyArray<Token>, never, RuleContext>;
+/**
+ * Get the first token between two nodes/tokens.
+ *
+ * @since 0.2.0
+ */
+declare const getFirstTokenBetween: (left: ESTree.Node | Token | Comment, right: ESTree.Node | Token | Comment) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Find a token by its range start offset.
+ *
+ * @since 0.2.0
+ */
+declare const getTokenByRangeStart: (offset: number) => Effect.Effect<Option.Option<Token>, never, RuleContext>;
+/**
+ * Get all comments in the file.
+ *
+ * @since 0.2.0
+ */
+declare const getAllComments: () => Effect.Effect<ReadonlyArray<Comment>, never, RuleContext>;
+/**
+ * Get comments before a node or token.
+ *
+ * @since 0.2.0
+ */
+declare const getCommentsBefore: (nodeOrToken: ESTree.Node | Token | Comment) => Effect.Effect<ReadonlyArray<Comment>, never, RuleContext>;
+/**
+ * Get comments after a node or token.
+ *
+ * @since 0.2.0
+ */
+declare const getCommentsAfter: (nodeOrToken: ESTree.Node | Token | Comment) => Effect.Effect<ReadonlyArray<Comment>, never, RuleContext>;
+/**
+ * Get comments inside a node.
+ *
+ * @since 0.2.0
+ */
+declare const getCommentsInside: (node: ESTree.Node) => Effect.Effect<ReadonlyArray<Comment>, never, RuleContext>;
+/**
+ * Check whether comments exist between two nodes/tokens.
+ *
+ * @since 0.2.0
+ */
+declare const commentsExistBetween: (left: ESTree.Node | Token | Comment, right: ESTree.Node | Token | Comment) => Effect.Effect<boolean, never, RuleContext>;
+/**
+ * Get the JSDoc comment for a node.
+ *
+ * @deprecated Upstream deprecation. Use `getCommentsBefore` instead.
+ * @since 0.2.0
+ */
+declare const getJSDocComment: (node: ESTree.Node) => Effect.Effect<Option.Option<Comment>, never, RuleContext>;
+/**
+ * Get the scope for a node.
+ *
+ * @since 0.2.0
+ */
+declare const getScope: (node: ESTree.Node) => Effect.Effect<Scope, never, RuleContext>;
+/**
+ * Get declared variables for a node.
+ *
+ * @since 0.2.0
+ */
+declare const getDeclaredVariables: (node: ESTree.Node) => Effect.Effect<ReadonlyArray<Variable>, never, RuleContext>;
+/**
+ * Check whether a node is a global reference.
+ *
+ * @since 0.2.0
+ */
+declare const isGlobalReference: (node: ESTree.Node) => Effect.Effect<boolean, never, RuleContext>;
+/**
+ * Mark a variable as used in the scope of the given node.
+ *
+ * @since 0.2.0
+ */
+declare const markVariableAsUsed: (name: string, refNode?: ESTree.Node) => Effect.Effect<boolean, never, RuleContext>;
+/**
+ * Check whether there is a space between two nodes/tokens.
+ *
+ * @since 0.2.0
+ */
+declare const isSpaceBetween: (first: ESTree.Node | Token | Comment, second: ESTree.Node | Token | Comment) => Effect.Effect<boolean, never, RuleContext>;
+/**
+ * Get all source lines.
+ *
+ * @since 0.2.0
+ */
+declare const getLines: () => Effect.Effect<ReadonlyArray<string>, never, RuleContext>;
+//#endregion
+export { SourceCode_d_exports, commentsExistBetween, getAllComments, getAncestors, getCommentsAfter, getCommentsBefore, getCommentsInside, getDeclaredVariables, getFirstToken, getFirstTokenBetween, getIndexFromLoc, getJSDocComment, getLastToken, getLines, getLocFromIndex, getNodeByRangeIndex, getRange, getScope, getText, getTokenAfter, getTokenBefore, getTokenByRangeStart, getTokens, getTokensBetween, isGlobalReference, isSpaceBetween, markVariableAsUsed };

package/dist/vendor/effect-oxlint/SourceCode.js

@@ -0,0 +1,203 @@
+import { __exportAll } from "../../_virtual/_rolldown/runtime.js";
+import { RuleContext } from "./RuleContext.js";
+import * as Option from "effect/Option";
+import * as Effect from "effect/Effect";
+//#region src/vendor/effect-oxlint/SourceCode.ts
+var SourceCode_exports = /* @__PURE__ */ __exportAll({
+	commentsExistBetween: () => commentsExistBetween,
+	getAllComments: () => getAllComments,
+	getAncestors: () => getAncestors,
+	getCommentsAfter: () => getCommentsAfter,
+	getCommentsBefore: () => getCommentsBefore,
+	getCommentsInside: () => getCommentsInside,
+	getDeclaredVariables: () => getDeclaredVariables,
+	getFirstToken: () => getFirstToken,
+	getFirstTokenBetween: () => getFirstTokenBetween,
+	getIndexFromLoc: () => getIndexFromLoc,
+	getJSDocComment: () => getJSDocComment,
+	getLastToken: () => getLastToken,
+	getLines: () => getLines,
+	getLocFromIndex: () => getLocFromIndex,
+	getNodeByRangeIndex: () => getNodeByRangeIndex,
+	getRange: () => getRange,
+	getScope: () => getScope,
+	getText: () => getText,
+	getTokenAfter: () => getTokenAfter,
+	getTokenBefore: () => getTokenBefore,
+	getTokenByRangeStart: () => getTokenByRangeStart,
+	getTokens: () => getTokens,
+	getTokensBetween: () => getTokensBetween,
+	isGlobalReference: () => isGlobalReference,
+	isSpaceBetween: () => isSpaceBetween,
+	markVariableAsUsed: () => markVariableAsUsed
+});
+/** @internal */
+const withSourceCode = (fn) => Effect.service(RuleContext).pipe(Effect.map((ctx) => fn(ctx.sourceCode)));
+/**
+* Get the source text for a node, optionally with surrounding characters.
+*
+* When called with no arguments, returns the entire source text.
+* Pass an `Option<ESTree.Node>` to get text for a specific node.
+*
+* @since 0.2.0
+*/
+const getText = (node, beforeCount, afterCount) => withSourceCode((sc) => sc.getText(node === void 0 ? null : Option.getOrElse(node, () => null), beforeCount, afterCount));
+/**
+* Get the ancestor nodes of the given node, from innermost to outermost.
+*
+* Note: oxlint types `getAncestors` as returning `Node[]` where `Node`
+* is the base `Span` interface. At runtime these are full `ESTree.Node`
+* values — the cast bridges this upstream type gap at the FFI boundary.
+*
+* @since 0.2.0
+*/
+const getAncestors = (node) => withSourceCode((sc) => sc.getAncestors(node));
+/**
+* Get the AST node that contains the given source offset.
+*
+* Returns `Option.none()` when no node spans that offset.
+*
+* @since 0.2.0
+*/
+const getNodeByRangeIndex = (offset) => withSourceCode((sc) => Option.fromNullishOr(sc.getNodeByRangeIndex(offset)));
+/**
+* Convert a source offset (0-based) to a `{ line, column }` location.
+*
+* @since 0.2.0
+*/
+const getLocFromIndex = (offset) => withSourceCode((sc) => sc.getLocFromIndex(offset));
+/**
+* Convert a `{ line, column }` location to a source offset (0-based).
+*
+* @since 0.2.0
+*/
+const getIndexFromLoc = (loc) => withSourceCode((sc) => sc.getIndexFromLoc(loc));
+/**
+* Get the range `[start, end]` for a node or token.
+*
+* @since 0.2.0
+*/
+const getRange = (nodeOrToken) => withSourceCode((sc) => sc.getRange(nodeOrToken));
+/**
+* Get the first token of a node.
+*
+* @since 0.2.0
+*/
+const getFirstToken = (node) => withSourceCode((sc) => Option.fromNullishOr(sc.getFirstToken(node)));
+/**
+* Get the last token of a node.
+*
+* @since 0.2.0
+*/
+const getLastToken = (node) => withSourceCode((sc) => Option.fromNullishOr(sc.getLastToken(node)));
+/**
+* Get all tokens for a node.
+*
+* @since 0.2.0
+*/
+const getTokens = (node) => withSourceCode((sc) => sc.getTokens(node));
+/**
+* Get the token before a node or token.
+*
+* @since 0.2.0
+*/
+const getTokenBefore = (nodeOrToken) => withSourceCode((sc) => Option.fromNullishOr(sc.getTokenBefore(nodeOrToken)));
+/**
+* Get the token after a node or token.
+*
+* @since 0.2.0
+*/
+const getTokenAfter = (nodeOrToken) => withSourceCode((sc) => Option.fromNullishOr(sc.getTokenAfter(nodeOrToken)));
+/**
+* Get all tokens between two nodes/tokens.
+*
+* @since 0.2.0
+*/
+const getTokensBetween = (left, right) => withSourceCode((sc) => sc.getTokensBetween(left, right));
+/**
+* Get the first token between two nodes/tokens.
+*
+* @since 0.2.0
+*/
+const getFirstTokenBetween = (left, right) => withSourceCode((sc) => Option.fromNullishOr(sc.getFirstTokenBetween(left, right)));
+/**
+* Find a token by its range start offset.
+*
+* @since 0.2.0
+*/
+const getTokenByRangeStart = (offset) => withSourceCode((sc) => Option.fromNullishOr(sc.getTokenByRangeStart(offset)));
+/**
+* Get all comments in the file.
+*
+* @since 0.2.0
+*/
+const getAllComments = () => withSourceCode((sc) => sc.getAllComments());
+/**
+* Get comments before a node or token.
+*
+* @since 0.2.0
+*/
+const getCommentsBefore = (nodeOrToken) => withSourceCode((sc) => sc.getCommentsBefore(nodeOrToken));
+/**
+* Get comments after a node or token.
+*
+* @since 0.2.0
+*/
+const getCommentsAfter = (nodeOrToken) => withSourceCode((sc) => sc.getCommentsAfter(nodeOrToken));
+/**
+* Get comments inside a node.
+*
+* @since 0.2.0
+*/
+const getCommentsInside = (node) => withSourceCode((sc) => sc.getCommentsInside(node));
+/**
+* Check whether comments exist between two nodes/tokens.
+*
+* @since 0.2.0
+*/
+const commentsExistBetween = (left, right) => withSourceCode((sc) => sc.commentsExistBetween(left, right));
+/**
+* Get the JSDoc comment for a node.
+*
+* @deprecated Upstream deprecation. Use `getCommentsBefore` instead.
+* @since 0.2.0
+*/
+const getJSDocComment = (node) => withSourceCode((sc) => Option.fromNullishOr(sc.getJSDocComment(node)));
+/**
+* Get the scope for a node.
+*
+* @since 0.2.0
+*/
+const getScope = (node) => withSourceCode((sc) => sc.getScope(node));
+/**
+* Get declared variables for a node.
+*
+* @since 0.2.0
+*/
+const getDeclaredVariables = (node) => withSourceCode((sc) => sc.getDeclaredVariables(node));
+/**
+* Check whether a node is a global reference.
+*
+* @since 0.2.0
+*/
+const isGlobalReference = (node) => withSourceCode((sc) => sc.isGlobalReference(node));
+/**
+* Mark a variable as used in the scope of the given node.
+*
+* @since 0.2.0
+*/
+const markVariableAsUsed = (name, refNode) => withSourceCode((sc) => sc.markVariableAsUsed(name, refNode));
+/**
+* Check whether there is a space between two nodes/tokens.
+*
+* @since 0.2.0
+*/
+const isSpaceBetween = (first, second) => withSourceCode((sc) => sc.isSpaceBetween(first, second));
+/**
+* Get all source lines.
+*
+* @since 0.2.0
+*/
+const getLines = () => withSourceCode((sc) => sc.getLines());
+//#endregion
+export { SourceCode_exports, commentsExistBetween, getAllComments, getAncestors, getCommentsAfter, getCommentsBefore, getCommentsInside, getDeclaredVariables, getFirstToken, getFirstTokenBetween, getIndexFromLoc, getJSDocComment, getLastToken, getLines, getLocFromIndex, getNodeByRangeIndex, getRange, getScope, getText, getTokenAfter, getTokenBefore, getTokenByRangeStart, getTokens, getTokensBetween, isGlobalReference, isSpaceBetween, markVariableAsUsed };