Compiler.generate: support YModules, CommonJS and global dependencies #424

miripiruni · 2017-03-09T14:03:13Z

Fixes #375

Russian docs
English docs
Tests

coveralls · 2017-03-09T14:07:24Z

Coverage decreased (-0.4%) to 99.348% when pulling 1c3c665 on issue-375__modules into 4adfc67 on master.

miripiruni · 2017-03-09T14:07:59Z

lib/compiler.js

+
+    '})(typeof window !== "undefined" ? ' +
+      'window : typeof global !== "undefined" ? global : this);'
+
  ].join('\n');


EOL = require('os').EOL

miripiruni · 2017-03-09T14:09:15Z

test/api-generate-test.js

+var vow = require('vow');
+/* jscs:disable */
+// fake commonJS module after browserify
+var FAKE_COMMON_MODULE = 'var require=(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module \'"+o+"\'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({"fake":[function(require,module,exports){ module.exports = { getText: function () { return "Hello templates!"; } }; },{}]},{},[]);';


https://github.com/enb/enb-bemxjst/blob/a927766709a30d3fd41198aa4007148461eaee67/lib/compile-commonjs.js#L2

miripiruni · 2017-03-09T14:10:43Z

test/api-generate-test.js

+      var bundle = bemhtml.generate('', {
+        requires: { text: { globals: 'text' } }
+      });
+      var sandbox = { global: {}, exports: {} };


Сделать метод как в enb-bemxjst…

coveralls · 2017-03-16T14:22:44Z

Coverage increased (+0.005%) to 99.762% when pulling 02628c1 on issue-375__modules into bbafe2c on master.

qfox · 2017-03-16T14:57:30Z

lib/compiler.js

+    commonJSNames: [],
+    ym: [],
+    ymVars: [],
+    ymLibs: []


ym настолько особенный, что аж ну ваще

qfox · 2017-03-16T14:58:49Z

lib/compiler.js

+    return deps;
+
+  for (var lib in requires) {
+    if (requires.hasOwnProperty(lib)) {


if (!requires.hasOwn...) continue; ?

miripiruni · 2017-03-20T10:59:28Z

@zxqfox how is it?

miripiruni · 2017-03-20T12:35:10Z

docs/en/3-api.md

@@ -456,6 +424,111 @@ $ cat stderr.txt
 BEMXJST ERROR: cannot render block b1, elem undefined, mods {}, elemMods {} [TypeError: Cannot read property 'undef' of undefined]
 ```

+### Using thirdparty libraries


@tadatuta can you check this english documentation?

coveralls · 2017-03-20T13:01:47Z

Coverage increased (+0.007%) to 99.683% when pulling c4027be on issue-375__modules into 79a8522 on master.

qfox

Looked also at tests, looks fine.

qfox · 2017-03-20T13:40:19Z

lib/compiler.js

+      'function buildBemXjst(libs) {',
+        'var exports;',
+
+        '/* BEM-XJST Runtime Start */',


Do we really want replace these great beautiful banners with usual boring comment blocks?

qfox · 2017-03-20T13:43:09Z

lib/compiler.js

+        ) + '}'),
+
+      // Provide to YModules
+     'if (typeof modules === "object") {',


Afaik electron has modules but not ym. /cc @awinogradov

ym has modules 100%

@zxqfox @tadatuta see ym docs: https://github.com/ymaps/modules/blob/master/README.ru.md#Спецификация-api

I mean electron has no ym but has modules variable and this code will be broken there. AFAIK.

Ah, the electron context is a product of merging browser and nodejs contexts, and we have there modules, module and require at the same time. I'd add a test for this.

qfox · 2017-03-20T13:55:43Z

lib/compiler.js

+      ),
+
+    '})(typeof window !== "undefined" ? ' +
+      'window : typeof global !== "undefined" ? global : this);'


I feel like this code smell, but I don't atm know how to bake it better.

I'd say it's fine solution since compile should generate code with exports.

tadatuta · 2017-03-20T15:12:11Z

docs/en/3-api.md

+}
+```
+
+`lib-name` module will accessible in templates body like this:


will accessible -> will be accessible

tadatuta · 2017-03-20T15:15:02Z

docs/en/3-api.md

+});
+```
+
+It’s necessary to specify all the modular systems for connecting the library.


- It’s necessary to specify all the modular systems for connecting the library. + It’s necessary to specify each environment you want to expose library to.

tadatuta · 2017-03-20T15:16:18Z

docs/en/3-api.md

+
+It’s necessary to specify all the modular systems for connecting the library.
+
+For example: you can specify dependencies only from global scope. In this case


E.g. if you specify just global scope the library will only be available as global variable even though some module system will be present in runtime.

tadatuta · 2017-03-20T15:16:59Z

docs/en/3-api.md

+
+Example of using `moment.js` library:
+
+You need no set path to module:


You don't need to to provide path to module

tadatuta · 2017-03-20T15:18:23Z

docs/ru/3-api.md

+
+## Подключение сторонних библиотек
+
+Технологии [bemtree](api.ru.md#bemtree) и [bemhtml](api.ru.md#bemhtml) поддерживают возможность подключения сторонних библиотек как глобально, так и для разных модульных систем с помощью опции [requires](api.ru.md#requires).


В английском было капсом, что правильно

tadatuta · 2017-03-20T15:19:01Z

docs/ru/3-api.md

@@ -451,6 +419,110 @@ BEMXJST ERROR: cannot render block b1, elem undefined, mods {}, elemMods {} [Typ
 ```


+### Расширение BEMContext


порядок не совпадает с порядком в TOC-е

tadatuta · 2017-03-20T15:22:05Z

lib/compiler.js

+        ) + '}'),
+
+      // Provide to YModules
+     'if (typeof modules === "object") {',


ym has modules 100%

…ncies (#375 fix)

miripiruni · 2017-03-20T15:32:09Z

@tadatuta updated!

coveralls · 2017-03-20T15:41:17Z

Coverage increased (+0.007%) to 99.683% when pulling b20bb52 on issue-375__modules into 79a8522 on master.

qfox · 2017-05-23T03:00:28Z

Я тут запустил, и у меня require('./generated.bemhtml.js') не работает :-( Кажется, CommonJS сломано

miripiruni added the status: review label Mar 9, 2017

miripiruni commented Mar 9, 2017

View reviewed changes

miripiruni force-pushed the issue-375__modules branch 4 times, most recently from e2043e2 to 02628c1 Compare March 16, 2017 14:18

miripiruni changed the title ~~[WIP] Compiler.generate: support YModules, CommonJS and global dependencies~~ Compiler.generate: support YModules, CommonJS and global dependencies Mar 16, 2017

miripiruni requested a review from qfox March 16, 2017 14:19

qfox reviewed Mar 16, 2017

View reviewed changes

lib/compiler.js

commonJSNames: [],

ym: [],

ymVars: [],

ymLibs: []

Copy link

Member

qfox Mar 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ym настолько особенный, что аж ну ваще

qfox reviewed Mar 16, 2017

View reviewed changes

lib/compiler.js

return deps;

for (var lib in requires) {

if (requires.hasOwnProperty(lib)) {

Copy link

Member

qfox Mar 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if (!requires.hasOwn...) continue; ?

miripiruni force-pushed the issue-375__modules branch from 02628c1 to c4027be Compare March 20, 2017 12:34

miripiruni commented Mar 20, 2017

View reviewed changes

qfox approved these changes Mar 20, 2017

View reviewed changes

miripiruni requested a review from tadatuta March 20, 2017 14:33

tadatuta requested changes Mar 20, 2017

View reviewed changes

miripiruni force-pushed the issue-375__modules branch from c4027be to 9ca1480 Compare March 20, 2017 15:30

Compiler.generate: support YModules, CommonJS and third party depende…

b20bb52

…ncies (#375 fix)

miripiruni force-pushed the issue-375__modules branch from 9ca1480 to b20bb52 Compare March 20, 2017 15:31

tadatuta approved these changes Mar 20, 2017

View reviewed changes

miripiruni merged commit 45d8415 into master Mar 20, 2017

miripiruni removed the status: review label Mar 20, 2017

miripiruni deleted the issue-375__modules branch March 20, 2017 19:26

miripiruni added this to the 8.6.8 milestone Mar 20, 2017

tadatuta mentioned this pull request Mar 20, 2017

Новые релизы bem-core и bem-components bem-site/bem-forum-content-ru#1287

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compiler.generate: support YModules, CommonJS and global dependencies #424

Compiler.generate: support YModules, CommonJS and global dependencies #424

miripiruni commented Mar 9, 2017 •

edited

Loading

coveralls commented Mar 9, 2017 •

edited

Loading

miripiruni Mar 9, 2017 •

edited

Loading

miripiruni Mar 9, 2017

miripiruni Mar 9, 2017

coveralls commented Mar 16, 2017 •

edited

Loading

qfox Mar 16, 2017

qfox Mar 16, 2017

miripiruni commented Mar 20, 2017

miripiruni Mar 20, 2017

coveralls commented Mar 20, 2017 •

edited

Loading

qfox left a comment

qfox Mar 20, 2017

qfox Mar 20, 2017

tadatuta Mar 20, 2017

miripiruni Mar 20, 2017

qfox Mar 20, 2017 •

edited

Loading

qfox Mar 20, 2017

qfox Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

tadatuta Mar 20, 2017

miripiruni commented Mar 20, 2017

coveralls commented Mar 20, 2017 •

edited

Loading

qfox commented May 23, 2017


		It’s necessary to specify all the modular systems for connecting the library.

		For example: you can specify dependencies only from global scope. In this case


		Example of using `moment.js` library:

		You need no set path to module:


		## Подключение сторонних библиотек

		Технологии [bemtree](api.ru.md#bemtree) и [bemhtml](api.ru.md#bemhtml) поддерживают возможность подключения сторонних библиотек как глобально, так и для разных модульных систем с помощью опции [requires](api.ru.md#requires).

		@@ -451,6 +419,110 @@ BEMXJST ERROR: cannot render block b1, elem undefined, mods {}, elemMods {} [Typ
		```


		### Расширение BEMContext

Compiler.generate: support YModules, CommonJS and global dependencies #424

Compiler.generate: support YModules, CommonJS and global dependencies #424

Conversation

miripiruni commented Mar 9, 2017 • edited Loading

coveralls commented Mar 9, 2017 • edited Loading

miripiruni Mar 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Mar 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miripiruni commented Mar 20, 2017

Choose a reason for hiding this comment

coveralls commented Mar 20, 2017 • edited Loading

qfox left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qfox Mar 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miripiruni commented Mar 20, 2017

coveralls commented Mar 20, 2017 • edited Loading

qfox commented May 23, 2017

miripiruni commented Mar 9, 2017 •

edited

Loading

coveralls commented Mar 9, 2017 •

edited

Loading

miripiruni Mar 9, 2017 •

edited

Loading

coveralls commented Mar 16, 2017 •

edited

Loading

coveralls commented Mar 20, 2017 •

edited

Loading

qfox Mar 20, 2017 •

edited

Loading

coveralls commented Mar 20, 2017 •

edited

Loading