tekton 0.2.0

A blazingly fast code snippet sorter
Documentation 
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# tekton [![Latest Version]][crates.io] ![Workflow] ![Rustc Version 1.66+]

---

[workflow]: https://github.com/OkelleyDevelopment/tekton/actions/workflows/ci.yml/badge.svg
[latest version]: https://img.shields.io/crates/v/tekton.svg
[crates.io]: https://crates.io/crates/tekton
[rustc version 1.66+]: https://img.shields.io/badge/rustc-1.66+-blue.svg

Author(s): Nicholas O'Kelley

Date started: 2022-08-28

**Note**: The code on the repo represents the work done for `v0.2.0` which will be published to crates.io soon.

## Motivation

I needed a tool to speed up the time I spent reviewing snippets on the [`friendly-snippet`](https://github.com/rafamadriz/friendly-snippets) project.

The goals of such a tool are:

- Sort many files **blazingly fast**
- (Ideally) Sort alphabetically **blazingly fast**
- Convert between snipmate and friendly-snippets (json) formats **blazingly** ... **fast**

---

## Installation and Usage

### For published versions

- `cargo install tekton`

### For source builds

From the project root:

- `cargo install --path ./`

### Usage

**To convert**:

- `tekton convert <INPUT_FILENAME> <OUTPUT_FILENAME>`

> Note:
>
> - Conversion supports bidirectional conversion between Snipmate (`*.snippet`) and JSON (`*.json`) snippets
> - Mapping is based on the input file

**To sort**:

- General format: `tekton sort <INPUT_FILENAME> [INTERACTIVE] [CRAWL]`
  - To sort a single file: `tekton sort <INPUT_NAME>`
  - To sort a directory: `tekton sort <INPUT_NAME> no true`

> Note:
>
> - `INTERACTIVE` should be the string `yes` if the user wants to fix any errors during the sort.
>
>   - Leaving this off will simply mean an error report is displayed on screen
>
> - `CRAWL` must be present to recursively walk the directories for snippets
>   - Any text present will result in a crawl, though `true` looks better.

---

## Demos

- Conversion from Snipmate to `JSON`

![json-bay-bee](./images/snipmate_to_json.png)

- Conversion from the `JSON` snippets to Snipmate

![Conversion](./images/converting_json_to_snipmate.png)

- Sorting `friendly-snippets`, **blazingly fast** , with interactive mode off and directory crawling on.

![Sorting](./images/sorting_json.png)

---

## Current Limitations

1. The conversion doesn't process in large batches of files like the sort. This is intentional as conversions between formats should be isolated and limited in scope.
   - This can be automated via other scripting means (Rust, Go, Python, etc).
2. Snippet files with an array in the `prefix` field (even if it is just one) will convert all the snippets in the file to then have their snippets inserted into an array too.

   - **Note**: I am partially working on writing a custom `Serialize` and `Deserialize` implementation to handle clean up the serialization for one element, though that will be tied to a future update.

3. Currently do not sort Snipmate snippets.
   - This was outside the scope, but might be something I consider in the future.

---

## Acknowledgements

- My impatience for doing this by hand