walkmod.github.io/index.html at master · walkmod/walkmod.github.io · GitHub

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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>WalkMod</title>
  <meta name="description" content="Open Source Tool to automatically reduce technical debt by fixing PMD, CheckStyle or SonarQube issues" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Loading Bootstrap -->
  <link href="css/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">

  <!-- Loading Flat UI -->
  <link href="css/flat-ui.css" rel="stylesheet">
  <link href="docs/assets/css/demo.css" rel="stylesheet">


  <link rel="stylesheet" href="codemirror/lib/codemirror.css">
  <link rel="stylesheet" href="codemirror/theme/zenburn.css">
  <link rel="stylesheet"
  href="codemirror/addon/hint/show-hint.css">


  <link rel="shortcut icon" href="favicon.ico">

  <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
  <!--[if lt IE 9]>
  <script src="/js/vendor/html5shiv.js"></script>
  <script src="/js/vendor/respond.min.js"></script>
  <![endif]-->

  <script>
    (function(i, s, o, g, r, a, m) {
        i['GoogleAnalyticsObject'] = r;
        i[r] = i[r] || function() {
            (i[r].q = i[r].q || []).push(arguments)
        }, i[r].l = 1 * new Date();
        a = s.createElement(o), m = s.getElementsByTagName(o)[0];
        a.async = 1;
        a.src = g;
        m.parentNode.insertBefore(a, m)
    })(window, document, 'script', '//www.google-analytics.com/analytics.js',
            'ga');

    ga('create', 'UA-43600294-1', 'auto');

    ga('send', 'pageview');


</script>
</head>
<body>
<style>

body {
  min-height: 2000px;
  padding-top: 70px;
}

.banner{
  background-color:#1abc9c;
  padding-top: 15px;
  margin-top:50px;
  font-size:14px;
}

.title{
  background-color:#34495e;
  color:white;
  padding-top: 0px;
  margin-top:50px;
  margin-bottom:50px;
}

.contact{
  background-color:#34495e;
  color:white;
  padding-bottom:50px;
}

@media (max-width: 767px) {
    .demo-logo .logo {
        background-size: 300px 234px;
        width: 300px;
   }


   .footer-banner {
        margin-left: 0px;
   }


}
</style>

<!-- Static navbar -->
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
      </button>
      <a class="navbar-brand" href="/" style="font-family: ubuntu-titletitle; font-size: 30px;">WalkMod</a>
    </div>
    <div class="navbar-collapse collapse">

      <ul class="nav navbar-nav navbar-right">
        <li><a href="#installation">Installation</a></li>
        <li><a href="#usage">Usage</a></li>
        <li><a href="#integration">Integration</a></li>
        <li><a href="#contribute">Contribute</a></li>
        <li><a href="#workrecognition">Talks</a></li>
        <li><a href="#contact">Contact</a></li>
        <li><a href="https://blog.walkmod.com">Blog</a></li>


      </ul>
    </div><!--/.nav-collapse -->
  </div>
</div>
<div class="container">
  <div class="demo-headline">
    <h1 class="demo-logo" style="font-family: ubuntu-titletitle; font-size: 100px;">
      <div class="logo"></div>
      WalkMod
      <small>Open Source Tool to Fix Java Coding Style Issues</small>

    </h1>

    <div class="row demo-row">
      <div class="col-md-6 col-md-offset-3">
        <a rel="nofollow" onclick="ga('send', 'event', 'download', 'download'); return true;"
            href="https://bitbucket.org/rpau/walkmod/downloads/walkmod-3.0.0-installer.zip"
            type="application/x-zip-compressed" class="btn btn-block btn-lg btn-primary">Download</a>
      </div>

    </div>

  </div>
</div>

<div class="title">
  <div class="banner">
    <div class="container">
      <div class="row">
        <div class="col-md-6 col-xs-12" style="margin-bottom: 30px;">

          <span style="font-size:18px;">Original
            code:</span>
            <form action="">
              <textarea id="java-code-original" rows="12" style="width: 100%"
              placeholder="//Paste quality Java code here">
import java.io.InputStream;
import java.util.LinkedList;

public class Calculator {

  private double total = 0, zero=0;
  private void reset(){total = 0;}
  public int getTotal(){return total;}
  public void sum(double value){total+=value;}
  public void pow(double value) {
    /*
    for (int i = 0; i < value; i++) {
      multiply(value);
    }*/
    total = Math.pow(total, value);
    System.out.println("The pow is "+total);
  }}
              </textarea>
            </form>
          </div>
          <div class="col-md-6 col-xs-12">
            <span style="font-size:18px;">...
              and after running it:</span>
              <textarea id="java-code-final" rows="12" style="width: 100%">public class Calculator {

  private double total = 0;

  public int getTotal(){
    return total;
  }

  public void pow(double value) {
    total = Math.pow(total, value);
  }

  public void sum(double value) {
    total = total + value;
  }

}
            </textarea>
          </div>
        </div>
      </div>
    </div>
  <section id="installation">
      <div class="container"><h1 >Installation</h1></div>
      </div>
      <div class="container">
        <h4>From Binary distribution</h4>
        The only requirement is the Java Virtual Machine (equal or greater than 1.7).

        <ol>
          <li>Download and unzip the <a rel="nofollow"
            href="https://bitbucket.org/rpau/walkmod/downloads/walkmod-3.0.0-installer.zip"
            type="application/x-zip-compressed"
            onclick="ga('send', 'event', 'download', 'download'); return true;" >walkmod-3.0.0-installer.zip</a> to
            the directory you wish to install walkmod <code>WALKMOD_HOME</code>.
          </li>
          <li>Add <code>WALKMOD_HOME/bin</code> folder to
            your <code>PATH</code> environment variable.
          </li>
          <li>Open a prompt and type<code> walkmod --version</code>. It
            should print out your installed version of walkmod, for example: <pre
            style="margin-top: 5px;">Walkmod version "3.0"
Java version: 1.8.0_101
Java Home: /Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home/jre
OS: Mac OS X, Version: 10.12.2</pre>
          </li>
        </ol>
        Alternatively, Mac OS users can also install walkmod from HomeBrew
        <code>brew install walkmod</code>
      </div>
  </section>
  <section id="usage">
      <div class="title">
        <div class="container"><h1>Usage</h1></div>
      </div>
      <div class="container">
        <p>WalkMod started as a framework to write code transformations. However, most of the users look for quick fixes
          for existing static code analysis tools. Here appear the commands to get the results.</p>
          <div>
            <h4>For PMD</h4>
            <pre>walkmod apply pmd</pre>
          </div>
          <div>
            <h4>For CheckStyle</h4>
            <pre>walkmod apply checkstyle</pre>
          </div>
          <div>
            <h4>For SonarQube</h4>
            <pre>walkmod apply -DauthToken="THIS_IS_MY_TOKEN" -DsonarHost="https://sonarqube.com" sonar</pre>
          </div>

          <p>If you want to learn how to use more complex code transformations through a fixed configuration (<code>walkmod.xml</code>), read our documentation.
          </p>
          <div class="row demo-row">
           <div class="col-xs-6">
                <a href="docs.html" onclick="ga('send', 'event', 'docs', 'view'); return true;" class="btn btn-block btn-lg btn-primary">Go to Documentation</a>
              </div>
          </div>
      </div>
  </section>
  <section id="integration">
      <div class="title">
        <div class="container"><h1>Integration</h1></div>
      </div>
      <div class="container">
        <h2>Maven</h2>
        You can run WalkMod in your build process (PMD, CheckStyle or SonarQube) by adding the following <a href="https://github.com/walkmod/maven-walkmod-plugin">Maven WalkMod plugin</a> in
        your <code>pom.xml</code>. This example, shows you how to apply quick fixes for PMD using Maven.
        <pre>
          &lt;plugin&gt;
            &lt;groupId&gt;org.walkmod.maven.plugins&lt;/groupId&gt;
            &lt;artifactId&gt;walkmod-maven-plugin&lt;/artifactId&gt;
            &lt;version&gt;1.0.3&lt;/version&gt;
            &lt;executions&gt;
              &lt;execution&gt;
                &lt;phase&gt;generate-sources&lt;/phase&gt;
                &lt;goals&gt;
                  &lt;goal&gt;apply&lt;/goal&gt;
                &lt;/goals&gt;
                &lt;configuration&gt;
                  &lt;chains&gt;pmd&lt;/chains&gt;
                  &lt;properties&gt;configurationFile=rulesets/java/basic.xml&lt;/properties&gt;
                &lt;/configuration&gt;
              &lt;/execution&gt;
            &lt;/executions&gt;
          &lt;/plugin&gt;
        </pre>
        And run
        <pre>
          mvn package
        </pre>
        <p>In order set your custom configuration parameters, visit the official plugin site</p>
        <a href="https://github.com/walkmod/maven-walkmod-plugin" class="pull-right btn  btn-lg btn-primary">
          Visit Maven Plugin Site</a>

      </div>
      <div class="container">
        <h2>Gradle</h2>
        You can also run WalkMod in your gradle project by adding the following <a href="https://github.com/walkmod/gradle-walkmod-plugin">Gradle WalkMod plugin</a> in
        your <code>build.gradle</code>. This example, shows you how to apply quick fixes for PMD using Gradle.
        <pre>buildscript {
    repositories {
        mavenCentral()
        jcenter()
    }

    dependencies {
        classpath 'org.walkmod:gradle-walkmod-plugin:0.0.1'
    }
}
apply plugin: 'walkmod'
walkmod {
  chains = [ 'pmd' ]
}
          </pre>
        And run
        <pre>
            gradle walkmodApply
          </pre>
        <p>In order set your custom configuration parameters, visit the official plugin site</p>
        <a href="https://github.com/walkmod/gradle-walkmod-plugin" class="pull-right btn  btn-lg btn-primary">
          Visit Gradle Plugin Site</a>

      </div>
  </section>
  <section id="contribute">
        <div class="title">
          <div class="container"><h1>Contribute</h1></div>
        </div>
        <div class="container">

          <div class="row" >
            <div class="col-md-9 col-xs-12">
              <p>
              You can easily contribute, by starring or forking our <a href="https://github.com/walkmod/walkmod-core" target="_blank">GitHub repository</a>. </p>
              <p style="text-align:center">
                <iframe src="http://ghbtns.com/github-btn.html?user=walkmod&amp;repo=walkmod-core&amp;type=watch&amp;count=true" height="20" width="90" frameborder="0" scrolling="0" style="height: 20px;" allowtransparency="true"></iframe>
                  <iframe src="http://ghbtns.com/github-btn.html?user=walkmod&amp;repo=walkmod-core&amp;type=fork&amp;count=true" height="20" width="90" frameborder="0" scrolling="0" style="height: 20px;" allowtransparency="true"></iframe>

              </p>


              <p>If you would like to add new quick fix is for an specific static code analysis rule (e.g PMD, CheckStyle, SonarQube),
                follow the next steps:</p>

                <ol>
                  <li>Go to our <a href="https://github.com/walkmod">GitHub</a> and look for the plugin, where you
                    want to contribute. For example, if you want to contribute to PMD, look for walkmod-pmd-plugin.
                  </li>
                  <li>For the repository and apply your contributions</li>
                  <li>Send us a pull request</li>
                </ol>

                <p>We also provide <b>professional services</b> to add more quick fixes to our tool.</p>
                <a href="https://github.com/walkmod" class="pull-right btn  btn-lg btn-primary">Go to WalkMod Plugins</a>


              </div>
              <div class="col-md-3 hidden-xs">
                <embed src="img/icons/svg/idea-1.svg" type="image/svg+xml" height="350"
                style="margin-top:40px;"></embed>
              </div>
            </div>
          </div>
  </section>
  <section id="workrecognition">
          <div class="title">
            <div class="container"><h1>Work recognition</h1></div>
          </div>

          <div class="container">
            <div class="row" >
              <div class="col-xs-12" style="text-align: center;">
                <embed src="img/oracle.svg" type="image/svg+xml" class="img-thumbnail"
                style="margin: 10px;" height="50"></embed>

                <embed src="img/devoxx.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/jbcnconf.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/dzone.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/thoughtworks.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/metricstream.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/arquillian.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/esadecreapolis.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/barcelonajug.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/voxxeddays.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>

                <embed src="img/hackernews.svg" type="image/svg+xml" class="img-thumbnail" height="50"
                style="margin: 10px;"></embed>
              </div>
            </div>

          </div>
  </section>
  <section id="contact">
          <div class="contact">
              <div class="container">
            If you want to contact us, send us an <a href="mailto:rpau@walkmod.com">email</a>
              </div>
          </div>
    </section>
    </div>
          <!-- /.container -->
          <footer>
            <div class="container">
              <div class="row">
                <div class="col-md-7 col-xs-12">
                <a class="footer-brand" href="http://walkmod.com" target="_blank"
                  style="font-family: ubuntu-titletitle; font-size: 30px;">WalkMod
                </a>
              </div> <!-- /col-xs-7 -->
            </div>
          </div>
        </footer>

        <!-- jQuery (necessary for Flat UI's JavaScript plugins) -->
        <script
        src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
        <script
        src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js"></script>

        <script src="js/bootstrap.min.js"></script>

        <script src="codemirror/lib/codemirror.js"></script>
        <script src="codemirror/addon/edit/matchbrackets.js"></script>
        <script src="codemirror/addon/hint/show-hint.js"></script>
        <script src="codemirror/mode/clike/clike.js"></script>
        <script src="js/codemirror.js"></script>
        <!-- Include all compiled plugins (below), or include individual files as needed -->
        <script src="js/vendor/video.js"></script>
        <script src="js/flat-ui.min.js"></script>

      </body>
      </html>