Packages

styler

0.1.0
1.11.0 1.10.1 1.10.0 1.9.1 1.9.0 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.1 1.2.0 1.1.2 1.1.1 1.1.0 1.0.0 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 1.0.0-alpha.0 0.11.9 0.11.8 0.11.7 0.11.6 0.11.5 0.11.4 0.11.3 0.11.2 0.11.1 0.11.0 0.10.5 0.10.4 retired 0.10.3 0.10.2 0.10.1 0.10.0 0.9.7 0.9.6 0.9.5 0.9.4 0.9.3 0.9.2 retired 0.9.1 retired 0.9.0 0.8.5 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.14 0.7.13 0.7.12 0.7.11 0.7.10 0.7.9 0.7.8 0.7.7 0.7.6 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.1 0.6.0 0.5.2 0.5.1 0.5.0 0.4.1 0.4.0 0.3.1 0.3.0 0.2.0 0.1.1 0.1.0

A code-style enforcer that will just FIFY instead of complaining

HexDocs

Current section

Files

Jump to
Readme
84 Versions
1 Dependency
Dependants
Files
Activity
styler lib style.ex
Raw

lib/style.ex 

# Copyright 2023 Adobe. All rights reserved.

# This file is licensed to you under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License. You may obtain a copy

# of the License at http://www.apache.org/licenses/LICENSE-2.0



# Unless required by applicable law or agreed to in writing, software distributed under

# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS

# OF ANY KIND, either express or implied. See the License for the specific language

# governing permissions and limitations under the License.



defmodule Styler.Style do

  @moduledoc """

  A Style takes AST and returns a transformed version of that AST.



  Because these transformations involve traversing trees (the "T" in "AST"), we wrap the AST in a structure

  called a Zipper to facilitate walking the trees.

  """



  alias Styler.Zipper



  @type command :: :cont | :skip | :halt



  @doc """

  `run` will be used with `Zipper.traverse_while/3`, meaning it will be executed on every node of the AST.



  You can skip traversing parts of the tree by returning a Zipper that's further along in the traversal, for example

  by calling `Zipper.skip(zipper)` to skip an entire subtree you know is of no interest to your Style.

  """

  @callback run(Zipper.zipper()) :: Zipper.zipper() | {command(), Zipper.zipper()}



  @doc false

  # this lets Styles optionally implement as though they're running inside of `Zipper.traverse`

  # or `Zipper.traverse_while` for finer-grained control

  def wrap_run(style) do

    fn zipper ->

      case style.run(zipper) do

        {next, {_, _} = _zipper} = command when next in ~w(cont halt skip)a -> command

        zipper -> {:cont, zipper}

      end

    end

  end

end