benjamn / benjamn/recast

Unify builder and types API?

Open
#187 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5.3k
Forks
364
Avg merge
3d 8h
Merged PRs (30d)
3

Description

One thing that confused me at the beginning was that builders start with lower case (e.g. ifStatement) and types start with upper case (i.e. IfStatement).

Is there a particular reason for this? Or maybe this feels more intuitive for others (I don't find it intuitive). Would it be possible and/or reasonable to unify them (preferable upper case to match the AST node type name)?

(if not, tools that use ast-types could always provide their own unified API I guess)

Contributor guide

No contributing guide indexed for this repository

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 reviewing the builder and type APIs described in the issue, including the ast-types integration and the ifStatement/IfStatement examples. Determine whether a unified naming convention is intended and what compatibility constraints existing tools would face; done would require an agreed API direction and corresponding scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.