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

feat(js): added a minimal option to the library generator #13561

Merged
merged 1 commit into from
Mar 3, 2023

Conversation

Phillip9587
Copy link
Contributor

@Phillip9587 Phillip9587 commented Dec 1, 2022

Current Behavior

When generating libraries i have no option to skip the generation of the README.md file. I have to delete the file by hand if I don't want it.

When generating buildable libraries a entry is added to the assets array of the build target. I have to delete that manually to if I want a clean project.json/workspace.json without unnecessary entries.

These often unnecessary generated READMEs add extra vertical space to a opened lib.

Expected Behavior

I set the includeReadme flag to false when generating libs and end up with a lib without a README.md and without a assets property in the build targets options when generating a buildable lib.

includeReadme defaults to true so nothing has changed when not specifing this option.

I just implemented it for the @nrwl/js:library generator but I am willing to submit follow-up PRs if this gets merged.

@vercel
Copy link

vercel bot commented Dec 1, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
nx-dev ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 3, 2023 at 6:52PM (UTC)

},
outputs: ['{options.outputPath}'],
});
describe('--buildable', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The following test are not changed. The desribe('--buildable', () => { block was nested into the describe('--unit-test-runner jest', () => { which was wrong I think. I removed the nesting.

@jaysoo
Copy link
Member

jaysoo commented Jan 25, 2023

Hi @Phillip9587 can we rename the option to --minimal? We started adopting a minimal setup option for many of our generators to skip boilerplate.

Happy to review again once updated, or we can add this flag in another PR.

@Phillip9587 Phillip9587 changed the title feat(js): added a includeReadme option to the library generator feat(js): added a minimal option to the library generator Jan 25, 2023
@Phillip9587
Copy link
Contributor Author

@jaysoo Updated it. Can you review it please?

@Phillip9587
Copy link
Contributor Author

CI Failure is not related to this PR i think.

@jaysoo jaysoo merged commit 8c1d035 into nrwl:master Mar 3, 2023
FrozenPandaz pushed a commit that referenced this pull request Mar 3, 2023
@github-actions
Copy link

github-actions bot commented Mar 9, 2023

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants