Merge pull request #12 from coolya/master

release 0.5

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "doc-src/themes/kube"]
+	path = doc-src/themes/kube
+	url = https://github.com/jeblister/kube.git

RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+### New in 0.5
+    * renamed plugin to durchblick
+
+### New in 0.4
+    * Support for MPS 2019.1
+
 ### New in 0.3
     * Support for MPS 2019.2
     * Redesigned editors based on Jos suggestions

build.gradle

@@ -34,7 +34,7 @@ ext.dependencyRepositories = [
         'https://projects.itemis.de/nexus/content/repositories/mbeddr',
 ]
 
-def version = "0.4"
+def version = "0.5"
 
 repositories {
     for (repoUrl in project.dependencyRepositories) {
@@ -107,7 +107,7 @@ def releaseArtifacts = new File(artifactsDir, "ws.logv.mps.generator.editors")
 
 github {
     owner = 'coolya'
-    repo = 'mps-generator-editors'
+    repo = 'Durchblick'
     token =  System.getenv().GITHUB_TOKEN != null ? System.getenv().GITHUB_TOKEN : "empty"
     tagName =  "v-$version"
     targetCommitish = System.getenv().CI_COMMIT_SHA != null ? System.getenv().CI_COMMIT_SHA : "master"

doc-src/archetypes/blog.md

@@ -0,0 +1,7 @@
++++
+title = ""
+description = ""
+date = {{ .Date }}
+weight = 20
+draft = false
++++

doc-src/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

doc-src/archetypes/docs.md

@@ -0,0 +1,9 @@
++++
+title = ""
+description = ""
+date = {{ .Date }}
+weight = 20
+draft = false
+bref = ""
+toc = true
++++

doc-src/config.toml

@@ -0,0 +1,18 @@
+baseURL = "https://coolya.github.io/Durchblick"
+languageCode = "en-us"
+title = "Durchblick"
+theme = "kube"
+description = "Durchblick is a plugin for JetBrains MPS that provides an alternate editor for generator templates."
+Paginate = 4
+publishDir = "../docs"
+[Params]
+  RSSLink = "/index.xml"
+  author = "Kolja Dummann" # add your company name
+  github = "coolya" # add your github profile name
+  twitter = "dimdidum" # add your twitter profile
+  email = "kolja.dummann@logv.ws"
+
+[[menu.main]]
+    name = "Faq"
+    weight = -100
+    url = "/faq/"

doc-src/content/_index.md

@@ -0,0 +1,6 @@
++++
+description = "Durchblick is a plugin for JetBrains MPS that provides an alternate editor for generator templates."
+title = "Durchblick for JetBrains MPS"
+draft = false
+
++++

doc-src/content/faq/_index.md

@@ -0,0 +1,21 @@
++++
+draft= false
+title = "FAQ"
+description = "Asked and answered"
++++
+
+## Why do you only inline macros if the contain a single expression?
+
+Inlining complex macros can be really confusing. Especially incase a macron contrains additional control flow constructs like `if` or `switch` statements inlining this will get really hard to understand given that the generator DSL has its own control flow concepts via `$IF$` and `$SWITCH` macros.
+
+## Why do you reward simple macros?
+
+Apart from the factors mentioned above, my experience over the past years of writing MPS generators is that keeping templates as simple as reasonable possible helps others to understand the templates easier and to help to maintain the templates in the futere. I wanted to give people an incentive to write simpler templates and think about putting complex query and logic into helper classes.
+
+If you are interested in more insights about writing maintainble generators I recommend you to take a look at the guide *towards maintainble generators* [here](https://coolya.github.io/maintainable-generators/).
+
+## Can I edit my macros when they are inlinded?
+
+Short answer: **Not really!**
+
+Long answer: While the editors are not read only you can try to edit them, but the editing experience might be really poor because especially keystrokes like `backspace` and `return` can result in very unexpected outcome. This is because macros in a generator template are technically node annotations and *Durchblick* inlines the content of the node annotation to inte editor of the node the macro is attached to. In this case the MPS (side) transformation system might get confused because the editor is overwritten with an editor hint. At the moment there is no easy way to controll transformations in the MPS based on the editor hints.

doc-src/layouts/index.html

@@ -0,0 +1,70 @@
+{{ define "title"}} {{ .Site.Title}} {{end}}
+{{ define "header"}} {{ partial "header" .}} {{end}}
+{{ define "main"}}
+
+<div id="main">
+  <div id="hero">
+    <img src="{{ "/img/glasses.svg" | relURL }}" width="164px" />
+    <h1>{{.Title}}</h1>
+    <p>{{.Description}}</p>
+  </div>
+  <div id="action-buttons">
+    <a class="button primary big" href="https://plugins.jetbrains.com/plugin/13073-simplified-mps-generator-editors/"
+      onclick="_gaq.push(['_trackEvent', 'kube', 'download']);">Download</a> <a class="button outline big"
+      href="https://github.com/coolya/Durchblick" onclick="_gaq.push(['_trackEvent', 'kube', 'github']);">View on
+      Github</a>
+    <p>You can also find it in the MPS plugin Marketplace by searching for
+      it from within <i>Plugins Settings</i> page.</p>
+  </div>
+  <div class="message focus" data-component="message"></span>
+    <i>Durchblick</i> is German for <mark>insight/transparency</mark>.
+  </div>
+  <div id="kube-features">
+    <div class="row gutters">
+      <div class="col col-4 item">
+        <figure>
+          <img alt="Baseline" height="64" src="{{ "/img/easy.svg" | relURL }}" width="64">
+        </figure>
+        <h3>Reasoning</h3>
+        <p>Durchblick aims to provide easier and faster reasoning about generator templates by inlining information that is usually hidden in the inspector.</p>
+      </div>
+      <div class="col col-4 item">
+        <figure>
+          <img alt="Typography" height="64" src="{{ "/img/download.svg" | relURL }}" width="64">
+        </figure>
+        <h3>Easy to Use</h3>
+        <p>No external dependencies. Installs directly from the plugin marketplace or via ZIP. Update are automatically handled by MPS.</p>
+      </div>
+      <div class="col col-4 item">
+        <figure>
+          <img alt="Minimalism" height="64" src="{{ "/img/award.svg" | relURL }}" width="64">
+        </figure>
+        <h3>Reward <i>Good</i> Templates</h3>
+        <p>Templates with little code in the macros are encouraged by inlining them into the main editor. Guding you to put complex logic into seperate classes outside of the generator template.</p>
+      </div>
+    </div>
+    <div class="row gutters">
+      <img id="before-after" src="before-after.gif" />
+    </div>
+    <div class="row gutters">
+      <div class="col col-4 item">
+        <h4>FAQ</h4>
+        <p>Got more questions? Visit the <a href="/faq/">FAQ</a> page.</p>
+      </div>
+      <div class="col col-4 item">
+        <h4>Contribute</h4>
+        <p><i>Durchblick</i> is open source. All contributions (code or none code) are highly welcome ❤️. Take a look at
+          the existing <a href="https://github.com/coolya/Durchblick/issues">issues</a>, create <a
+            href="https://github.com/coolya/Durchblick/issues/new">new ones</a> with your
+          idea/question or open a pull request.</p>
+      </div>
+      <div class="col col-4 item">
+        <h4>License</h4>
+        <p>Durchblick licensed under <a href="https://opensource.org/licenses/Apache-2.0">Apache License 2.0</a>.<br>
+      Durchblick is absolutely free for personal or commercial use.</p>
+    </div>
+  </div>
+</div>
+</div>
+{{ end }}
+{{ define "footer"}} {{ partial "footer" .}} {{end}}

doc-src/layouts/partials/favicon.html

@@ -0,0 +1,2 @@
+<link rel="shortcut icon" type="image/png"
+    href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDbSAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAKMklEQVR42u2cX2hb1x3Hzzm/c8/9o2vp6sqSHCMrRpFDMMYPow2lmDLmMIofwhhNHkIpJR5KHryAMYwRxt5GCH0IY2yhG6HdRgnBsFGyUErdZV1wwshC2UO2dIlpWicrXuOUxjaJK2ztIddGkc6V7r26V5LZ7wP3xZbO+X1/v6vz53f+EIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIJ0K6VSiSWTyWEhxHHO+TkAmAeARQBYp5RWKKUVAFh3/jbPOT8nhDhu2/a+TtseFNu29wXQO1wqlVinbfeMZVl7FUU5DQCfEkIqQR4AWFAU5ZRlWcVO6/Go9xQALLSg91NFUU4nEom9ndbjimmaL3DOLwUV6fZwzi+apvlcp/VJ9O7nnF+MQO8l0zRf6LS+bRKJRJ5zPhu2UInw88lksr/TepPJZD/n/Hwb9M4mEol8R8VqmnaUUroStdith1L6la7rRzqo91VK6Vdt1LuiadrRVmymQb6Uy+W0paWlN8vl8mvNPgsAf2eM/RkArquq+u/e3t7/HDhwYJUQQubm5szl5eX+J0+e7N3Y2Hh+c3PzOxsbG02bY0VRfp3P53+4sLDwTWsh80ahUBCLi4u/KJfLpQ7p/V02mz127969J5GLTafTNgBcIQ3ePMbYfSHEyVQqlfNbfiqVygkhTjLG7jeqAwA+2LVrVzxqvX19fXEA+LAL9M6n02k7UrFOcG8Q9yZlWVXVE4VCQWu1rkKhoKmqeoJSutxIdF9fnxmVXie4812k9+PIgpzL5bRGv1zO+axt25mw67VtO9NoEMc5f39oaEiEXW+xWBQA8EG36QWA+Vwu1/ILVYeiKL91qXRD07SpKCfrpVKJaZo2RQjZkNkghPh5BHp/2a16nViEh6ZprxN5E7VuGMZBL2XYtj0ohJjinF8AgJuMsRXGWIUxVhFCXLdte6JZGYZhHKSUrsts0XX9+2Hp1XX9lVb02rY9IYS4vqWPMbYCADc55xeEEFO2bQ96saOR3lZH19skEomcy1Roo5nYmZkZZhjGhNsgBQAuG4YxMTY25vnX4NRZljj/y1Qq1duq3lQqlaGUfhlEbzVjY2Nb2i+7aP/QMIyJmZmZhtob6F0JZZ7s1h84TYgrPT09wwDwkYu4edM0x4La5NQta7p+06peRVHOBdHbCNM0x9wGawDwUU9Pz3AQvU5sguOkzKQFN+qDNE07Til9TOrfuiVd149MTk621H+VSiXm8uJtxOPx4aDlxuPxESLp95rp9cLk5CTTNO0IpXRJ4pfHmqYdD6C30lJaU5ZbppQuu40ex8fHmRDiDJG/FOd7e3tDG+Lbtp2RTSk4579vQe87fvQGobe313ZLdQohzoyPj0tfpAZ6LwUyxLKsvTIjVFU94fYdWXCdtzOcAUENji219ZVTqVSf37JSqVQ/pbSur2uktxWcNG9dK+f40LNeQkjFiZU/FEU5VVsQY+z+nj17pHMwp4mpdfYXsVhsfxQOIuRpckCWARJC/MhvWUKIH/vRGwaxWGw/pfSL2nrdmms3vYqinPZduWx9UwhxUvbZnp6e4drhPGPsdjweH4zKOVs4NtUOXG5s/T+TyWRUVT3KOT/LOf8j53yWc/6GrusHq4MHAB971Rsm8Xh8kDF2mzz7w1h3G3i56F3wVamzq6KuKZDlWqenp1lthosx9ollWW1Z2nNsktn6Lc75W7Jmt8qRy0KIn2az2aJXvVFgWVY/Y+wT8mzQrkxPT9f1x256fe2EEULUNbcAcF32WcMwJsizwV1s9zqmY1tt8KRZINnDGPvaq96oSCQSecbYYrUNjm896XVi5o6u64cB4BpjTPrGu7Xz1RN5SumKaZoj7XQMIYQ4tnkKptcnUL/WIqZpjlQnlRzfetbLGCsDwDVd1w8/8wUnl9tQsKZpr9RW5KTcqtOF32u3UwghxLEt1ADL9LYDx4fVTe9gEL3b+Xkn2k0FJxKJ0dqKhBDbGRZFUVyH91FjWdZoI9sppUuKopzWNO1VZ8D1JqV0za/eduH4citQdRm0Znq3Hl3XDxMAuOblw4VCoS7Pyzm/QJ42DTfz+Xxk04lmOLa59a//kCUq4vH4XsbYZ370tot8Pq8xxm4SQiqOjz3rrX4A4Bpx63Nrn2PHjtWtuQLAvwghlVgs9mKnnEEIIaVSSbjY3TB1aZrmi370thPHpxXHx1711vXJnvOrlNZv36pUKjnO+dtra2tXO+kMAJD+nXP+h0ePHv3T7Xurq6tXOed/8qq3naytrV3lnL9dqVTqpmpuet2cE7iJBoDHyWSyLXPFRrg1WZqmNR301Q5qSBc00Vskk8kcY+yxV71E1kS3MsgyDOONTjuBEEIc22oHVuuFQqHpfq1isWjIcsKdHGRVI/OxTK/s2Z4uBZ0mjYyMRL6r0QuyaYOTXfOEbO9Vp6ZJtch87GuatEV1okOW3uvExN8rsom/oig/8/H9n+x0vZTSDddERy2qqv6A1P8i/tZpYW44tj1jr2EY3/X6/Vgs9tJO1+vEzBu2bUvXgtuVfPeDLPlOKV0vFoue90uPjIxossTHTtFLnma8/K0JA8BtUt+uR7585heX5bP3/ZYDAHW7V3aQ3tu+C3L6sNqJ8/0wdvGHhdsCuKqqTc8Q1SLrlnaKXj/jjW2cw9d1TUFUW1iCoKpq3W5DSulaNpu1/JbV19dnyZrpbtdLCKkEPigvO+Ac9ia0oDTYhHY2aJmKopzdgXovBi7UNM39RPLGhLGNtBXctpFSStctyxoMWq5lWYOykwTdqpcQUnFiFJytFaPap5WN4K3SYON7y0uW1Ut13a5XttLkG8uycpTSui0txOdRjrBwO8rBGLufyWR89721ZDKZuMtZ3a7SSyn92rKscKZxmqa9JhHs6/BZWGIbHD57OcR6Xu52vc6BwPBQFOUtWUWkC45TCiFCTys6ZXalXicW4TIwMNCtB8Avjo6O8rDrHR0d5Zzzd7tNLwBcGRgYiGZunk6nLQ9XOEyFeKXBVJMrDS739/cbkYglhORyOcPt+GeH9N5Ip9MtjzMa4gS545ewcM7fy2QykQV3i2w2a3DO3+u0XgC4EiS4Hb9G6cGDB/3r6+t+rxX61e7du6fv3LnTlmuUhoaG+N27d8+Uy+WmU6WI9LbvGqVqNE173WUKFcnjXIR22Kt9YaPr+uFGTWgEeldCHy37pY1XGb6TTCZ9HwsNm2Qy2Sc7RxyB3tlEItE9y5URXkb6bpdeRvpco1F2C3q76zLSWv4PrxMuhnWdcKCD3E2IbPPvoUOH2Nzc3L61tbWXNjc3n69UKvsIIXlCSGZzc1MQQghj7BtCyH8JIZ9TSm8xxq6bpvmXhw8f3orKriixbXvf6urqt33q/ev4+Pit2dnZzU7bjyAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgiAIgkj5H3vlX0CE9GKhAAAAAElFTkSuQmCC">

doc-src/layouts/partials/footer.html

@@ -0,0 +1,11 @@
+  <footer id="footer">
+    <nav>
+      <ul>
+        <li><span>Durchblick</span></li>
+        <li>
+          <a href="https://twitter.com/{{.Site.Params.twitter}}">Give a shout-out on Twitter!</a>
+        </li>
+      </ul>
+    </nav>
+    <p>&copy; Apache License 2.0.</p>
+  </footer>

doc-src/static/css/custom.css

@@ -0,0 +1,21 @@
+.message {
+    text-align: center;
+}
+
+#before-after {
+    width: 75%;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+@media (max-width:768px) {
+    #before-after {
+        width: 100%;
+    }
+}
+
+#kube-features .row:nth-child(2) {
+    padding-bottom: 32px;
+    margin-bottom: 64px;
+    border-bottom: 1px dashed rgba(0, 0, 0, 0.15);
+}