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: add Deno.ConfigFile #24630

Closed
wants to merge 3 commits into from
Closed

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Jul 18, 2024

Note: this hasn't yet reached consensus.

Closes #24628

Comment on lines +6698 to +6700
* Note: It is recommended to only use this interface when dynamically
* importing a JSON file that is not analyzable, as analyzable imports of JSON
* files provide file-based type-hinting and autocompletion anyway.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I should be fact-checked on this, namely if the wording is accurate. These are based on what I found on my machine.

Comment on lines +6692 to +6693
// To update, input the contents of `cli/schemas/config-file.v1.json` into
// https://transform.tools/json-schema-to-typescript
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Naturally, the question would arise: how do we keep this interface up-to-date?

@iuioiua iuioiua marked this pull request as ready for review July 18, 2024 01:00
Copy link
Member

@dsherret dsherret left a comment

Choose a reason for hiding this comment

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

I'm against this: #24628 (comment)

*
* @category Runtime
*/
export interface ConfigFile {
Copy link
Member

Choose a reason for hiding this comment

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

This would be good to publish on JSR. For example, someone could generate this type from the deno schema file and have it behind a versioned API.

@iuioiua
Copy link
Collaborator Author

iuioiua commented Sep 3, 2024

Closing as I think there's insufficient demand for this.

@iuioiua iuioiua closed this Sep 3, 2024
@iuioiua iuioiua deleted the deno-config-file branch September 3, 2024 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

proposal: add Deno.ConfigFile
2 participants