Update babel-types README #4905

Merged
merged 2 commits into from Nov 29, 2016

Projects

None yet

3 participants

@xtuc
Member
xtuc commented Nov 28, 2016
Q A
Bug fix? no
Breaking change? no
New feature? no
Deprecations? no
Spec compliancy? no
Tests added/pass? no
Fixed tickets no
License MIT
Doc PR yes
Dependency Changes no

The final goal is to publish it on the website. See the following preview :

babel-types

Preview the README : https://github.com/xtuc/babel/blob/master/packages/babel-types/README.md

@xtuc xtuc fix(babel-types): update README generation
3694d81
@xtuc
Member
xtuc commented Nov 28, 2016

Could we also publish it on npm (https://www.npmjs.com/package/babel-types) ?

scripts/generate-babel-types-docs.js
@@ -4,7 +4,7 @@ var util = require('util');
var path = require('path');
var fs = require('fs');
-var types = require('../packages/babel-types');
+var types = require('../packages/babel-types/src');
@xtuc
xtuc Nov 28, 2016 Member

I'm not sure about this. I hadn't built the module locally and needed ES6.

@hzoo
hzoo Nov 28, 2016 Member

It's probably because it's a separate script so we assume node 6 while for other code we just run Babel on it

@hzoo
hzoo Nov 28, 2016 Member

Or yeah you have to build it first

@xtuc
xtuc Nov 28, 2016 Member

In one case you need to build the module first and in the other case you need to launch the script with ES6 support.

What do you prefer ?

We could use this technic : https://github.com/xtuc/CSS-as-React-component/blob/master/bin/index#L1.

@hzoo
hzoo Nov 29, 2016 edited Member

Both are ok. I guess we just assume you are developing with node 6 - oh we did add that to contributing actually https://github.com/babel/babel/blob/master/CONTRIBUTING.md#developing

Yeah that could work, but I think we assume you set up everything already with make bootstrap + build

@xtuc xtuc referenced this pull request in babel/babel.github.io Nov 28, 2016
Merged

Create Babel-types page #1009

@codecov-io
codecov-io commented Nov 28, 2016 edited

Current coverage is 89.22% (diff: 100%)

Merging #4905 into master will not change coverage

@@             master      #4905   diff @@
==========================================
  Files           204        204          
  Lines         10487      10487          
  Methods        1153       1153          
  Messages          0          0          
  Branches       2762       2762          
==========================================
  Hits           9357       9357          
  Misses         1130       1130          
  Partials          0          0          

Powered by Codecov. Last update db67d7f...3694d81

@hzoo hzoo [skip ci]
cf5e50e
@hzoo
Member
hzoo commented Nov 29, 2016

You should make a branch for the changes next time so you can have multiple prs?

@hzoo hzoo merged commit 51e8fd1 into babel:master Nov 29, 2016

1 check was pending

ci/circleci CircleCI is running your tests
Details
+
+### arrayExpression
+```javascript
+t.arrayExpression(elements)
@hzoo
hzoo Nov 29, 2016 Member

Might be cool if we could generate an example rather than just "elements" etc

@xtuc
xtuc Nov 29, 2016 Member

We can open an issue for that ?

@panagosg7 panagosg7 added a commit to panagosg7/babel that referenced this pull request Jan 17, 2017
@xtuc @panagosg7 xtuc + panagosg7 Update babel-types README (#4905) [skip ci] 2c9b04d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment