jackfirth / jackfirth/resyntax

Inlining-based refactorings

Open
#353 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Racket
Stars
70
Forks
11
PR merge metrics
No merged PRs in 30d

Description

When libraries deprecate functions, those functions can often still be trivially expressed in terms of the library's other public APIs. Migrating users away from those functions is a trivial refactoring: just inline the function everywhere. It should be possible for library owners to declare that Resyntax should inline those functions. For instance, say a library has this code:

(provide foo bar)

;; Deprecated, use bar instead
(define/recommend-inlining (foo x mode)
  (bar x #:mode mode))

(define (bar x #:mode mode)
  ...)

Resyntax should be able to migrate all (foo x mode) expressions to (bar x #:mode mode) automatically.

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

The issue names no files, tests, or entry points. Start by locating Resyntax's existing refactoring and library-declaration machinery; done means library owners can declare an inlineable deprecated function and expressions using it are migrated to the equivalent public API form shown.

Written by the indexing model from the issue text.

Assessment

Domain
devtools, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.