API and usage ideas #1
jamesrwilliams
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Conceptual Plan
A large part of the usefulness of this project is making sure the way in which developers configure the code modifications is as simple and maintainable as possible. This discussion is to document the direction we're considering for the public API and to cover off some concepts we're using as we develop this project.
Actions
An action is a single operation taken on a code base that carries out the same change multiple times for any number of files. For example renaming all the
data-foo
attribute values tox
would be an Action.Declaring an Action
This is a rough first draft for the modification API on how you declare your modification actions. For this example we're only looking at HTML modification actions.
Changes
A change is a collection of actions. Typically a change would be used to encapsulate a single breaking change.
For example an API change requires three JSON keys need to be updated to their new versions. Each unique key change would be an Action. All three are then grouped into a single Change.
Beta Was this translation helpful? Give feedback.
All reactions