Skip to content

docs(@angular-cli): update documentation for ng new #6480

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

Merged
merged 1 commit into from
Jun 12, 2017

Conversation

gioragutt
Copy link
Contributor

  • for several options that are saved in .angular-cli.json, I've added an explanation of what setting in the json file controls that options.
  • added an explanation about what --dry-run will output.
  • added possible values for --style option

The motivation for this change is that sometimes people would want to change some of the settings set by the cli durig ng new, that they might have not known or cared about, for example, prefix.

@delasteve
Copy link
Contributor

delasteve commented May 26, 2017

Could you also update the command documentation as well? Thanks!

https://github.com/angular/angular-cli/blob/master/packages/@angular/cli/commands/new.ts

@gioragutt
Copy link
Contributor Author

@delasteve where can I find your docs standards for code?

@delasteve
Copy link
Contributor

I was merely asking to update the descriptions on the commands. For example, styles.

https://github.com/angular/angular-cli/blob/master/packages/@angular/cli/commands/new.ts#L90

@gioragutt
Copy link
Contributor Author

Got it.

@gioragutt gioragutt force-pushed the patch-1 branch 3 times, most recently from 3336151 to 465fa86 Compare May 26, 2017 17:15
@gioragutt
Copy link
Contributor Author

@delasteve not used to this whole github ecosystem (we use gerrit at work, not working open source), but I've managed to figure this whole deal out. updated the command descriptions as well

@gioragutt gioragutt force-pushed the patch-1 branch 2 times, most recently from 858c86a to 30d8a0a Compare May 26, 2017 17:36
@gioragutt
Copy link
Contributor Author

Can I get a review on this?

The style file default extension. Possible values:
<ul>
<li>css</li>
<li>scss</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

styl is also possible for stylus.

Copy link
Contributor

Choose a reason for hiding this comment

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

As well as less

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so I have to add to both the docs and the command: styl and less? what about sass?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

as far as I can see, from commands/new.ts up until blueprints/ng/index.ts, there's only validation for stylus to change the extension to styl. Meaning that anyone can f.e put asdf and that would work. I also don't see any e2e testing for that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If I'm wrong and there's validation for that, please tell me. If not, I guess that's something that you should consider.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@filipesilva I've updated the PR commit with less and stylus as options. I've stated styl for stylus, but I've written styl (stylus) to make it clear that it's clear.

@filipesilva
Copy link
Contributor

@sumitarora please take a look.

@gioragutt
Copy link
Contributor Author

@sumitarora can I get a review on this? It would help me if this goes in, as I want to add similar docs in my other PR

filipesilva
filipesilva previously approved these changes Jun 12, 2017
@filipesilva
Copy link
Contributor

@gioragutt LGTM, thanks!

@gioragutt
Copy link
Contributor Author

@filipesilva when will this be merged to master? does this happen only on release? or is it something I have to do? I'm quite new to this, so I'd like some explanation if it's possible. And also any constructive criticism is always appreciated :)

@gioragutt
Copy link
Contributor Author

@filipesilva just noticed this was merged. Thanks a lot!

@gioragutt gioragutt closed this Jun 12, 2017
@filipesilva
Copy link
Contributor

It's in master already but will be published to the wiki next release.

@gioragutt gioragutt reopened this Jun 12, 2017
@filipesilva
Copy link
Contributor

Oh duh, sorry, yeah it was approved to be merged but hasn't been yet. My bad.

@gioragutt
Copy link
Contributor Author

gioragutt commented Jun 12, 2017

@filipesilva cool, I was worried for a second :P I'm pulling from master but nothing new is coming.

will the PR automatically close on merge?

@clydin
Copy link
Member

clydin commented Jun 12, 2017

Yes

@gioragutt
Copy link
Contributor Author

gioragutt commented Jun 12, 2017

@filipesilva by the way, i'm gonna update the commit - I've seen a tutorial on youtube where the dude uses sass as his styles, so I guess that's also worth mentioning in the docs

* for several options that are saved in .angular-cli.json, I've added an explanation of what setting in the json file controls that options.
* added an explanation about what --dry-run will output.
* added possible values for --style option
* added respective documentation in the command
* also added less, sass and styl(stylus) as possible style extensions

The motivation for this change is that sometimes people would want to change some of the settings set by the cli durig ng new, that they might have not known or cared about, for example, prefix.
@Brocco Brocco merged commit e87598e into angular:master Jun 12, 2017
@gioragutt gioragutt deleted the patch-1 branch June 12, 2017 14:07
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2019
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.

7 participants