Always output into its own directory #302

Closed
FWeinb opened this Issue Dec 31, 2014 · 9 comments

Comments

Projects
None yet
4 participants
@FWeinb
Member

FWeinb commented Dec 31, 2014

Moving issues from SassDoc/gulp-sassdoc#8

Quote @ben-eb

.
├── README.md
├── assets
│   ├── css
│   └── js
└── sassdoc
    ├── assets
    └── index.html

This is a clearer, more intuitive way of running the software. Not only do the force and interactive operations become obsolete, but we tell the user that their documentation by default creates a folder for itself, and subsequent runs will update that folder.

And @HugoGiraudel :

If we are willing to do this, make the folder name customisable, and chose a secure default (i.e. not sassdoc).

JsDoc is doing it this way too.

@FWeinb FWeinb added the Improvement label Dec 31, 2014

@FWeinb FWeinb added this to the 2.0 milestone Dec 31, 2014

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jan 2, 2015

Member

@SassDoc/owners Who takes this?

Member

HugoGiraudel commented Jan 2, 2015

@SassDoc/owners Who takes this?

@FWeinb FWeinb referenced this issue Jan 2, 2015

Closed

[Meta] Development SassDoc 2.0 #255

20 of 20 tasks complete
@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jan 2, 2015

Member

I can, but probably not before next week.

Member

valeriangalliat commented Jan 2, 2015

I can, but probably not before next week.

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Jan 2, 2015

Member

I can, but probably not before next week.

Would be nice if @valeriangalliat could tackle this, and I would prefer to land the stream refacto before, so I don't have to rebase/redo that another time :) It's already been too much sliced till now.

Member

pascalduez commented Jan 2, 2015

I can, but probably not before next week.

Would be nice if @valeriangalliat could tackle this, and I would prefer to land the stream refacto before, so I don't have to rebase/redo that another time :) It's already been too much sliced till now.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jan 2, 2015

Member

Alright. @valeriangalliat, your move.

Member

HugoGiraudel commented Jan 2, 2015

Alright. @valeriangalliat, your move.

@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jan 4, 2015

Member

Why not sassdoc as default? There's little chance such a folder already exists, right?
Otherwise, we can name it out like JSDoc maybe?

I'm going for out now. We can change it later.


Also I'm realizing this issue is way more straightforward than I thought. While it's entitled "Always output into its own directory", practically, it's just "Make <dest> an option instead of an argument, give it a default value, and remove --interactive and --force".

Member

valeriangalliat commented Jan 4, 2015

Why not sassdoc as default? There's little chance such a folder already exists, right?
Otherwise, we can name it out like JSDoc maybe?

I'm going for out now. We can change it later.


Also I'm realizing this issue is way more straightforward than I thought. While it's entitled "Always output into its own directory", practically, it's just "Make <dest> an option instead of an argument, give it a default value, and remove --interactive and --force".

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Jan 4, 2015

Member

I am all for sassdoc. But what we want is always append the folder sassdoc. Even if the user has supplied a path.

Member

FWeinb commented Jan 4, 2015

I am all for sassdoc. But what we want is always append the folder sassdoc. Even if the user has supplied a path.

valeriangalliat added a commit to SassDoc/sassdoc.github.io that referenced this issue Jan 4, 2015

Make `dest` on option instead of an argument
Also remove `--interactive` and `--force` which are not needed anymore.

* See SassDoc/sassdoc#302
@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jan 4, 2015

Member

From what I understood, there's no more dest argument, it's rather an option defaulting to out.

So sassdoc src will create out in the CWD, and sassdoc src --dest doc will put the documentation in doc.

Member

valeriangalliat commented Jan 4, 2015

From what I understood, there's no more dest argument, it's rather an option defaulting to out.

So sassdoc src will create out in the CWD, and sassdoc src --dest doc will put the documentation in doc.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jan 4, 2015

Member

Sounds good. Go for sassdoc as a default.

Member

HugoGiraudel commented Jan 4, 2015

Sounds good. Go for sassdoc as a default.

valeriangalliat added a commit to SassDoc/sassdoc.github.io that referenced this issue Jan 4, 2015

Make `dest` on option instead of an argument
Also remove `--interactive` and `--force` which are not needed anymore.

* See SassDoc/sassdoc#302
@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jan 4, 2015

Member

Okay, I just ammended the PRs to replace out with sassdoc.

Member

valeriangalliat commented Jan 4, 2015

Okay, I just ammended the PRs to replace out with sassdoc.

@pascalduez pascalduez referenced this issue in SassDoc/grunt-sassdoc Feb 25, 2015

Closed

force vs no-prompt #7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment