-
Notifications
You must be signed in to change notification settings - Fork 25
/
README.md
325 lines (251 loc) · 12 KB
/
README.md
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<img alt="pdd logo" src="https://avatars2.githubusercontent.com/u/24456188" width="92px" height="92px"/>
[](https://www.elegantobjects.org)
[](http://www.rultor.com/p/cqfn/pdd)
[](https://www.jetbrains.com/ruby/)
[](https://github.com/cqfn/pdd/actions/workflows/rake.yml)
[](http://www.0pdd.com/p?name=cqfn/pdd)
[](https://codecov.io/gh/yegor/pdd)
[](https://hitsofcode.com/view/github/cqfn/pdd)
[](https://github.com/cqfn/pdd/blob/master/LICENSE.txt)
[](http://badge.fury.io/rb/pdd)
[](https://codeclimate.com/github/cqfn/pdd/maintainability)
[](http://rubydoc.info/github/cqfn/pdd/master/frames)
[](https://www.codacy.com/gh/cqfn/pdd/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cqfn/pdd&utm_campaign=Badge_Grade)
Read this article about
[_Puzzle Driven Development_](http://www.yegor256.com/2009/03/04/pdd.html).
Check also patent application [US 12/840,306](http://www.google.com/patents/US20120023476)
Also, check [0pdd.com](http://www.0pdd.com): a hosted service,
where this command line tool works for you.
Read
[_PDD in Action_](http://www.yegor256.com/2017/04/05/pdd-in-action.html)
and watch [this webinar](https://www.youtube.com/watch?v=nsYGC2aUwfQ).
First, make sure Ruby 2.6+ and [`libmagic`](#how-to-install-libmagic) are installed. Then, install our gem:
```bash
$ gem install pdd
```
Run it locally and read its output:
```bash
$ pdd --help
```
## Usage
You can exclude & include certain number of files from the search via these options:
```bash
$ pdd --exclude glob
```
You can skip any file(s) with a name suffix that matches the pattern glob, using wildcard matching;
a name suffix is either the whole path and name, or reg expr, for example:
```bash
$ pdd --exclude src/**/*.java --exclude target/**/*
$ pdd --exclude src/**/*.java # exclude .java files in src/
$ pdd --exclude src/**/* # exclude all files in src/
```
You can include too:
```bash
$ pdd --include glob
```
Search only files whose name matches glob, using wildcard matching as described under ``--exclude``.
If contradictory ``--include`` and ``--exclude`` options are given, the last matching one wins.
If no ``--include`` or ``--exclude`` options are given, all files from working directory are included, example:
```bash
$ pdd --include src/**/*.py # include only .py files in src/
$ pdd --include src/**/* # include all files in src/
```
Full command format is (all parameters are optional):
```bash
$ pdd [--verbose] [--quiet] [--remove] [--skip-gitignore] [--skip-errors] \
[--source <project_dir_path>] [--file puzzles_file.xml] [--include src/**/*.py] \
[--format xml|html] [--rule min-words:5] [--exclude src/**/*.java]
```
| Parameter | Description |
|-------------------------|---------------------------------------------------------------------------------------|
| --verbose | Enable verbose (debug) mode. --file must be used in case of using this option |
| --quiet | Disable logs |
| --remove | Remove all found puzzles from the source code |
| --skip-gitignore | Don't look into .gitignore for excludes |
| --skip-errors | Suppress error as warning and skip badly formatted puzzles (do not skip broken rules) |
| --source <project-path> | Source directory to parse ("." by default) |
| --file puzzles.xml | File to save report into (xml of html) (displayed in console by default) |
| --include *.py | Glob pattern to include (can be used several times) |
| --exclude *.java | Glob pattern to exclude (can be used several times) |
| --format xml | Format of the report xml or html (xml is default) |
| --rule min-words:5 | Rule to apply (can be used several times), described later |
:bulb: There is an option to create a .pdd file in your project and save all required parameters in it.
File example you can see in this project.
## How to Format?
Every puzzle has to be formatted like this (pay attention
to the leading space in every consecutive line):
```java
/**
* @todo #[issue#]<:[time]></[role]> <[description]>
*/
[related code]
```
`[]` - Replace with appropriate data (see text enclosed in brackets)
`<>` - Optional (enclosed data can be left out)
Example:
```java
/**
* @todo #234:15m/DEV This is something to do later
* in one of the next releases. I can't figure out
* how to implement it now, that's why the puzzle.
* The text can be so long, as needed, just use
* the same anount of spaces, as the second line.
* This text will be not a part of the puzzle, as
* it has less spaces.
*/
void sendEmail() {
throw new UnsupportedOperationException();
}
```
If you use it in combination with [0pdd](http://www.0pdd.com),
after processing this text, the issue titled
"File.java:10-13: This is something to do later in one of ..." will be created.
The specified markers will be included in the issues body
along with some predefined text. If your comment is longer
than 40 characters, it will be truncated in the title.
Note: if you create several puzzle duplicates (same text after puzzle keyword),
pdd will fail to parse puzzles and produce an error with duplicates list.
There are 3 supported keywords, one of which must precede the mandatory
puzzle marker. They are `@todo`, `TODO` and `TODO:`.
As an example, it starts with `@todo`, followed by a space and a mandatory
puzzle **marker**. Possible formats of puzzle markers (it doesn't matter what the
line starts with and where it is located,
as long as you have one of the 3 supported keywords right in front
of the mandatory marker):
```
// @todo #224 Puzzle description
# @todo #55:45min Puzzle description
@todo #67/DES Puzzle description
;; @todo #678:40m/DEV Puzzle description
// TODO: #TEST-21:30min Puzzle description
```
Here `DES` and `DEV` are the roles of people who must fix that puzzles;
`45min` and `40m` is the amount of time the puzzle should take;
`224`, `55`, `67`, `678` and `TEST-21` are the IDs of the tickets
these puzzles are coming from.
Markers are absolutely necessary for all puzzles, because they allow
us to build a hierarchical dependency tree of all puzzles, like
[this one](http://www.0pdd.com/p?name=yegor256/takes),
for example. Technically, of course, you can abuse the system
and put a dummy `#1` marker everywhere.
### Multiline examples
For multiline puzzles there are two important things:
- **prefix** - any optional text followed by space before puzzle keyword (todo).
It should be the same for all lines of puzzle description.
- \ symbol can be used to logically divide puzzle description.
prefix should be presented with it.
Examples:
```xml
<!--
~ if comment should be started and closed by special symbols, then place them in
~ a separate lines
~ Any symbol can be used as a prefix, it will be excluded from the text.
~ But do not forget about the space before puzzle keyword.
~
~ @todo #34 Description can be as long as needed.
~ Just use at least the same amount of the spaces, as on the first line.
~ It will be added to description.
-->
```
```java
/**
* @todo #36 Multiline text can use the same prefix in all lines or the same
* amount of spaces.
* So this will be added to the puzzle description. If you want to divide the
* puzzle logically by empty line, just add a backspace to that line
* \
* and continue the text after.
*
* This line is not part of the puzzle, because the line before does not contain
* prefix.
*/
```
## How to Configure Rules?
You can specify post-parsing rules for your puzzles, in command line,
for example:
```bash
$ pdd --rule min-estimate:60 --rule max-estimate:120
```
These two parameters will add two post-parsing rules `min-estimate`
and `max-estimate` with parameters. Each rule may have an optional
parameter specified after a colon.
Here is a list of rules available now:
- `min-estimate:15` blocks all puzzles that don't have an estimate
or their estimates are less than 15 minutes.
- `max-estimate:120` blocks all puzzles with estimates over 120 minutes.
- `available-roles:DEV,IMP,DES` specifies a list of roles that
are allowed in puzzles. Puzzles without explicitly specified
roles will be rejected.
- `min-words:5` blocks puzzles with descriptions shorter than five words.
- `max-duplicates:1` blocks more than one duplicate of any puzzle.
This rule is used by default and you can't configure it at the moment,
it must always be set to `1`.
:bulb: You can put all command line options into `.pdd` file. The options from the
file will be used first. Command line options may be added on top of them.
See, how it is done in [yegor256/0pdd](https://github.com/yegor256/0pdd/blob/master/.pdd).
## How to read XML
The XML produced will look approximately like this (here is a
[real example](http://www.0pdd.com/snapshot?name=yegor256/takes)):
```xml
<puzzles>
<puzzle>
<ticket>516</ticket>
<estimate>15</estimate>
<role>DEV</role>
<id>516-ffc97ad1</id>
<lines>61-63</lines>
<body>This has to be fixed later...</body>
<file>src/test/java/org/takes/SomeTest.java</file>
<author>Yegor Bugayenko</author>
<email>yegor256@gmail.com</email>
<time>2018-01-01T21:09:03Z</time>
</puzzle>
</puzzles>
```
NOTE: puzzles are saved with utf-8 encoding
[XSD Schema](http://pdd-xsd.teamed.io/0.19.4.xsd) is here.
The most interesting parts of each puzzle are:
- `ticket` is a ticket name puzzle marker starts from, in most
cases it will be the number of GitHub issue.
- `estimate` is the amount of minutes the puzzle is supposed to take.
- `id` is a unique ID of the puzzle. It is calculated by the
internal algorithm that takes into account only the text of the puzzle.
Thus, if you move the puzzle from one file to another, the ID won't
change. Also, changing the location of a puzzle inside a file
won't change its ID.
- `lines` is where the puzzle is found, inside the file.
## How to install libmagic
For Debian/Ubuntu:
```bash
$ apt install libmagic-dev
```
For Mac:
```bash
$ brew install libmagic
```
Unfortunately, there is no easy way to install on Windows, try to use
[WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) or
[Docker](https://www.docker.com/).
## How to contribute
Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure your build is green before you contribute
your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.7+ and
[Bundler](https://bundler.io/) installed. Then:
```bash
$ bundle install
$ bundle exec rake
```
Next, install and run overcommit to install hooks (required once)
```bash
$ gem install overcommit -v '=0.58.0'
$ overcommit --install
```
If it's clean and you don't see any error messages, submit your pull request.
This is how you run the tool locally to test how it works:
```bash
$ ./bin/pdd --help
```
To run a single unit test:
```bash
$ bundle exec ruby test/test_many.rb
```