enb / enb-borschik Goto Github PK

View Code? Open in Web Editor NEW

13.0 13.0 15.0 110 KB

ENB tech to run borschik

License: Other

JavaScript 100.00%

bem borschik enb javascript

enb-borschik's Introduction

ENB

The tool for building web projects created with the BEM methodology.

Introduction

The main purpose of ENB is to combine source files into bundles, usually for further use in the browser.

The build includes combining all source files, processing them and converting the code, as well as preparing and packing the resources (images, fonts, and so on).

Read more about building BEM projects on the bem.info site.

Basic features of ENB

Searches for only those source files needed for the build.
Connects the necessary source files based on dependency declarations.
Defines the order of connecting the source files.
Combines source files spread across the project's file system.
Creates bundles and files.
Extends the build for project-specific processing and conversion.
Provides a local development service that supports builds on demand.

Installation

$ npm install --save-dev enb

Getting started

To create a BEM project configured for the build with ENB, use one of these options:

Install a project-stub template project that supports ENB builds by default.
Create a project that suits your tasks. To do this, answer the questions in the BEM project generator based on Yeoman.

Documentation

[deprecated] Project build guide
Building a bundle
Building a page
Building a merged bundle
Building a distribution
[deprecated] Building with express
[deprecated] Guide to writing an ENB technology
Terminology
[deprecated] API
[deprecated] CLI

Materials

Extensions

ENB technology packages are located in NPM: packages with the enb prefix.

Name	Status	Description
BEM methodologies
BEM		Technologies for building BEM projects.
BEViS		Technologies for building BEViS projects.
Templating
bem-xjst		Building BEMTREE and BEMHTML templates with bem-xjst.
xjst		Building BEMTREE and BEMHTML templates with XJST.
bh		Building BH templates.
bt		Building BT templates.
Styles
CSS		Building and minimizing CSS files.
PostCSS		Building and processing CSS files with postcss.
Stylus		Building and minimizing Stylus files.
Saas		Building Sass files.
Roole		Building roo files.
JavaScript
JavaScript	![NPM version] (https://img.shields.io/npm/v/enb-js.svg)	Building, processing and minimizing JS files.
YModules		Building JS files with YModules.
Public facilities
Examples		Building BEM examples.
Docs		Building BEM documentation.
Browser tests		Building and running tests for client-side JavaScript.
Node tests		Building and running tests for BEM templates.
Template tests		Building and running tests for BEM templates.

License

enb-borschik's People

Contributors

Stargazers

Watchers

Forkers

bratva scf2k arikon tadatuta aliosv zlebnik petrukhin mishanga doochik birhoff golyshevd a-x- b1tc0re realetive kornienko199004

enb-borschik's Issues

Feels like techs for chunks shouldn't be here.

It's for like enb-bembundle or enb-borschik-bembundle package. No?

Add `borschik-include` tech

If in source code use borschik:include then to correctly replace by the file's content need build target which is borschik:include and use borschik tech.

Expected target result for js-borschik-include tech:

/*borschik:include:./path/to/file-1.js*/
/*borschik:include:./path/to/file-2.js*/
/* ... */

Reed more about borschik:include in the docs.

Error: Unexpected token operator «=», expected punc «,»

ES6 default params crash:

Error: Unexpected token operator «=», expected punc «,» (line: 14895, col: 49, pos: 453112)
 14893 |     * @private
 14894 |     */
 14895 |    request._prepareSettings = function(settings = {}) {
---------------------------------------------------------^
 14896 |        const qs = querystring.parse(location.search);
 14897 |
Error result in /usr/src/app/desktop.bundles/index/index.ru.min.js.borschik-error
    at /usr/src/app/node_modules/enb-borschik/node_modules/borschik/lib/tech.js:86:31
    at Array.<anonymous> (/usr/src/app/node_modules/vow/lib/vow.js:712:56)
    at Immediate.callFns [as _onImmediate] (/usr/src/app/node_modules/vow/lib/vow.js:23:35)
    at tryOnImmediate (timers.js:543:15)
    at processImmediate [as _immediateCallback] (timers.js:523:5)

What the borschik-error suffix?

Found this: borschik/borschik#28

Build should fail if error happens.

Error: CssSyntaxError: Unexpected input if minify: true in v2.3.1

Обновился пакет, появилась такая ошибка при сборке.

Css на вход подается валидный.

Error: CssSyntaxError: Unexpected input
Error result in /Users/voischev/projects/ui/dist/desktop/ui.min.css.borschik-error
    at /Users/voischev/projects/ui/node_modules/enb-borschik/node_modules/borschik/lib/tech.js:86:31
    at Array.<anonymous> (/Users/voischev/projects/ui/node_modules/enb-borschik/node_modules/vow/lib/vow.js:712:56)
    at Immediate.callFns [as _onImmediate] (/Users/voischev/projects/ui/node_modules/enb-borschik/node_modules/vow/lib/vow.js:23:35)
    at processImmediate [as _immediateCallback] (timers.js:383:17)

если minify: false то отрабатывает норм

c "enb-borschik": "2.3.0" тоже нормально работает

Implement tests for borschik technology

Also set up tests infrastructure

The reason to apply freeze by default is that without .borschik config in the project folder no freezing will be applied anyway. And in case there is such config it's obvious that user want freeze to be turned on.

Use `borschik.api` instead of `borschik-preprocessor`

Source option should be required

Remove `css-borschik-chunks` tech

Add ability to pass comments=false to borschik

Rewrite borschik technology with help of build-flow module

Add tests

#18 Implement tests for borschik technology
#19 Implement tests for js-borschik-include technology

Implement tests for js-borschik-include technology

Фриз bemtree.

Дано: нодовое приложение

app.get('*', function(req, res) { BEMTREE.apply({ block : 'root' }).then(function(bemjson) {
    res.send(BEMHTML.apply(bemjson));
}) })

root.bemtree

block('root').def()(function(){
   return {
      block : 'page',
      styles : [{ elem : 'css', url : '/_site.css' }],
      scripts : { elem : 'js', url : '/_site.js' }
   };
})

Задача: фризить статику(js, css, ico, ...) и отдавать клиенту подобный html

<doctype html>
<head>
    <link href="sha-1.css">
    <script src="sha-1.js">
...

Проблемы:

enb-borschik ничего не знает про готовность замораживаемых таргетов, т.е. на примере выше _?.css и _?.js таргеты могут не существовать в момент фриза борщиком.
Борщик замораживает файлы с определенными расширениями, по умолчанию среди них нет css и js.