Неважно какой фреймворк вы используете, внутри всё равно будет ваш уникальный код под проект, со своей структурой и логикой. Его нужно поддерживать, а коллегам нужно в него вникать. Как минимизировать порог вхождений и в целом облегчить поддержку проекта? Какие инструменты и подходы можно использовать, или сделать самому, для анализа, даже не кода, а проекта в целом? Константин поделится своим взглядом на этим вопросы и какие могут быть решения.

1. Упрощаем «жизнь»
Лебедев Константин

2. Задача

7. Project/README

9. npm install
Не заыбвайте про
preinstall
— Установка registry на локальное хранилище
postinstall
— Добавление githook'ов
— pre-commit: grunt dev
— post-merge: npm install
— jam install — обновление jam-пакетов

14. — Структура вложенности блоков
— Путь к файлу и строка (ссылка, открывает файл в IDE)
— Примеры использования с текущими параметрами
— «Глаз» — открыть GUI c блоком для просмотра

16. Feast GUI

20. Что произошло?
— spa-meetup-2.html — шаблон блока
— spa-meetup-2.scss — стили
— spa-meetup-2.js — описание поведения
— spa-meetup-2.spec.js — спецификация, на основе которой строятся
примеры использования
./node_modules/feast/bin/assist create-block
--path=path/to/ui-blocks/
01.
02.

21. <div> </div> .spa-meetup-2 {
padding: 10px;
background: red;
}
import feast from "feast";
import template from "feast-tpl!./spa-meetup-2.html";
import styleSheet from "feast-css!./spa-meetup-2.css";
export default feast.Block.extend({
name: "spa-meetup-2",
template,
styleSheet
});
01. 01.
02.
03.
04.
01.
02.
03.
04.
05.
06.
07.
08.
09.

25. avito-spa-meetup-2.html
<div>
<div bem:elem="picture">
<b:avatar src="..."/>
</div>
<div bem:elem="details">
<div bem:elem="description"><!-- описание --></div>
<b:button remit:click="close" text="Done"/>
</div>
</div>
01.
02.
03.
04.
05.
06.
07.
08.
09.

26. Как это работает?

27. 2012 / Fest

28. Fest
— XML -> (NODEJS) -> JSFUNC_TPL -> STRING
— Вывод ошибок (файл + строка)
— Трансформация на сервере ~1ms
— Запуск «Главной» на Fest
— Интеграция в «Почту», запуск «Календаря»
— Разработка внутреннего UI Toolkit (библиотека блоков)
— Запуск новой версии «Почты» и «Облака» на базе Toolkit

29. Fest / Проблемы
Возвращает строку

30. Feast
— XHTML (CLIENT) -> JSFUNC_TPL -> JSON -> CITOJS -> VDOM
— GUI для просмотра и редактирования блоков (Live coding
HTML/CSS/JS)
— Инспектор блоков проекта
— Визуализация связей

31. Live coding
— BrowserSync
— Webpack
— node-watch + socket.io

32. Server
"use strict";
const fs = require("fs");
const http = require("http");
const watch = require("node-watch");
const app = http.createServer((req, res) => {
res.writeHead(200, {"Content-Type": "html/text"});
res.end();
});
const socketIO = require("socket.io")(app);
app.listen(2016, () => {
watch("path/to", {recursive: true}, (file) => {
fs.readFile(file, (err, content) => {
const ext = file.split(".").pop();
socketIO.emit(`file-changed:${ext}`, {file, content});
});
});
});
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.
15.
16.
17.

33. Client
<script src="//cdnjs/socket.io"></script>
<script>
const socket = io();
socket.on("file-changed:html", ({file, content}) => {
// ...
});
</script>
01.
02.
03.
04.
05.
06.
07.

34. <div class="btn">
Click me!
</div>
XML Parser
{
name: "div",
attrs: {class: "btn"},
file: "path/to/button.html",
line: 1,
children: [{
name: "#text",
value: "Click me!",
file: "path/to/button.html",
line: 2
}]
01.
02.
03.
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.

35. <fn:for data="attrs.items" as="key">...</fn:for>
"fn:for": {
scope: true,
required: ["data"],
expressions: ["data"],
prepare: (node, attrs) => ({
as: attrs.as || "$value",
key: attrs.key || "$index",
data: attrs.data
}),
toCode: () => [
"__each($data, @@.children, function (&as, &key) {", // начало
"});" // конец
];
}
}
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.
15.
16.
17.

36. Оновление шаблона
socket.on("file-changed:html", ({file, content}) => {
feast.Block.all.forEach(Block => {
if (file === Block.prototype.template.file) {
const template = feast.parse(content, file);
Block.setTemplate(template);
Block.getInstances().forEach(block => block.render());
}
});
01.
02.
03.
04.
05.
06.
07.
08.

37. CSS Modules

38. CSS Modules: PostCSS + React
import React from "react";
import styles from "./button.css";
export default class Button extends React.Component {
render() {
return (
<button className={styles.btn}>
<span className={styles.icon}>
<Icon name={this.props.icon}/>
</span>
<span className={styles.text}>{this.props.value}</span>
</button>
);
}
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.

39. PostCSS + React + react-css-modules
import React from "react";
import CSSModules from "react-css-modules";
import styles from "./button.css";
class Button extends React.Component {
render () {
return <button styleName="btn">
<span styleName="icon">
<Icon name={this.props.icon}/>
</span>
<span styleName="text">{this.props.value}</span>
</button>;
}
}
export default CSSModules(Button, styles);
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.
15.
16.

40. @decorator
import React from "react";
import CSSModules from "react-css-modules";
import styles from "./button.css";
@CSSModules(styles)
export default class Button extends React.Component {
render () {
return <button styleName="btn">
<span styleName="icon">
<Icon name={this.props.icon}/>
</span>
<span styleName="text">{this.props.value}</span>
</button>;
}
}
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.
15.

41. Angular2
@Component({
selector: "my-app",
template: `<div class="app">{{text}}</div>`,
styles: [`.app { ... }`] // .app[_ngcontent-mjn-1] { }
})
export class App {
// ...
}
01.
02.
03.
04.
05.
06.
07.
08.

42. Feast
import feast from "feast";
import template from "feast-tpl!./button.html";
import styleSheet from "feast-css!./button.css";
export default feast.Block.extend({
name: "button",
template,
styleSheet
});
01.
02.
03.
04.
05.
06.
07.
08.
09.

43. CSS Module «на коленке»
function toCSSModule(file, cssText) {
const classes = {};
cssText = cssText.replace(R_CSS_SELECTOR, (_, name) => {
classes[name] = name + "-" + simpleHash(file + name);
return "." + classes[name];
});
return {file, cssText, classes};
}
01.
02.
03.
04.
05.
06.
07.
08.

44. CSS Module «на коленке»
function simpleHash(str) {
let idx = str.length;
let hash = UNIQ_SEED;
while (idx--) {
hash = (hash * 33) ^ str.charCodeAt(idx);
}
return (hash >>> 0).toString(36);
}
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.

45. CSS Module «на коленке»
{
file: "path/to/button.css"
cssText: "...",
classes: {
"button": "button-v9m8ae"
}
}
01.
02.
03.
04.
05.
06.
07.

46. JS / Hot Reload

47. JS / Hot Reload
class Foo {
constructor(value) {
this.value = value;
}
log() {
console.log(`Foo: ${this.value}`, this instanceof Foo);
}
}
01.
02.
03.
04.
05.
06.
07.
08.

48. JS / Hot Reload
var foo = new Foo(123);
foo.log(); // "Foo: 123", true
replaceClass(Foo, class NewFoo {
constructor(value) {
this.value = value;
}
log() {
console.log(`NewFoo: ${this.value}`, this instanceof NewFoo);
}
});
foo.log(); // "NewFoo: 123", true
foo instanceof Foo; // true
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.

49. JS / Hot Reload
function replaceClass(OldClass, NewClass) {
const newProto = NewClass.prototype;
OldClass.prototype.__proto__ = newProto;
// Static
Object.keys(NewClass).forEach(name => {
OldClass[name] = NewClass[name];
});
// Prototype
Object.getOwnPropertyNames(newProto).forEach(name => {
OldClass.prototype[name] = newProto[name];
});
}
01.
02.
03.
04.
05.
06.
07.
08.
09.
10.
11.
12.
13.
14.

50. JS / Hot Reload / Проблема
replaceClass(Foo, class NewFoo {
/* ... */
});
foo.constructor === Foo; // false
01.
02.
03.
04.
05.

51. JS / Hot Reload / Проблема / Решение
— Webpack — оборачивает создание класса в специальный фраппер
— Использовать обвязку для создания классов, например
createClass('MyClassName', {...});

52. Live Coding
— React — Webpack/React Hot loader/Redux
— Angular2 — mgechev/angular2-hot-loader (экспериментально)
— Так же Hot Relaod есть для Ember, Vue, RiotJS и т.п.

53. Что ещё?

54. Extentions / DevTools

55. lahmatiy/component-inspector

56. // app/packages/require.config.js
var packages = [{
name: "suggests",
location: "packages/suggests"
}, {
name: "push-manager",
location: "packages/push-manager"
}];
require.config({packages: packages});
Пакеты: npm/bower/jam
jam install suggests --save
jam install push-manager --save
// app/some-controller.js
import suggests from "suggests";
import PushManager from "push-manager";
// ...
01.
02.
01.
02.
03.
04.
05.
06.
07.
08.
09.
01.
02.
03.
04.
05.

57. logger

58. Istanbul

59. Не протестировано
↓

63. Заключение
— Документируйте процессы
— Ищите инструменты и создавайте их сами
— Не описывайте «шаги», пишите утилиты, которые их выполнят
— Старайтесь писать универсальные компоненты, неотягощенные
сложной логикой

64. The End
github.com/RubaXa
@ibnRubaXa