blob: 128b25a45fe97ab24d00a3b6be58d88e3d99a0f5 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
.. default-role:: code
=====================
Nimfix User Guide
=====================
:Author: Andreas Rumpf
:Version: |nimversion|
**WARNING**: Nimfix is currently beta-quality.
Nimfix is a tool to help you upgrade from Nimrod (<= version 0.9.6) to
Nim (=> version 0.10.0).
It performs 3 different actions:
1. It makes your code case consistent.
2. It renames every symbol that has a deprecation rule. So if a module has a
rule `{.deprecated: [TFoo: Foo].}` then `TFoo` is replaced by `Foo`.
3. It can also check that your identifiers adhere to the official style guide
and optionally modify them to do so (via `--styleCheck:auto`).
Note that `nimfix` defaults to **overwrite** your code unless you
use `--overwriteFiles:off`! But hey, if you do not use a version control
system by this day and age, your project is already in big trouble.
Installation
------------
Nimfix is part of the compiler distribution. Compile via:
```cmd
nim c compiler/nimfix/nimfix.nim
mv compiler/nimfix/nimfix bin
```
Or on windows:
```cmd
nim c compiler\nimfix\nimfix.nim
move compiler\nimfix\nimfix.exe bin
```
Usage
-----
Usage:
```cmd
nimfix [options] projectfile.nim
```
Options:
--overwriteFiles:on|off overwrite the original nim files. DEFAULT is ON!
--wholeProject overwrite every processed file.
--checkExtern:on|off style check also extern names
--styleCheck:on|off|auto performs style checking for identifiers
and suggests an alternative spelling;
'auto' corrects the spelling.
In addition, all command line options of Nim are supported.
|