cjkfmt 0.0.7

Formatter for CJK text files
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

# Contribution guidelines

First off, thank you for considering contributing to cjkfmt.

If your contribution is not straightforward, please first discuss the change you
wish to make by creating a new issue before making the change.

## Reporting issues

Before reporting an issue on the
[issue tracker](https://github.com/sgryjp/cjkfmt/issues),
please check that it has not already been reported by searching for some related
keywords.

## Pull requests

Try to do one pull request per change.

### Updating the changelog

Update the changes you have made in
[CHANGELOG](https://github.com/sgryjp/cjkfmt/blob/main/CHANGELOG.md)
file under the **Unreleased** section.

Add the changes of your pull request to one of the following subsections,
depending on the types of changes defined by
[Keep a changelog](https://keepachangelog.com/en/1.0.0/):

- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

If the required subsection does not exist yet under **Unreleased**, create it!

## Developing

### Set up

This is no different than other Rust projects.

```shell
git clone https://github.com/sgryjp/cjkfmt
cd cjkfmt
cargo test
```

#### Setting up lefthook

This project uses [lefthook](https://github.com/evilmartians/lefthook) to enforce linting and
formatting standards. To set it up:

1. Install lefthook (if you haven't already):

   ```shell
   # Using Homebrew (macOS)
   brew install lefthook

   # Using scoop (Windows)
   scoop install lefthook

   # Other installation methods are available at https://github.com/evilmartians/lefthook
   ```

2. Initialize lefthook in the repository:

   ```shell
   lefthook install
   ```

This will set up Git hooks that will run linters and formatters automatically on commit and push
operations.

Markdown files are linted on commit using [markdownlint-cli2] (via `npx`),
following the rules in [`.markdownlint.yml`](./.markdownlint.yml).
Make sure you have [Node.js](https://nodejs.org/) installed so `npx` is available.

### Useful Commands

- Build and run release version:

  ```shell
  cargo build --release && cargo run --release
  ```

- Run Clippy:

  ```shell
  cargo clippy --all-targets --all-features
  ```

- Run all tests:

  ```shell
  cargo test --all-features
  ```

- Check to see if there are code formatting issues

  ```shell
  cargo fmt --all -- --check
  ```

- Format the code in the project

  ```shell
  cargo fmt --all
  ```

- Check Markdown files for style issues

  ```shell
  npx --yes markdownlint-cli2 "**/*.md"
  ```

[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2