Skip to content

Commit

Permalink
Docs wip
Browse files Browse the repository at this point in the history
  • Loading branch information
a-khakimov committed Nov 11, 2023
1 parent cbf1f7d commit 1e6ff21
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 2 deletions.
5 changes: 3 additions & 2 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ lazy val scala3Version = "3.3.0"

inThisBuild(
List(
organization := "org.ainr",
organization := "com.github.ainr",
homepage := Some(url("https://github.com/ainr/pravila")),
licenses := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
developers := List(
Expand All @@ -17,7 +17,8 @@ inThisBuild(
)
),
semanticdbEnabled := true,
semanticdbVersion := scalafixSemanticdb.revision
semanticdbVersion := scalafixSemanticdb.revision,
crossScalaVersions := List(V.scala213, V.scala212)
)
)

Expand Down
43 changes: 43 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Pravila

## Linting

### NoGeneralException

```
Main.scala:17:29: error: [NoGeneralException] Exception is not allowed
_ <- IO.fromOption(opt, new Exception("Boom!"))
^^^^^^^^^^^^^^^^^^^^^^
```

### NoHead

```
example
```

### NoMapApply

```
example
```

### NoOptionGet

```
example
```

### NoUnnamedArgs

```
example
```

## Refactoring

### MakeArgsNamed

```
example
```
12 changes: 12 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
theme: jekyll-theme-minimal
title: Pravila
description: Scalafix rules

plugins:
- jekyll-relative-links
- jekyll-coffeescript
- jekyll-github-metadata

relative_links:
enabled: true
collections: false
1 change: 1 addition & 0 deletions project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
resolvers += Resolver.sonatypeRepo("releases")
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.11.1")
addSbtPlugin("com.eed3si9n" % "sbt-projectmatrix" % "0.9.1")
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12")

0 comments on commit 1e6ff21

Please sign in to comment.