publish: docs: Updated HACKING.md

generated from commit f2decf955b
2024-11-25 02:54:04 +03:00 · 2017-10-21 15:58:38 +02:00 · 2017-10-21 15:58:38 +02:00 · 0fffdf0387
commit 0fffdf0387
parent 6b6e5083af
10 changed files with 238 additions and 29 deletions
--- a/HACKING.md
+++ b/HACKING.md
@ -1,17 +1,44 @@
 # Hacking Material Design for Bootstrap

-This project makes use of Gulp to build all our source codes.
+This project makes use Rollup and node-sass to build its assets.

-You can get a full list of available commands running:
+To watch all the files and get the compiled ones in the `dist/` folder, just run:

 ```
-npm run gulp -- --tasks
+npm run watch
 ```

-Then, simply run:
+You can also watch CSS or JS individually running:

 ```
-npm run gulp dist:default // or any other task name
+npm run watch:css
+# or
+npm run watch:js
 ```

 To trigger the relative task and run it.
+
+If you desire to compile the project for production, genering also the minified versions of it, run:
+
+```
+npm run build
+```
+
+Or if you prefer to compile only CSS or JS individually without minification:
+
+```
+npm run build:css
+# or
+npm run build:js
+```
+
+If you desire them to be minified, instead, run:
+
+
+```
+npm run build:css-min
+# or
+npm run build:js-min
+```
+
+To compile and minify the files.
--- a/dist/js/bootstrap-material-design.js
+++ b/dist/js/bootstrap-material-design.js
@ -163,7 +163,118 @@ var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol



+var asyncGenerator = function () {
+  function AwaitValue(value) {
+    this.value = value;
+  }

+  function AsyncGenerator(gen) {
+    var front, back;
+
+    function send(key, arg) {
+      return new Promise(function (resolve, reject) {
+        var request = {
+          key: key,
+          arg: arg,
+          resolve: resolve,
+          reject: reject,
+          next: null
+        };
+
+        if (back) {
+          back = back.next = request;
+        } else {
+          front = back = request;
+          resume(key, arg);
+        }
+      });
+    }
+
+    function resume(key, arg) {
+      try {
+        var result = gen[key](arg);
+        var value = result.value;
+
+        if (value instanceof AwaitValue) {
+          Promise.resolve(value.value).then(function (arg) {
+            resume("next", arg);
+          }, function (arg) {
+            resume("throw", arg);
+          });
+        } else {
+          settle(result.done ? "return" : "normal", result.value);
+        }
+      } catch (err) {
+        settle("throw", err);
+      }
+    }
+
+    function settle(type, value) {
+      switch (type) {
+        case "return":
+          front.resolve({
+            value: value,
+            done: true
+          });
+          break;
+
+        case "throw":
+          front.reject(value);
+          break;
+
+        default:
+          front.resolve({
+            value: value,
+            done: false
+          });
+          break;
+      }
+
+      front = front.next;
+
+      if (front) {
+        resume(front.key, front.arg);
+      } else {
+        back = null;
+      }
+    }
+
+    this._invoke = send;
+
+    if (typeof gen.return !== "function") {
+      this.return = undefined;
+    }
+  }
+
+  if (typeof Symbol === "function" && Symbol.asyncIterator) {
+    AsyncGenerator.prototype[Symbol.asyncIterator] = function () {
+      return this;
+    };
+  }
+
+  AsyncGenerator.prototype.next = function (arg) {
+    return this._invoke("next", arg);
+  };
+
+  AsyncGenerator.prototype.throw = function (arg) {
+    return this._invoke("throw", arg);
+  };
+
+  AsyncGenerator.prototype.return = function (arg) {
+    return this._invoke("return", arg);
+  };
+
+  return {
+    wrap: function (fn) {
+      return function () {
+        return new AsyncGenerator(fn.apply(this, arguments));
+      };
+    },
+    await: function (value) {
+      return new AwaitValue(value);
+    }
+  };
+}();



--- a/dist/js/bootstrap-material-design.js.map
+++ b/dist/js/bootstrap-material-design.js.map
--- a/dist/js/bootstrap-material-design.min.js
+++ b/dist/js/bootstrap-material-design.min.js
--- a/docs/4.0/examples/index.html
+++ b/docs/4.0/examples/index.html
@ -313,7 +313,7 @@
      <li><a href="/bootstrap-material-design/about/">About</a></li>
    </ul>
    <p>Designed and built by <a href="https://twitter.com/FezVrasta" target="_blank" rel="noopener">@FezVrasta</a> with the help of <a href="https://github.com/FezVrasta/bootstrap-material-design/graphs/contributors">our contributors</a>.</p>
-    <p>Currently v4.0.0-beta.3. Code licensed <a rel="license noopener" href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>, docs <a rel="license noopener" href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY 3.0</a>.</p>
+    <p>Currently v4.0.0-beta.4. Code licensed <a rel="license noopener" href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>, docs <a rel="license noopener" href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY 3.0</a>.</p>
  </div>
 </footer>

--- a/docs/4.0/getting-started/download/index.html
+++ b/docs/4.0/getting-started/download/index.html
@ -1198,7 +1198,7 @@

          <h2 id="compiled-css-and-js">Compiled CSS and JS</h2>

-<p>Download ready-to-use compiled code for <strong>Bootstrap v4.0.0-beta.3</strong> to easily drop into your project, which includes:</p>
+<p>Download ready-to-use compiled code for <strong>Bootstrap v4.0.0-beta.4</strong> to easily drop into your project, which includes:</p>

 <ul>
  <li>Compiled and minified CSS bundles (default, grid-only, and Reboot-only)</li>
@ -1242,7 +1242,7 @@

 <p>Install Bootstrap in your Node powered apps with <a href="https://www.npmjs.com/package/bootstrap">the npm package</a>:</p>

-<figure class="highlight"><pre><code class="language-bash" data-lang="bash">npm install bootstrap-material-design@4.0.0-beta.3</code></pre></figure>
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash">npm install bootstrap-material-design@4.0.0-beta.4</code></pre></figure>

 <p><code class="highlighter-rouge">require('bootstrap')</code> will load all of Bootstrap’s jQuery plugins onto the jQuery object. The <code class="highlighter-rouge">bootstrap</code> module itself does not export anything. You can manually load Bootstrap’s jQuery plugins individually by loading the <code class="highlighter-rouge">/js/*.js</code> files under the package’s top-level directory.</p>

@ -1269,13 +1269,13 @@

 <p>You can also install and manage Bootstrap’s Sass and JavaScript using <a href="https://getcomposer.org">Composer</a>:</p>

-<figure class="highlight"><pre><code class="language-bash" data-lang="bash">composer require twbs/bootstrap:4.0.0-beta.3</code></pre></figure>
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash">composer require twbs/bootstrap:4.0.0-beta.4</code></pre></figure>

 <h3 id="bower">Bower</h3>

 <p>Install and manage Bootstrap’s Sass and JavaScript using <a href="https://bower.io">Bower</a>.</p>

-<figure class="highlight"><pre><code class="language-bash" data-lang="bash">bower install bootstrap-material-design#v4.0.0-beta.3</code></pre></figure>
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash">bower install bootstrap-material-design#v4.0.0-beta.4</code></pre></figure>

 <h3 id="nuget">NuGet</h3>

--- a/docs/4.0/getting-started/javascript/index.html
+++ b/docs/4.0/getting-started/javascript/index.html
@ -1210,7 +1210,7 @@

 <h2 id="dependencies">Dependencies</h2>

-<p>Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that <strong>all plugins depend on jQuery</strong> (this means jQuery must be included <strong>before</strong> the plugin files). <a href="https://github.com/FezVrasta/bootstrap-material-design/blob/v4.0.0-beta.3/bower.json">Consult our <code class="highlighter-rouge">bower.json</code></a> to see which versions of jQuery are supported.</p>
+<p>Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that <strong>all plugins depend on jQuery</strong> (this means jQuery must be included <strong>before</strong> the plugin files). <a href="https://github.com/FezVrasta/bootstrap-material-design/blob/v4.0.0-beta.4/bower.json">Consult our <code class="highlighter-rouge">bower.json</code></a> to see which versions of jQuery are supported.</p>

 <p>Our tooltips and popovers also depend on <a href="https://github.com/FezVrasta/popper.js">Popper.js</a>.</p>

@ -1285,7 +1285,7 @@

 <p>The version of each of Bootstrap’s jQuery plugins can be accessed via the <code class="highlighter-rouge">VERSION</code> property of the plugin’s constructor. For example, for the tooltip plugin:</p>

-<figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">tooltip</span><span class="p">.</span><span class="nx">Constructor</span><span class="p">.</span><span class="nx">VERSION</span> <span class="c1">// =&gt; "4.0.0-beta.3"</span></code></pre></figure>
+<figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">tooltip</span><span class="p">.</span><span class="nx">Constructor</span><span class="p">.</span><span class="nx">VERSION</span> <span class="c1">// =&gt; "4.0.0-beta.4"</span></code></pre></figure>

 <h2 id="no-special-fallbacks-when-javascript-is-disabled">No special fallbacks when JavaScript is disabled</h2>

--- a/index.html
+++ b/index.html
@ -152,10 +152,10 @@
        </p>
        <div class="d-flex flex-column flex-md-row lead mb-3">
          <a href="/bootstrap-material-design/docs/4.0/getting-started/" class="btn btn-lg btn-primary" onclick="ga('send', 'event', 'Jumbotron actions', 'Get started', 'Get started');">Get started</a>
-          <a href="/bootstrap-material-design/docs/4.0/getting-started/download/" class="btn btn-lg btn-secondary" onclick="ga('send', 'event', 'Jumbotron actions', 'Download', 'Download 4.0.0-beta.3');">Download</a>
+          <a href="/bootstrap-material-design/docs/4.0/getting-started/download/" class="btn btn-lg btn-secondary" onclick="ga('send', 'event', 'Jumbotron actions', 'Download', 'Download 4.0.0-beta.4');">Download</a>
        </div>
        <p class="text-muted mb-0">
-          Currently v4.0.0-beta.3
+          Currently v4.0.0-beta.4
        </p>
      </div>
    </div>
@ -172,11 +172,11 @@
    <h3>Installation</h3>
    <p>Include Bootstrap's source Sass and JavaScript files via Bower, Composer, Meteor, or npm. Package managed installs don't include documentation, but do include our build system and readme.</p>

-<figure class="highlight"><pre><code class="language-sh" data-lang="sh">npm install bootstrap-material-design@4.0.0-beta.3</code></pre></figure>
+<figure class="highlight"><pre><code class="language-sh" data-lang="sh">npm install bootstrap-material-design@4.0.0-beta.4</code></pre></figure>

 <figure class="highlight"><pre><code class="language-sh" data-lang="sh">gem install bootstrap-material-design -v 4.0.0.beta</code></pre></figure>

-<figure class="highlight"><pre><code class="language-sh" data-lang="sh">bower install bootstrap-material-design#v4.0.0-beta.3</code></pre></figure>
+<figure class="highlight"><pre><code class="language-sh" data-lang="sh">bower install bootstrap-material-design#v4.0.0-beta.4</code></pre></figure>
    <hr class="half-rule">
    <a class="btn btn-outline-primary" href="/bootstrap-material-design/docs/4.0/getting-started/download">Read installation docs</a>
  </div>
@ -237,7 +237,7 @@
      <li><a href="/bootstrap-material-design/about/">About</a></li>
    </ul>
    <p>Designed and built by <a href="https://twitter.com/FezVrasta" target="_blank" rel="noopener">@FezVrasta</a> with the help of <a href="https://github.com/FezVrasta/bootstrap-material-design/graphs/contributors">our contributors</a>.</p>
-    <p>Currently v4.0.0-beta.3. Code licensed <a rel="license noopener" href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>, docs <a rel="license noopener" href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY 3.0</a>.</p>
+    <p>Currently v4.0.0-beta.4. Code licensed <a rel="license noopener" href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>, docs <a rel="license noopener" href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY 3.0</a>.</p>
  </div>
 </footer>

--- a/rollup.config.js
+++ b/rollup.config.js
@ -4,7 +4,9 @@ import babel from 'rollup-plugin-babel';
 const babelOptions = JSON.parse(fs.readFileSync('./.babelrc'));

 export default {
-  format: 'iife',
+  output: {
+    format: 'iife',
+  },
  plugins: [
    babel(Object.assign(babelOptions, { babelrc: false })),
  ],
--- a/yarn.lock
+++ b/yarn.lock
@ -21,10 +21,18 @@ amdefine@>=0.0.4:
  version "1.0.1"
  resolved "https://registry.yarnpkg.com/amdefine/-/amdefine-1.0.1.tgz#4a5282ac164729e93619bcfd3ad151f817ce91f5"

+ansi-regex@^0.2.0, ansi-regex@^0.2.1:
+  version "0.2.1"
+  resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-0.2.1.tgz#0d8e946967a3d8143f93e24e298525fc1b2235f9"
+
 ansi-regex@^2.0.0:
  version "2.1.1"
  resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df"

+ansi-styles@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-1.1.0.tgz#eaecbf66cd706882760b2f4691582b8f55d7a7de"
+
 ansi-styles@^2.2.1:
  version "2.2.1"
  resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe"
@ -761,6 +769,16 @@ caseless@~0.12.0:
  version "0.12.0"
  resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"

+chalk@0.5.1:
+  version "0.5.1"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-0.5.1.tgz#663b3a648b68b55d04690d49167aa837858f2174"
+  dependencies:
+    ansi-styles "^1.1.0"
+    escape-string-regexp "^1.0.0"
+    has-ansi "^0.1.0"
+    strip-ansi "^0.3.0"
+    supports-color "^0.2.0"
+
 chalk@^1.1.0, chalk@^1.1.1, chalk@^1.1.3:
  version "1.1.3"
  resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98"
@ -845,10 +863,27 @@ combined-stream@^1.0.5, combined-stream@~1.0.5:
  dependencies:
    delayed-stream "~1.0.0"

+commander@2.6.0:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.6.0.tgz#9df7e52fb2a0cb0fb89058ee80c3104225f37e1d"
+
 concat-map@0.0.1:
  version "0.0.1"
  resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"

+concurrently@^3.5.0:
+  version "3.5.0"
+  resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-3.5.0.tgz#8cf1b7707a6916a78a4ff5b77bb04dec54b379b2"
+  dependencies:
+    chalk "0.5.1"
+    commander "2.6.0"
+    date-fns "^1.23.0"
+    lodash "^4.5.1"
+    rx "2.3.24"
+    spawn-command "^0.0.2-1"
+    supports-color "^3.2.3"
+    tree-kill "^1.1.0"
+
 console-control-strings@^1.0.0, console-control-strings@~1.1.0:
  version "1.1.0"
  resolved "https://registry.yarnpkg.com/console-control-strings/-/console-control-strings-1.1.0.tgz#3d7cf4464db6446ea644bf4b39507f9851008e8e"
@ -947,6 +982,10 @@ dashdash@^1.12.0:
  dependencies:
    assert-plus "^1.0.0"

+date-fns@^1.23.0:
+  version "1.29.0"
+  resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-1.29.0.tgz#12e609cdcb935127311d04d33334e2960a2a54e6"
+
 debug@^2.1.1, debug@^2.2.0:
  version "2.6.8"
  resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.8.tgz#e731531ca2ede27d188222427da17821d68ff4fc"
@ -1016,7 +1055,7 @@ es-to-primitive@^1.1.1:
    is-date-object "^1.0.1"
    is-symbol "^1.0.1"

-escape-string-regexp@^1.0.2:
+escape-string-regexp@^1.0.0, escape-string-regexp@^1.0.2:
  version "1.0.5"
  resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"

@ -1171,6 +1210,12 @@ har-validator@~4.2.1:
    ajv "^4.9.1"
    har-schema "^1.0.5"

+has-ansi@^0.1.0:
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-0.1.0.tgz#84f265aae8c0e6a88a12d7022894b7568894c62e"
+  dependencies:
+    ansi-regex "^0.2.0"
+
 has-ansi@^2.0.0:
  version "2.0.0"
  resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91"
@ -1442,7 +1487,7 @@ lodash.uniq@^4.5.0:
  version "4.5.0"
  resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773"

-lodash@^4.0.0, lodash@^4.2.0, lodash@~4.17.4:
+lodash@^4.0.0, lodash@^4.2.0, lodash@^4.5.1, lodash@~4.17.4:
  version "4.17.4"
  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"

@ -2113,11 +2158,13 @@ rollup-pluginutils@^1.5.0:
    estree-walker "^0.2.1"
    minimatch "^3.0.2"

-rollup@^0.45.2:
-  version "0.45.2"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-0.45.2.tgz#63a284c2b31234656f24e9e9717fabb6a7f0fa43"
-  dependencies:
-    source-map-support "^0.4.0"
+rollup@^0.50.0:
+  version "0.50.0"
+  resolved "https://registry.yarnpkg.com/rollup/-/rollup-0.50.0.tgz#4c158f4e780e6cb33ff0dbfc184a52cc58cd5f3b"
+
+rx@2.3.24:
+  version "2.3.24"
+  resolved "https://registry.yarnpkg.com/rx/-/rx-2.3.24.tgz#14f950a4217d7e35daa71bbcbe58eff68ea4b2b7"

 safe-buffer@^5.0.1, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
  version "5.1.1"
@ -2175,7 +2222,7 @@ sort-keys@^1.0.0:
  dependencies:
    is-plain-obj "^1.0.0"

-source-map-support@^0.4.0, source-map-support@^0.4.2:
+source-map-support@^0.4.2:
  version "0.4.15"
  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.15.tgz#03202df65c06d2bd8c7ec2362a193056fef8d3b1"
  dependencies:
@ -2187,10 +2234,18 @@ source-map@^0.4.2:
  dependencies:
    amdefine ">=0.0.4"

-source-map@^0.5.0, source-map@^0.5.3, source-map@^0.5.6:
+source-map@^0.5.0, source-map@^0.5.3:
  version "0.5.6"
  resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.6.tgz#75ce38f52bf0733c5a7f0c118d81334a2bb5f412"

+source-map@^0.5.6:
+  version "0.5.7"
+  resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc"
+
+spawn-command@^0.0.2-1:
+  version "0.0.2"
+  resolved "https://registry.yarnpkg.com/spawn-command/-/spawn-command-0.0.2.tgz#9544e1a43ca045f8531aac1a48cb29bdae62338e"
+
 spdx-correct@~1.0.0:
  version "1.0.2"
  resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-1.0.2.tgz#4b3073d933ff51f3912f03ac5519498a4150db40"
@ -2251,6 +2306,12 @@ stringstream@~0.0.4:
  version "0.0.5"
  resolved "https://registry.yarnpkg.com/stringstream/-/stringstream-0.0.5.tgz#4e484cd4de5a0bbbee18e46307710a8a81621878"

+strip-ansi@^0.3.0:
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-0.3.0.tgz#25f48ea22ca79187f3174a4db8759347bb126220"
+  dependencies:
+    ansi-regex "^0.2.1"
+
 strip-ansi@^3.0.0, strip-ansi@^3.0.1:
  version "3.0.1"
  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-3.0.1.tgz#6a385fb8853d952d5ff05d0e8aaf94278dc63dcf"
@ -2269,6 +2330,10 @@ strip-indent@^1.0.1:
  dependencies:
    get-stdin "^4.0.1"

+supports-color@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-0.2.0.tgz#d92de2694eb3f67323973d7ae3d8b55b4c22190a"
+
 supports-color@^2.0.0:
  version "2.0.0"
  resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-2.0.0.tgz#535d045ce6b6363fa40117084629995e9df324c7"
@ -2309,6 +2374,10 @@ tough-cookie@~2.3.0:
  dependencies:
    punycode "^1.4.1"

+tree-kill@^1.1.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/tree-kill/-/tree-kill-1.2.0.tgz#5846786237b4239014f05db156b643212d4c6f36"
+
 trim-newlines@^1.0.0:
  version "1.0.0"
  resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-1.0.0.tgz#5887966bb582a4503a41eb524f7d35011815a613"