Skip to content

Commit

Permalink
Deployed 21f50baac9 to dev-2.x in en with MkDocs 1.5.3 and mike 1.2.0…
Browse files Browse the repository at this point in the history 
….dev0
  • Loading branch information
OTP Bot committed May 14, 2024
1 parent cbfb78b commit 62a7f5a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 29 deletions.
3 changes: 2 additions & 1 deletion en/dev-2.x/Changelog/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2368,7 +2368,8 @@ <h2 id="260-snapshot-under-development">2.6.0-SNAPSHOT (under development)</h2>
<li>Fix trip duplication in Graph Builder DSJ mapping <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5794">#5794</a></li>
<li>Optionally abort startup when unknown configuration parameters were detected <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5676">#5676</a></li>
<li>Fix bug in heuristics cost calculation for egress legs <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5783">#5783</a></li>
<li>Fix handling of implicit access and egress mode parameters. <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5821">#5821</a>
<li>Fix handling of implicit access and egress mode parameters. <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5821">#5821</a></li>
<li>Add prettier:write to docs and rephrase slightly [ci skip] <a href="https://github.com/opentripplanner/OpenTripPlanner/pull/5831">#5831</a>
<a href="AUTOMATIC_CHANGELOG_PLACEHOLDER_DO_NOT_REMOVE"></a></li>
</ul>
<h2 id="250-2024-03-13">2.5.0 (2024-03-13)</h2>
Expand Down
57 changes: 30 additions & 27 deletions en/dev-2.x/Codestyle/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1375,9 +1375,9 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#how-to-run-prittier-with-maven" class="md-nav__link">
<a href="#how-to-run-prettier-with-maven" class="md-nav__link">
<span class="md-ellipsis">
How to run Prittier with Maven
How to run Prettier with Maven
</span>
</a>

Expand Down Expand Up @@ -2063,15 +2063,18 @@ <h2 id="java">Java</h2>
it takes a bit of time, but reformat the entire codebase. Only code you have changed should be
formatted, since the existing code is already formatted. The second way is to set up prettier and
run it manually or hick it into your IDE, so it runs every time a file is changed.</p>
<h3 id="how-to-run-prittier-with-maven">How to run Prittier with Maven</h3>
<p>Format all code is done in the validate phase (run before test, package, install)</p>
<h3 id="how-to-run-prettier-with-maven">How to run Prettier with Maven</h3>
<p>Prettier will automatically format all code in the Maven "validate" phase, which runs before the test, package, and install phases. So formatting will happen for example when you run:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>% mvn test
</code></pre></div>
<p>You can manually run <em>only</em> the formatting process with:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>% mvn prettier:write
</code></pre></div>
<p>To skip the prettier formating use profile <code>prettierSkip</code>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>% mvn test -P prettierSkip
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>% mvn test -P prettierSkip
</code></pre></div>
<p>The check for formatting errors use profile <code>prettierCheck</code>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>% mvn test -P prettierSkip
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>% mvn test -P prettierCheck
</code></pre></div>
<p>The check is run by the CI server and will fail the build if the code is incorrectly formatted.</p>
<h3 id="intellj-and-code-style-formatting">IntellJ and Code Style Formatting</h3>
Expand All @@ -2085,10 +2088,10 @@ <h4 id="run-prettier-maven-plugin-as-an-external-tool-in-intellij">Run Prettier
<p>You can run the Prettier Maven plugin as an external tool in IntelliJ. Set it up as an
<code>External tool</code> and assign a key-shortcut to the tool execution.</p>
<p><img alt="External Tool Dialog" src="../images/ExternalToolDialog.png" /></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>Name: Prettier Format Current File
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>Program: mvn
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>Arguments: prettier:write -Dprettier.inputGlobs=$FilePathRelativeToProjectRoot$
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>Working Directory: $ProjectFileDir$
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>Name: Prettier Format Current File
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>Program: mvn
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>Arguments: prettier:write -Dprettier.inputGlobs=$FilePathRelativeToProjectRoot$
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>Working Directory: $ProjectFileDir$
</code></pre></div>
<blockquote>
<p><strong>Tip!</strong> Add a unused key shortcut to execute the external tool, then you can use the old
Expand All @@ -2108,12 +2111,12 @@ <h5 id="configure-file-watcher">Configure File Watcher</h5>
ways to set it up. Below is hwo to configure it using Maven to run the formatter. The Maven way work
without any installation of other components, but might be a bit slow. So, you might want to install
<a href="https://github.com/jhipster/prettier-java/">prettier-java</a> in your shell and run it instead.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>Name: Format files with Prettier
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>File type: Java
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>Scope: Project Files
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>Program: mvn
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>Arguments: prettier:write -Dprettier.inputGlobs=$FilePathRelativeToProjectRoot$
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>Working Directory: $ProjectFileDir$
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>Name: Format files with Prettier
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>File type: Java
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>Scope: Project Files
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>Program: mvn
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>Arguments: prettier:write -Dprettier.inputGlobs=$FilePathRelativeToProjectRoot$
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>Working Directory: $ProjectFileDir$
</code></pre></div>
<h3 id="other-ides">Other IDEs</h3>
<p>We do not have support for other IDEs at the moment. If you use another editor and make one please
Expand Down Expand Up @@ -2193,17 +2196,17 @@ <h2 id="javascript">JavaScript</h2>
<li>Include the namespace definition in each and every file: <code>otp.namespace("otp.configure");</code></li>
<li>Include a class comment. For example,</li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="cm">/**</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="cm"> * Configure Class</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="cm"> *</span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="cm"> * Purpose is to allow a generic configuration object to be read via AJAX/JSON, and inserted into an</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="cm"> * Ext Store</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="cm"> * The implementation is TriMet route map specific...but replacing ConfigureStore object (or member</span>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="cm"> * variables) with another implementation, will give this widget flexibility for other uses beyond</span>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="cm"> * the iMap.</span>
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="cm"> *</span>
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a><span class="cm"> * @class</span>
<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a><span class="cm"> */</span>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="cm">/**</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="cm"> * Configure Class</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="cm"> *</span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="cm"> * Purpose is to allow a generic configuration object to be read via AJAX/JSON, and inserted into an</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="cm"> * Ext Store</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="cm"> * The implementation is TriMet route map specific...but replacing ConfigureStore object (or member</span>
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="cm"> * variables) with another implementation, will give this widget flexibility for other uses beyond</span>
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="cm"> * the iMap.</span>
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="cm"> *</span>
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a><span class="cm"> * @class</span>
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="cm"> */</span>
</code></pre></div>
<blockquote>
<p><strong>Note:</strong> There is still a lot of code following other style conventions, but please adhere to
Expand Down
2 changes: 1 addition & 1 deletion en/dev-2.x/search/search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit 62a7f5a

Please sign in to comment.