reitit/development.html

917 lines
23 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Development Instructions · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-hints/plugin-hints.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="faq.html" />
<link rel="prev" href="performance.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Introduction</li>
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="header">Basics</li>
<li class="chapter " data-level="2.1" data-path="basics/route_syntax.html">
<a href="basics/route_syntax.html">
Route Syntax
</a>
</li>
<li class="chapter " data-level="2.2" data-path="basics/router.html">
<a href="basics/router.html">
Router
</a>
</li>
<li class="chapter " data-level="2.3" data-path="basics/path_based_routing.html">
<a href="basics/path_based_routing.html">
Path-based Routing
</a>
</li>
<li class="chapter " data-level="2.4" data-path="basics/name_based_routing.html">
<a href="basics/name_based_routing.html">
Name-based Routing
</a>
</li>
<li class="chapter " data-level="2.5" data-path="basics/route_data.html">
<a href="basics/route_data.html">
Route Data
</a>
</li>
<li class="chapter " data-level="2.6" data-path="basics/route_data_validation.html">
<a href="basics/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="2.7" data-path="basics/route_conflicts.html">
<a href="basics/route_conflicts.html">
Route Conflicts
</a>
</li>
<li class="chapter " data-level="2.8" data-path="basics/error_messages.html">
<a href="basics/error_messages.html">
Error Messages
</a>
</li>
<li class="header">Coercion</li>
<li class="chapter " data-level="3.1" data-path="coercion/coercion.html">
<a href="coercion/coercion.html">
Coercion Explained
</a>
</li>
<li class="chapter " data-level="3.2" data-path="coercion/schema_coercion.html">
<a href="coercion/schema_coercion.html">
Plumatic Schema
</a>
</li>
<li class="chapter " data-level="3.3" data-path="coercion/clojure_spec_coercion.html">
<a href="coercion/clojure_spec_coercion.html">
Clojure.spec
</a>
</li>
<li class="chapter " data-level="3.4" data-path="coercion/data_spec_coercion.html">
<a href="coercion/data_spec_coercion.html">
Data-specs
</a>
</li>
<li class="header">Ring</li>
<li class="chapter " data-level="4.1" data-path="ring/ring.html">
<a href="ring/ring.html">
Ring-router
</a>
</li>
<li class="chapter " data-level="4.2" data-path="ring/reverse_routing.html">
<a href="ring/reverse_routing.html">
Reverse-routing
</a>
</li>
<li class="chapter " data-level="4.3" data-path="ring/default_handler.html">
<a href="ring/default_handler.html">
Default handler
</a>
</li>
<li class="chapter " data-level="4.4" data-path="ring/slash_handler.html">
<a href="ring/slash_handler.html">
Slash handler
</a>
</li>
<li class="chapter " data-level="4.5" data-path="ring/static.html">
<a href="ring/static.html">
Static Resources
</a>
</li>
<li class="chapter " data-level="4.6" data-path="ring/dynamic_extensions.html">
<a href="ring/dynamic_extensions.html">
Dynamic Extensions
</a>
</li>
<li class="chapter " data-level="4.7" data-path="ring/data_driven_middleware.html">
<a href="ring/data_driven_middleware.html">
Data-driven Middleware
</a>
</li>
<li class="chapter " data-level="4.8" data-path="ring/transforming_middleware_chain.html">
<a href="ring/transforming_middleware_chain.html">
Transforming Middleware Chain
</a>
</li>
<li class="chapter " data-level="4.9" data-path="ring/middleware_registry.html">
<a href="ring/middleware_registry.html">
Middleware Registry
</a>
</li>
<li class="chapter " data-level="4.10" data-path="ring/exceptions.html">
<a href="ring/exceptions.html">
Exception Handling with Ring
</a>
</li>
<li class="chapter " data-level="4.11" data-path="ring/default_middleware.html">
<a href="ring/default_middleware.html">
Default Middleware
</a>
</li>
<li class="chapter " data-level="4.12" data-path="ring/content_negotiation.html">
<a href="ring/content_negotiation.html">
Content Negotiation
</a>
</li>
<li class="chapter " data-level="4.13" data-path="ring/coercion.html">
<a href="ring/coercion.html">
Pluggable Coercion
</a>
</li>
<li class="chapter " data-level="4.14" data-path="ring/route_data_validation.html">
<a href="ring/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="4.15" data-path="ring/compiling_middleware.html">
<a href="ring/compiling_middleware.html">
Compiling Middleware
</a>
</li>
<li class="chapter " data-level="4.16" data-path="ring/swagger.html">
<a href="ring/swagger.html">
Swagger Support
</a>
</li>
<li class="chapter " data-level="4.17" data-path="ring/RESTful_form_methods.html">
<a href="ring/RESTful_form_methods.html">
RESTful form methods
</a>
</li>
<li class="header">HTTP</li>
<li class="chapter " data-level="5.1" data-path="http/interceptors.html">
<a href="http/interceptors.html">
Interceptors
</a>
</li>
<li class="chapter " data-level="5.2" data-path="http/pedestal.html">
<a href="http/pedestal.html">
Pedestal
</a>
</li>
<li class="chapter " data-level="5.3" data-path="http/sieppari.html">
<a href="http/sieppari.html">
Sieppari
</a>
</li>
<li class="chapter " data-level="5.4" data-path="http/default_interceptors.html">
<a href="http/default_interceptors.html">
Default Interceptors
</a>
</li>
<li class="chapter " data-level="5.5" data-path="http/transforming_interceptor_chain.html">
<a href="http/transforming_interceptor_chain.html">
Transforming Interceptor Chain
</a>
</li>
<li class="header">Frontend</li>
<li class="chapter " data-level="6.1" data-path="frontend/basics.html">
<a href="frontend/basics.html">
Basics
</a>
</li>
<li class="chapter " data-level="6.2" data-path="frontend/browser.html">
<a href="frontend/browser.html">
Browser integration
</a>
</li>
<li class="chapter " data-level="6.3" data-path="frontend/controllers.html">
<a href="frontend/controllers.html">
Controllers
</a>
</li>
<li class="header">Advanced</li>
<li class="chapter " data-level="7.1" data-path="advanced/configuring_routers.html">
<a href="advanced/configuring_routers.html">
Configuring Routers
</a>
</li>
<li class="chapter " data-level="7.2" data-path="advanced/composing_routers.html">
<a href="advanced/composing_routers.html">
Composing Routers
</a>
</li>
<li class="chapter " data-level="7.3" data-path="advanced/different_routers.html">
<a href="advanced/different_routers.html">
Different Routers
</a>
</li>
<li class="chapter " data-level="7.4" data-path="advanced/route_validation.html">
<a href="advanced/route_validation.html">
Route Validation
</a>
</li>
<li class="chapter " data-level="7.5" data-path="advanced/dev_workflow.html">
<a href="advanced/dev_workflow.html">
Dev Workflow
</a>
</li>
<li class="chapter " data-level="7.6" data-path="advanced/shared_routes.html">
<a href="advanced/shared_routes.html">
Shared Routes
</a>
</li>
<li class="header">Misc</li>
<li class="chapter " data-level="8.1" data-path="performance.html">
<a href="performance.html">
Performance
</a>
</li>
<li class="chapter active" data-level="8.2" data-path="development.html">
<a href="development.html">
Development Instructions
</a>
</li>
<li class="chapter " data-level="8.3" data-path="faq.html">
<a href="faq.html">
FAQ
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Development Instructions</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="development-instructions">Development Instructions</h1>
<h2 id="building">Building</h2>
<pre><code class="lang-bash">./scripts/lein-modules <span class="hljs-keyword">do</span> clean, install
</code></pre>
<h2 id="running-tests">Running tests</h2>
<pre><code class="lang-bash">./scripts/test.sh clj
./scripts/test.sh cljs
</code></pre>
<h2 id="documentation">Documentation</h2>
<p>The documentation is built with <a href="https://toolchain.gitbook.com" target="_blank">gitbook</a>. To preview your changes locally:</p>
<pre><code class="lang-bash">npm install -g gitbook-cli
gitbook install
gitbook serve
</code></pre>
<h2 id="to-bump-up-version">To bump up version:</h2>
<p>We use <a href="https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md" target="_blank">Break Versioning</a>. Remember our promise: patch-level bumps never include breaking changes!</p>
<pre><code class="lang-bash"><span class="hljs-comment"># new version</span>
./scripts/<span class="hljs-built_in">set</span>-version <span class="hljs-string">&quot;1.0.0&quot;</span>
./scripts/lein-modules install
<span class="hljs-comment"># works</span>
lein <span class="hljs-built_in">test</span>
<span class="hljs-comment"># deploy to clojars</span>
./scripts/lein-modules <span class="hljs-keyword">do</span> clean, deploy clojars
</code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="performance.html" class="navigation navigation-prev " aria-label="Previous page: Performance">
<i class="fa fa-angle-left"></i>
</a>
<a href="faq.html" class="navigation navigation-next " aria-label="Next page: FAQ">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
2020-07-28 09:53:17 +00:00
gitbook.page.hasChanged({"page":{"title":"Development Instructions","level":"8.2","depth":1,"next":{"title":"FAQ","level":"8.3","depth":1,"path":"faq.md","ref":"faq.md","articles":[]},"previous":{"title":"Performance","level":"8.1","depth":1,"path":"performance.md","ref":"performance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["hints","editlink","github","highlight"],"root":"doc","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/metosin/reitit"},"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"*"},"file":{"path":"development.md","mtime":"2020-01-14T13:47:50.978Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-07-28T09:52:25.779Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-editlink/plugin.js"></script>
<script src="gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>