https://github.com/cycneuramus/nimpsort
Sort imports in Nim source files
https://github.com/cycneuramus/nimpsort
nim nim-lang
Last synced: 3 months ago
JSON representation
Sort imports in Nim source files
- Host: GitHub
- URL: https://github.com/cycneuramus/nimpsort
- Owner: cycneuramus
- Created: 2025-03-18T14:05:31.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-05-05T13:24:18.000Z (5 months ago)
- Last Synced: 2025-05-05T14:42:01.039Z (5 months ago)
- Topics: nim, nim-lang
- Language: Nim
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
# Nimpsort
This is a simple formatting tool that alphabetically sorts top-level import statements in Nim source files. It currently supports regular comma-separated imports, bracketed imports, and prefixed imports. It will also preserve (and properly align) postfix comments, if any.
## Installation
**Using Nimble**
```bash
nimble install nimpsort
```
**Compiling from source**
```bash
nim c -d:release src/nimpsort.nim
```
**Downloading binary**
Pre-built binaries for Linux (AMD64) are available on the [release page](https://github.com/cycneuramus/nimpsort/releases).
## Example
Given the file `myprog.nim`:
```nim
import std/[os, logging, tables, strutils]
import ./[common, action, target, config] # aligned comment
import pkg/[regex, cligen]# misaligned comment
import sequtils, options # another one
```
`nimpsort myprog.nim` will turn it into:
```nim
import std/[logging, os, strutils, tables]
import ./[action, common, config, target] # aligned comment
import pkg/[cligen, regex] # misaligned comment
import options, sequtils # another one
```
**NOTE**: `nimpsort` does not currently support, but will ignore, multi-line import statements:
```nim
import
terminal,
strutils,
os
```