https://github.com/scalacenter/scalafix.g8

Giter8 template to implement custom rewrites
https://github.com/scalacenter/scalafix.g8

giter8 giter8-template refactoring scala scalafix scalameta

Last synced: 3 months ago
JSON representation

Giter8 template to implement custom rewrites

• Host: GitHub
• URL: https://github.com/scalacenter/scalafix.g8
• Owner: scalacenter
• Created: 2017-06-08T13:26:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T17:56:18.000Z (5 months ago)
• Last Synced: 2024-08-21T20:11:10.227Z (5 months ago)
• Topics: giter8, giter8-template, refactoring, scala, scalafix, scalameta
• Language: Scala
• Size: 249 KB
• Stars: 10
• Watchers: 7
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
[![Build status](https://github.com/scalacenter/scalafix.g8/workflows/CI/badge.svg)](https://github.com/scalacenter/scalafix.g8/actions?query=workflow)

# Giter8 template to create Scalafix rules

Assuming you are located inside the directory `myproject`:

```

sbt new scalacenter/scalafix.g8

cd scalafix

sbt tests/test

```

If the repository is available on GitHub through at `$USERNAME/myproject`

then users can run the rule with `scalafix --rules github:$USERNAME/myproject/v1`.

The `v1` part is the name of you rule and can be any string.

For example, if the rule contains migration rules for version

8 of your library it's good to call it `v8`.

If the rule is a linter that prohibits vars, the name can be `NoVars`.

## migration-rules

We keep here migration rules used to make easier the upgrade of Scalafix Versions when breaking binary and source

compatibilities

- v0.6.x: a migration rule to help the migration to 0.6.x

- v0.9.28: After deprecating SemanticRule and SyntacticRule classes provided by scalafix-testkit, this rule will

  automatically fix SemanticRule class usage in code sources that still rely on it.

## Template license

Written in 2020 by Scala Center

To the extent possible under law, the author(s) have dedicated all copyright and related

and neighboring rights to this template to the public domain worldwide.

This template is distributed without any warranty. See .