Static analyzer by miripiruni · Pull Request #377 · bem/bem-xjst

miripiruni · 2016-10-26T12:35:34Z

Fixes

Static lint (Issue 49)
Migration script for every major version (Issue 353)

Changes proposed in this pull request

I introduce two features:

Static linter
Mirgation scripts

Both of them on jscodeshift + my boilerplate code for logging and AST checking.

How static lint work?

bem-xjst $ ./migration/lib/index.js --lint --input ../islands/common.blocks/ --from 7 --to 8

lint — lint option (if not present script will rewrite your templates)
input — path to templates (relative to current directory or absolute)
7 — current major version of bem-xjst templates
8 — version to check for

The output of comand will be:

Check rule: js() mode to addJs() mode

Processing 325 files...
Spawning 3 workers...
Sending 50 files to free worker...
…

BEM-XJST WARNING:
>>>> From v8.x you should use addJs() instead of js()
>>>> ../islands/common.blocks/ticker/ticker.bemhtml.js:25:4
>>>>
    js()(function() {

>>>>

All done.
Results:
0 errors
325 unmodified
0 skipped
0 ok
Time elapsed: 1.047seconds
…

How migrate tool work?

Migration tool work the same as lint tool. Except you shouldn’t pass lint option.

Templates will be changed. So be aware of changing something without version control.

TODO

Documentation changed
Tests
Collect list of transformers/linters (see below)

Transformers:
for v7 to v8

mix() to addMix()
attrs() to addAttrs()

for v6 to v7

this.isArray(argument) to Array.isArray(argument)
once() to def()
For safety: modifiers value should be String type. In BEMJSON and in template. If not so - we must warn you. Comare sandbox example in v6.x and v7.x https://goo.gl/auhOOV
for backwards capability use xhtml: true option value in all bemxjst.compile() functions.

for v5 to v6

There is nothing to rewrite in templates. (Really?)

for v4 to v5

Replace elemMatch(argument) to elem('*').match(function() { ... }).
mods for elem (instead of elemMods). behavior mods and elemMods BEMJSON fields are changed. bem-xjst should not treat elemMods as mods. See qfox’s comment — BEMJSON tested in runtime lint.
API changed: require('bem-xjst') now returns two engines bemhtml and bemtree. Replace require('bem-xjst') to require('bem-xjst').bemhtml.

for v2 to v3

Do not use apply.call(BEMJSON). Use apply(BEMJSON).

for v1 to v2

Default (def()) mode of templates MUST return a string now.
this._ no more
mode('') no more

Some common checks:

Function that returns a literal can be replaced with literal itself.
warn about this.mods && this.mods.some should be this.mods.some
mix()([]) to function generator instead: function() { return []; }.
warn about html entities. Suggest UTF-8 symbols.
assignment to ctx.mods (instead of this.mods) — checked in runtime linter

arikon · 2016-10-26T15:41:27Z

migration/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bem-xjst-static-analyzer",


Ух, а почему это отдельный модуль?

(кажется я уже писал ответ, но гитхаб его не отображает почему-то)

Это не отдельный модуль, это просто результат запуска npm init, чтобы сделать зависимости.

arikon

Вопросик

miripiruni · 2016-10-26T15:52:53Z

migration/lib/index.js

+
+  cmd = cmd.join(' ');
+
+  execSync(cmd, { stdio: [ 0, 1, 2 ], encoding: 'utf8' })


Проверить что exit 1 прокидывается.

qfox · 2016-10-26T15:40:46Z

migration/lib/logger.js

+  console.warn(shift, opts.descr);
+  console.warn(shift, opts.file.path + ':' + opts.path.start.line);
+  console.warn(shift, opts.file.source.slice(opts.path.start, opts.path.end));
+  console.warn('\n');


https://github.com/violence/warnie/blob/master/index.js ?

qfox · 2016-10-26T15:53:51Z

package.json

-    "bem-xjst": "bin/bem-xjst"
+    "bem-xjst": "bin/bem-xjst",
+    "lint": "bin/lint",
+    "mirgate": "bin/migrate"


кажется, что так у нас появится тулза mirgate (miRgate?) и lint, это не очень, могут быть конфликты

miripiruni · 2016-10-26T15:55:12Z

bin/lint

@@ -0,0 +1,7 @@
+if [ "$#" -ne 2 ]; then


rename file to bin/bem-xjst-lint

Flackus · 2016-10-26T20:50:05Z

migration/lib/index.js

+
+  cmd = cmd.join(' ');
+
+  execSync(cmd, { stdio: [ 0, 1, 2 ], encoding: 'utf8' })


For convenience, options.stdio may be one of the following strings:
'pipe' - equivalent to ['pipe', 'pipe', 'pipe'](the default)
'ignore' - equivalent to ['ignore', 'ignore', 'ignore']
'inherit' - equivalent to [process.stdin, process.stdout, process.stderr] or [0,1,2]

qfox · 2016-11-01T15:51:21Z

Replace elemMatch(argument) to elem('*').match(function() { ... }).

This is for v1→v2

qfox · 2016-11-01T15:52:53Z

I don't see warn about this._buf usage. It does not work in v2+

coveralls · 2017-01-18T11:33:39Z

Coverage remained the same at 97.048% when pulling d184d0f on static-analyze into a4146c1 on master.

miripiruni · 2017-01-18T11:49:51Z

Time to finish.
Integration tests on Yandex.Money, bem-components and Islands went very well.

coveralls · 2017-01-18T12:38:55Z

Coverage remained the same at 97.048% when pulling b7587be on static-analyze into edac12f on master.

miripiruni added status: review semver: minor status: in progress scope: debuggability type: new feature and removed status: review labels Oct 26, 2016

miripiruni self-assigned this Oct 26, 2016

miripiruni changed the title ~~Static analizer~~ Static analyzer Oct 26, 2016

miripiruni force-pushed the static-analyze branch 6 times, most recently from c24c2fe to 5ef4ab8 Compare October 26, 2016 14:48

arikon reviewed Oct 26, 2016

View reviewed changes

miripiruni commented Oct 26, 2016

View reviewed changes

qfox reviewed Oct 26, 2016

View reviewed changes

miripiruni commented Oct 26, 2016

View reviewed changes

bin/lint Outdated

@@ -0,0 +1,7 @@

if [ "$#" -ne 2 ]; then

Copy link

Contributor Author

miripiruni Oct 26, 2016

Choose a reason for hiding this comment

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

rename file to bin/bem-xjst-lint

Flackus reviewed Oct 26, 2016

View reviewed changes

miripiruni force-pushed the static-analyze branch from 5ef4ab8 to 0e5f773 Compare November 1, 2016 15:31

miripiruni force-pushed the static-analyze branch 7 times, most recently from 28f4e7d to 39cbf67 Compare November 2, 2016 14:02

miripiruni force-pushed the static-analyze branch from 78737aa to f1b9b46 Compare January 12, 2017 11:54

miripiruni mentioned this pull request Jan 16, 2017

bem-xjst mirgation tool test bem/bem-components#1996

Closed

miripiruni added 21 commits January 18, 2017 15:34

Static analyzer

adf2af9

Static analyzer

f90d967

Static analyze

e36f745

Readme: about bem-templates-converter

ca3d970

Static array case

0fca1f5

Static object to function generator

cd0eca1

Static lint: fix for mods value transformer

668ed5d

Static lint: transformer class

0ee1ac1

Static lint: lodash.get added

689b4de

Static lint: more tests

44ccf68

Static lint: remove copy-paste in tests

a6ccaac

Logger fixed

c21aaab

Codestyle config option added

f038316

Filter files: use only *.bemhtml.js and *.bemjson.js

c08d543

bin/bem-xjst-lint and bin/bem-xjst-migrate removed

4aaa04b

Sample codestyle config added

3d479c2

Fix issue with def() and return applyCtx()

fd4c046

Logger improved

6a48bae

More tests

ab0b0a9

Report about rule

6c3c496

Readme: list of transformers

b7587be

miripiruni force-pushed the static-analyze branch from 2be5ea2 to b7587be Compare January 18, 2017 12:35

miripiruni merged commit 0b3b876 into master Jan 18, 2017

miripiruni removed the status: review label Jan 18, 2017

miripiruni deleted the static-analyze branch January 18, 2017 12:40


		cmd = cmd.join(' ');

		execSync(cmd, { stdio: [ 0, 1, 2 ], encoding: 'utf8' })

Conversation

miripiruni commented Oct 26, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request

How static lint work?

How migrate tool work?

TODO

Uh oh!

arikon Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

miripiruni Nov 2, 2016

Choose a reason for hiding this comment

Uh oh!

arikon left a comment

Choose a reason for hiding this comment

Uh oh!

miripiruni Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

qfox Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

qfox Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

miripiruni Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

Flackus Oct 26, 2016

Choose a reason for hiding this comment

Uh oh!

qfox commented Nov 1, 2016

Uh oh!

qfox commented Nov 1, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

miripiruni commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

miripiruni commented Oct 26, 2016 •

edited

Loading

qfox commented Nov 1, 2016 •

edited

Loading

coveralls commented Jan 18, 2017 •

edited

Loading

miripiruni commented Jan 18, 2017 •

edited

Loading

coveralls commented Jan 18, 2017 •

edited

Loading