Skip to content

Chore refactors#232

Merged
balthazar merged 1 commit intomasterfrom
dist
Jan 18, 2017
Merged

Chore refactors#232
balthazar merged 1 commit intomasterfrom
dist

Conversation

@balthazar
Copy link
Contributor

@balthazar balthazar commented Jan 13, 2017

I abandoned the move of the compiled main.css file, since I can't make it compatible with both sass and vanilla css imports, we'll wait for the next major.

This introduces a change of arch by moving stuff around, doing minor es6 refactors, a nice readme, better DX with webpack, linting, named exports, coverage published on Coveralls, dedicated changelog file, and some more 😃

This it will be easier to review separate commits, I'll wait for this to rebase.

package.json Outdated
"version": "0.9.0",
"license": "MIT",
"author": "Anton Bulyenov <antonb@uber.com>",
"author": "Anton Bulyenov <visualization@uber.com>",
Copy link
Contributor

Choose a reason for hiding this comment

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

Should probably updated to someone who is not anton, as he isn't a maintainer anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, or more globally, "Visualization team"?

Copy link
Contributor

Choose a reason for hiding this comment

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

yea i think that's reasonable

"build-js": "babel src -d dist --copy-files",
"build-js-example": "npm run build-js -- --source-maps inline",
"build-docs": "(node-sass src/example/main.scss example.css) & (browserify -t brfs ./dist/example/main.js > example.js)",
"build-css": "node-sass src/main.scss main.css",
Copy link
Contributor

Choose a reason for hiding this comment

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

it's my understanding that this is actually necessary as the user needs to require node-modules/react-vis/main.css to get the app running

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I only changed the path of the compiled main css file for it to be inside the dist folder instead

Copy link
Contributor

Choose a reason for hiding this comment

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

so will users have require dist/main.css instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I updated the readme to make it clear

Note that the change of the css path is breaking, but worth in my opinion.

@coveralls
Copy link

coveralls commented Jan 14, 2017

Coverage Status

Changes Unknown when pulling 6da4d9a on dist into ** on master**.

@balthazar balthazar mentioned this pull request Jan 15, 2017
"lint": "eslint src tests examples --ignore-pattern node_modules",
"test": "tape -r babel-register tests/**/*.js",
"cover": "nyc --reporter=text --reporter=html --reporter=lcov npm test"
},
Copy link
Contributor

Choose a reason for hiding this comment

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

I see that the examples and build-* scripts were removed. Are they no longer needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, they are no longer necessary.

@chrisirhc
Copy link
Contributor

@balthazar
Copy link
Contributor Author

Note that the current version of gh-pages is using the generated webpack bundles.

You only need to:

npm run docs

And it will build, checkout, commit, push and go back to master.

@chrisirhc
Copy link
Contributor

Also, please update this PR's description. What's the main goal of this PR? Once it's done, let's leave it at that. This PR is growing extremely large. What's the absolute necessary changes vs nice to haves?

data: [[1, 2, 3], [4, 5, 6]]
};

const noop = f => f;
Copy link
Contributor

Choose a reason for hiding this comment

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

prefer screaming snake case for constants

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah okay

README.md Outdated
npm install react-vis --save

Include the CSS from `./node_modules/react-vis/main` in your HTML page or via SASS:
Include the builded main CSS file in your HTML page or via SASS:
Copy link
Contributor

Choose a reason for hiding this comment

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

typo, *built

@balthazar balthazar force-pushed the dist branch 2 times, most recently from c5d3e62 to dc79e1a Compare January 17, 2017 23:33
@coveralls
Copy link

coveralls commented Jan 17, 2017

Coverage Status

Changes Unknown when pulling dc79e1a on dist into ** on master**.

Copy link
Contributor

@mcnuttandrew mcnuttandrew left a comment

Choose a reason for hiding this comment

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

I like all of what this does! It shuffles things around in a reasonable way. The one thing that I would ask, is that in the future you track what you are doing more deeply by filing issues about the changes you want to make.

- move index to dist
- beautify readme
- global author
- changelog in dedicated file
- resolve src directory for easier requires
- use latest node versions for Travis
- arch, es6 refactors
- coverage and publish to Coveralls
- package files, remove ignore and prepublish
- showcase using webpack
- add lockfiles
- simple doc generation

Closes #231.
Closes #208.
@coveralls
Copy link

coveralls commented Jan 18, 2017

Coverage Status

Changes Unknown when pulling 95c1e24 on dist into ** on master**.

@balthazar balthazar merged commit be4a34f into master Jan 18, 2017
balthazar pushed a commit that referenced this pull request Jan 18, 2017
- move index to dist
- beautify readme
- global author
- changelog in dedicated file
- resolve src directory for easier requires
- use latest node versions for Travis
- arch, es6 refactors
- coverage and publish to Coveralls
- package files, remove ignore and prepublish
- showcase using webpack
- add lockfiles
- simple doc generation

Closes #231.
Closes #208.
@balthazar balthazar deleted the dist branch January 18, 2017 01:54
ayarcohaila pushed a commit to ayarcohaila/react-vis that referenced this pull request Jun 30, 2021
- move index to dist
- beautify readme
- global author
- changelog in dedicated file
- resolve src directory for easier requires
- use latest node versions for Travis
- arch, es6 refactors
- coverage and publish to Coveralls
- package files, remove ignore and prepublish
- showcase using webpack
- add lockfiles
- simple doc generation

Closes uber#231.
Closes uber#208.
ayarcohaila added a commit to ayarcohaila/react-vis that referenced this pull request May 30, 2023
- move index to dist
- beautify readme
- global author
- changelog in dedicated file
- resolve src directory for easier requires
- use latest node versions for Travis
- arch, es6 refactors
- coverage and publish to Coveralls
- package files, remove ignore and prepublish
- showcase using webpack
- add lockfiles
- simple doc generation

Closes uber#231.
Closes uber#208.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants