Restructure project src & fixed some other issues #27
Conversation
| public/ | ||
|
|
||
| test/test.js | ||
| dist/ |
There was a problem hiding this comment.
I'm not sure if dist should be ignored. If someone pulls this package in via different means, this forces them to create the output files themselves.
There was a problem hiding this comment.
In general, we should always avoid committing dist or build stuff. For GitHub users, we can publish distributions to the release page so that they can directly download the distribution without clone the whole repo.
There was a problem hiding this comment.
Had completely forgot about attaching files to the release 😄 great shout!
Makefile
Outdated
| @@ -13,8 +13,8 @@ GHPAGES = $(MODULES)/gh-pages | |||
|
|
|||
| DEST = dist | |||
| FILE_NAME = ep | |||
| SCRIPT_SRC = src/script/entries/ep/index.js | |||
| STYLE_SRC = src/script/entries/ep/ep.scss | |||
| SCRIPT_SRC = src/script/entries/ep/scripts/index.js | |||
There was a problem hiding this comment.
I should have maybe been more clear in my wording within the issue. My aim was to make the structure more intuitive in the sense of extracting styles from the src/script folder.
Something like;
- src
- script
- index.js
- styles
- ep.scss
| @@ -4,6 +4,7 @@ | |||
| "description": "enhance your progress bars with minimal effort!", | |||
| "main": "dist/ep.js", | |||
| "scripts": { | |||
| "prepublish": "make dist", | |||
There was a problem hiding this comment.
If I understand correctly, this is why dist has been ignored? It's assumed that a user will pull the package in via npm and therefore creating the dist output prepublish makes it available to those who pull in via npm etc.?
There was a problem hiding this comment.
Yep, this script make npm build the package before it is published to the npm central repository, therefore after npm users installing the package, the dist will just be there. In this way, we can guarantee that the build is always newest and relax us from manually building.
|
@jh3y Okay, done. |
|
imo, semver should've changed to 2.1 with this change -- mainly because bower installs are broken if were relying on the dist/ files as bower doesn't build them out with current config. I have a production site I had to lock in to 2.0.3 as ^2.0.3 on a fresh install updated it which lost the dist files in which we relied on. I'll figure it out in some free time and patch it so bower install is no longer without any dist files. |
Fixes #25.
Changes include:
.gitignorefile@jh3y