[feature] TypeScript types for Rules in NAPI

[Eric162]

⭐ Suggestion

It would be awesome to have either autogenerated or manually created types for the Rule type. The current type of rule in the napi package is any:

ast-grep/crates/napi/index.d.ts

Line 12 in b8a1b83

rule: any

Locally, I have defined a set of typescript types that work very well to guide rule creation. I translated the Python classes to JS types here like so:

interface Pattern {
  selector?: string;
  context?: string;
}

export interface Rule {
  // atomic rules
  pattern?: string | Pattern;
  kind?: string;
  regex?: string;

  // relational rules
  inside?: Relation;
  has?: Relation;
  precedes?: Relation;
  follows?: Relation;

  // composite rules
  all?: Rule[];
  any?: Rule[];
  not?: Rule;
  matches?: string;
}

type StopBy = 'neighbor' | 'end' | Rule;

interface Relation extends Rule {
  stopBy?: StopBy;
  field?: string;
}

💻 Use Cases

Anyone who uses the @ast-grep/napi package would benefit from type-checked rules!

Thank you for this package - it's awesome!