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

code intelligence for config file #4

Open
Zain-ul-din opened this issue Jan 23, 2023 · 0 comments
Open

code intelligence for config file #4

Zain-ul-din opened this issue Jan 23, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers proposal general proposal

Comments

@Zain-ul-din
Copy link
Member

General Proposal

Our code-generator require randoms.config.json to read the config provided by the user.

But there is no code intelligence for that I propose to have a JS file instead of a JSON file we can use TS type annotation comment to enable code intelligence.

Example

export type from our package

export default interface ConfigType { /* Config Type */}

randoms.config.js will looks like

 /** @type {import('package').ConfigType} */
 module.exports = { /* config */ }
@Zain-ul-din Zain-ul-din added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers proposal general proposal labels Jan 23, 2023
@Zain-ul-din Zain-ul-din added this to the Code-Generator 3.0.1 milestone Jan 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers proposal general proposal
Projects
Development

No branches or pull requests

2 participants