Utopian Task Completion: Steem Editor
Repository
https://github.com/BuildTeamDev/steem-editor
New Features
The original task in question here was seeking the help of someone to upgrade the current project from an old version of Babel to the latest, version 7. The task also requested help upgrading from Webpack 2 to the latest version Webpack 4. The issue for this on Github can be found here: https://github.com/BuildTeamDev/steem-editor/issues/1
A summary of the changes can be found in the PR itself as well as below:
- Webpack configuration has changed to account for deprecated features from Webpack 2 and changes to module syntax
- Extract text CSS plugin has been removed and replaced with the recommended
mini-css-extract-plugin - Babel has been upgraded to version 7
- Using @babel/preset-env which automatically handles modules and needed features based on targeted browsers as opposed to features
- Numerous babel plugins deprecated or no longer existent have been removed
- PostCSS configuration has been cleaned up for use in modules without duplication
- Cleaned up mixed use of Node style requires and ES style imports. The app now uses ES style imports
- Updated numerous out of date packages
The refactoring and improvements in question have been submitted here in a pull request I have submitted and has been merged: https://github.com/BuildTeamDev/steem-editor/pull/2
Hello, could you prove that Vheissu is your github account?never mind, found previous utopian contributionThank you for your review, @justyy! Keep up the good work!
Thank you @beggars for your contribution. In theory, the dist/ files js/css are not meant to be uploaded (instead, they are generated via webpack) but I can see this is not your fault.
Some files contain Chinese comments and some comments containing license are removed - not sure this is what intended.
Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Chat with us on Discord.
[utopian-moderator]
Hi justyy,
Thanks for the feedback. Correct, built files were already being shipped in the package. I believe the reason for doing this is to allow the Git repository itself to be installable without needing Npm.
Chinese comments were a prior artefact, in some cases, they were not needed. The text at the top of the Webpack file was removed, as it is an entirely new file. Going from Webpack 2 to 4, the differences were so great I started new files from scratch and gradually ported loaders and config options.
Webpack configuration files should be mostly undocumented, as they're expressive and implicit already (following documented conventions). Only specific instances like chunk configuration and other complex things should be commented, I believe. Everyone has their personal preference.
The existing comment at the top was also too detailed. Git is intended to show you who and when a file was changed, so much of the prior information was redundant. Configuration files also do not fall under copyright, as they're not unique.
As per MIT licence requirements, a LICENSE file exists in the root of the repository with the licence in question. A comment with copyright notice is not a requirement under the MIT licence, it's one of the most "open" open source licences out there (I love it).
Thanks again. Nice thorough review. You're doing a great job for @utopian-io
Hi @beggars!
Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server