alchemyplatform / alchemyplatform/aa-sdk

Use twoslash to create an eslint rule that validates jsdoc example tags

Open
#794 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
321
Forks
231
Avg merge
43m
Merged PRs (30d)
3

Description

This issue has no description.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by investigating how the repository uses ESLint and whether Twoslash is already configured. Define the expected validation for JSDoc example tags and consider the issue complete when the ESLint rule reliably reports invalid examples and accepts valid ones.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.