Skip to main content
AsyncAPI Logo
Case StudiesBlogRoadmap
Star on GitHub
  • Welcome
    • Concepts
      • Overview
        • Server
          • Producer
            • Consumer
              • Channel
                • Application
                  • Protocol
                    • Message
                    • Tutorials
                      • Overview
                        • Getting Started
                          • Introduction
                          • Event-Driven Architectures
                          • Coming from OpenAPI
                          • Hello world
                          • AsyncAPI documents
                          • Servers
                          • Adding security
                        • Create AsyncAPI document
                          • Generate code
                            • Validate AsyncAPI document with Studio
                              • Message validation in runtime
                                • Streetlights - Interactive (Alpha)
                                • Tools
                                  • Overview
                                    • Generator
                                      • Introduction
                                      • Installation guide
                                      • Usage
                                      • AsyncAPI document
                                      • Template
                                      • Parser
                                      • Generator version vs template version
                                      • Library API
                                      • Template development
                                      • Configuration file
                                      • Template context
                                      • React render engine
                                      • Nunjucks render engine
                                      • Hooks
                                      • File templates
                                      • TypeScript support
                                      • Special file names
                                  • Guides
                                    • Overview
                                      • Validate AsyncAPI documents
                                        • Message validation
                                        • Reference
                                          • Overview
                                            • Specification
                                              • 3.0.0 (Pre-release)
                                              • 2.6.0
                                              • 2.5.0
                                              • 2.4.0
                                              • 2.3.0
                                              • 2.2.0
                                              • 2.1.0
                                              • 2.0.0

                                          Special file names

                                          Found an error? Have a suggestion?Edit this page on GitHub

                                          We use NPM behind the scenes to download and install the templates. Since NPM will not fetch files like .gitignore, you should name them differently. Luckily, the Generator will take care of renaming them back for you. The following is a table of the special file names:

                                          Special file nameOutput file name
                                          {.gitignore}.gitignore
                                          {.npmignore}.npmignore
                                          Go Back
                                          TypeScript support
                                          Up Next
                                          Guides - Overview
                                          Was this helpful?
                                          Help us improve the docs by adding your contribution.
                                          OR
                                          Create Issue on GitHub

                                          Building the future of
                                          Event-Driven Architectures.

                                          The Initiative

                                          • About
                                          • Blog
                                          • Shop
                                          • Jobs
                                          • Brand

                                          News

                                          • Email Us

                                          Social

                                          • Follow AsyncAPI on TwitterTwitter
                                          • AsyncAPI on GitHubGitHub
                                          • Follow AsyncAPI on LinkedInLinkedIn
                                          • Subscribe AsyncAPI on YouTubeYouTube
                                          • Join AsyncAPI on SlackSlack
                                          • Follow AsyncAPI on TwitchTwitch

                                          Made with :love: by the AsyncAPI Initiative.

                                          Copyright © AsyncAPI Project a Series of LF Projects, LLC. For web site terms of use, trademark policy and general project policies please see https://lfprojects.org

                                          Deploys by Netlify