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

Plug-in idea: Inject header comment #494

Open
glen-84 opened this issue Apr 28, 2021 · 1 comment
Open

Plug-in idea: Inject header comment #494

glen-84 opened this issue Apr 28, 2021 · 1 comment

Comments

@glen-84
Copy link
Contributor

glen-84 commented Apr 28, 2021

Tools like openapi-typescript insert a header comment like:

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

There may also be something else that you wish to insert, for example a directive to disable eslint, or similar.

Example config:

{
    "plugins": {
        "@dtsgenerator/header-comment": "/** Generated by dtsgenerator. Do not make direct changes to this file. */"
    }
}
@horiuchi
Copy link
Owner

That's a good idea.
It would be good to add a default comment as well.

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

No branches or pull requests

2 participants