Skip to content

Change default document directory to obj #4945

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.

Sign up for GitHub

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

Jump to bottom
Closed
glennc opened this issue Nov 19, 2018 · 2 comments
Closed

Change default document directory to obj #4945

glennc opened this issue Nov 19, 2018 · 2 comments
Assignees
@dougbu
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates Done This issue has been fixed enhancement This issue represents an ask for new feature or an enhancement to an existing one
Milestone
3.0.0-preview5

Comments

@glennc
Copy link
Contributor

glennc commented Nov 19, 2018

Today the directory that we store the API document is empty, meaning that we put it in the root of the project. For this type of asset, one that is purely used to make sure we don't redo work we don't need to, I think obj is a better default.
@aspnet-hello aspnet-hello transferred this issue from aspnet/Mvc Dec 14, 2018
@aspnet-hello aspnet-hello assigned dougbu and unassigned dougbu Dec 14, 2018
@aspnet-hello aspnet-hello added this to the ClientCodeGen milestone Dec 14, 2018
@aspnet-hello aspnet-hello added 1 - Ready area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates enhancement This issue represents an ask for new feature or an enhancement to an existing one labels Dec 14, 2018
@dougbu dougbu added the cost: XS label Jan 9, 2019
@mkArtakMSFT mkArtakMSFT modified the milestones: ClientCodeGen, 3.0.0-preview4 Feb 6, 2019
@glennc
Copy link
Contributor Author

glennc commented Apr 1, 2019

  1. Is it fine to leave the code generation default to the root of the client project? Yes.
  2. Will users by default check the documents in on the server project? Because if yes, we should put it in root. I think we should start with no until people tell us otherwise. So the server doc would go to into obj or somewhere not visible by default.

@glennc glennc modified the milestones: 3.0.0-preview4, 3.0.0-preview5 Apr 1, 2019
dougbu added a commit that referenced this issue Apr 19, 2019
@dougbu
Rename all the service reference things
7e28551 
- #7492
- remove document generation from client project; will be included in Web API project infrastructure (coming soon)

Also
- provide `%(FirstForGenerator)` metadata, #4916
- add `$(OpenApiGenerateAtDesignTime)` property (default `true` for now), #4944
- generate code in `obj` directory by default, #4945
@dougbu dougbu mentioned this issue Apr 19, 2019
Merged
dougbu added a commit that referenced this issue Apr 19, 2019
@dougbu
Rename all the service reference things
50f618c 
- #7492
- remove document generation from client project; will be included in Web API project infrastructure (coming soon)

Also
- provide `%(FirstForGenerator)` metadata, #4916
- add `$(OpenApiGenerateAtDesignTime)` property (default `true` for now), #4944
- generate code in `obj` directory by default, #4945
dougbu added a commit that referenced this issue Apr 22, 2019
@dougbu
Rename all the service reference things
f09d06c 
- #7492
- remove document generation from client project; will be included in Web API project infrastructure (coming soon)

Also
- provide `%(FirstForGenerator)` metadata, #4916
- add `$(OpenApiGenerateAtDesignTime)` property (default `true` for now), #4944
- generate code in `obj` directory by default, #4945
dougbu added a commit that referenced this issue Apr 22, 2019
@dougbu
Fixup included #4916 fix
cf15e12 
- set `%(FirstForGenerator)` based on `%(CodeGenerator)` metadata

Side note, PR fixes include
- add `%(FirstForGenerator)` metadata, #4916
- add support for disabling design-time builds, #4944
- change default output directory to `obj/`, #4945 1 of 2 (remainder will come with #8242)
- provide a default `%(CodeGenerator)` value, ##7491 1 of 2 (remainder will come in next milestone)
dougbu added a commit that referenced this issue Apr 22, 2019
@dougbu
Rename all the service reference things (#9559)
ce8f053 
- #7492
  - remove document generation from client project; will be included in Web API project infrastructure (coming soon)
  - adjust eng/ProjectReferences.props to new project name
  - simplify item de-duplication in `_CreateCompileItemsForServiceFileReferences` target i.e. use `Remove` attribute
    - also handle `.tsx` files in this target
- provide `%(FirstForGenerator)` metadata, #4916
- add `$(OpenApiGenerateAtDesignTime)` property (default `true` for now), #4944
- generate code in `obj` directory by default, #4945
- provide a default `%(CodeGenerator)` value, ##7491 1 of 2 (remainder will come in next milestone)

nits:
- remove a useless `StringBuilder.Append(...)` call
- remove `%(OpenApiProjectReference.SourceProject)` metadata, duplicated `%(OriginalItemSpec)`
- be more consistent about using element syntax for item metadata
@dougbu dougbu added the Done This issue has been fixed label Apr 22, 2019
@dougbu
Copy link
Contributor

dougbu commented Apr 22, 2019

ce8f053 addresses code generation location. Will add a note to remind me to include documents location in #8242

@dougbu dougbu closed this as completed Apr 22, 2019
@dougbu dougbu mentioned this issue Apr 22, 2019
Closed
4 tasks
@ghost ghost locked as resolved and limited conversation to collaborators Dec 3, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@dougbu dougbu

Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates Done This issue has been fixed enhancement This issue represents an ask for new feature or an enhancement to an existing one
Projects
None yet
Milestone
3.0.0-preview5
Development

No branches or pull requests
4 participants
@glennc @dougbu @mkArtakMSFT @aspnet-hello