Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README not copied when building the library #11

Open
caroso1222 opened this issue Apr 2, 2018 · 7 comments
Open

README not copied when building the library #11

caroso1222 opened this issue Apr 2, 2018 · 7 comments

Comments

@caroso1222
Copy link
Owner

The README.md must be copied over to /dist, otherwise the npm registry page will show an empty description. This is bad as the package won't properly appear in searches.

@NetanelBasal
Copy link
Contributor

@caroso1222
Copy link
Owner Author

Good catch, not sure why it's not properly working then, need to debug it thoroughly. By any chance, did it work for you when running npm run build:lib? Maybe you wanted to get rid of the readme file on purpose and I missed it?

@NetanelBasal
Copy link
Contributor

Actually not, I checked it and it does not copy the README file.

@NetanelBasal
Copy link
Contributor

The first link was a mistake, it's the schematics library gulpfile, not the library that uses it. We should check https://github.com/caroso1222/ng-lib-schematics/blob/master/src/lib-standalone/files/lib/__path__/build-tools/gulpfile.js#L72

@NetanelBasal
Copy link
Contributor

I think I know what the problem is. You are coping the whole lib files but the README file is in the root of the CLI project. You need to copy it from there.

@caroso1222
Copy link
Owner Author

Yeah, definitely. I'll create a gulp.task('copy:readme') to copy over that file. I was wondering, do you think we'll need to copy LICENSE as well (if applicable)? I've seen it in many node packages within node_modules.

@NetanelBasal
Copy link
Contributor

Yes, it's nice to have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants