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

[core/tools/project-json.md] Add missing properties to the project.json schema #797

Closed
6 of 10 tasks
mairaw opened this issue Jul 14, 2016 · 2 comments
Closed
6 of 10 tasks
Assignees
Labels
doc-enhancement Improve the current content [org][type][category] Pri0 Indicates issues or PRs that are critical priority

Comments

@mairaw
Copy link
Contributor

mairaw commented Jul 14, 2016

The project.json schema reference still needs work.

I went through the entire schema file and these are the improvements that I think are needed:

  • buildOptions\languageVersion: as mentioned on PR Starting the PJ schema changes #448 , languageVersion seems to accept csharp1...csharp6 and experimental. Our topic doesn't mention that and shows an example with the value 5 instead. Need to confirm which one is correct (or both are accepted?)
  • For the properties such as embed and copyToOutput that just have the same properties as buildOptions/compile, should we move that content to an include file or maybe just mention the properties have the same definition instead of copy/pasting the content multiple times? Answer: I'll leave as-is since project.json will go away eventually.
  • The projectUrl property is listed inside packOptions in our topic. In the schema, that property is listed at the top-level. Only the other url properties were deprecated and moved inside packOptions according to the schema file. Which one is correct? Answer: This seems another case where the schema is outdated. CLI uses projectUrl inside packOptions.
  • Add missing events to the scripts property: prepack, postpack, prerestore, postrestore and prepare. Answer: Actually CLI doesn't use any of those so the schema is probably outdated)
  • Add missing properties: preprocessFiles, sharedExclude, sharedFiles, runtimes and userSecretsId. Answer: added runtimes and userSecretsId, not clear if I need the others.
  • Property frameworks needs to be improved to say exactly which other sections are included and review its properties. Answer: removed imports and added the dependencies properties.
  • remove wrappedProject property? Schema doesn't list this one. Answer: no, this is consumed by the CLI code.
  • is there a property called name? We list it in the doc but I don't see it in the schema. Answer: we should keep name in the docs
  • Expand on the “target” property of a dependency. In particular, how would “project” work vs “package”?
  • Is there a way to get a floating version to include pre-release package versions when restoring? E.g., 0.* fails to find my package (which is only published in pre-release), but 0.1.1-* finds it just fine.
  • There's also a customer question about scripts on the article that I don't know the answer:
    "scripts":{"postcompile":["my.bat %configuration%"]}.
    I want provide configuration type (such as Debug or Development etc.) as a parameter in the batch file.
    How do I this?
    There are only three options available and they are related with project property only.
@mairaw mairaw self-assigned this Jul 14, 2016
@mairaw mairaw added doc-enhancement Improve the current content [org][type][category] Pri0 Indicates issues or PRs that are critical priority labels Jul 14, 2016
@mairaw mairaw added this to the Future milestone Jul 14, 2016
@bradygaster-zz bradygaster-zz removed this from the Future milestone Jul 22, 2016
@mairaw mairaw added this to the September-2016 milestone Sep 22, 2016
@mairaw
Copy link
Contributor Author

mairaw commented Oct 6, 2016

I've merged PR #1071 since it takes care of a bunch of issues with the topic, but we still have some pending. I'm moving this now to backlog until I can get the answers to finish this work item.

@mairaw mairaw modified the milestones: Backlog, September-2016 Oct 6, 2016
@mairaw
Copy link
Contributor Author

mairaw commented Mar 23, 2017

No longer applicable.

@mairaw mairaw closed this as completed Mar 23, 2017
@mairaw mairaw removed this from the Backlog milestone Mar 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] Pri0 Indicates issues or PRs that are critical priority
Projects
None yet
Development

No branches or pull requests

2 participants