Skip to content

johyunchol/intellij-index-generator-plugin

Repository files navigation

Index Generator Plugin

The Index Generator Plugin is a plugin for IntelliJ IDEA that simplifies the process of generating an index.ts file in your TypeScript projects. It provides a convenient action to generate the index file with export statements for default exports from TypeScript files in the selected directory.

Features

  • Generates an index.ts file with export statements for default exports in TypeScript files.
  • Works by right-clicking on a directory and selecting the "Generate index.ts" action.
  • Supports customization of the generated file through the plugin configuration.

Installation

You can install the Index Generator Plugin directly from the IntelliJ IDEA Plugin Marketplace.

  1. Go to Preferences or Settings in IntelliJ IDEA.
  2. Navigate to the Plugins section.
  3. Click on the Marketplace tab.
  4. Search for "Index Generator" in the search bar.
  5. Click on the Install button next to the plugin.
  6. Restart IntelliJ IDEA to apply the changes.

How to Use

  1. Right-click on a directory in your TypeScript project.
  2. Select the "Generate index.ts" action from the context menu.
  3. An index.ts file will be generated in the selected directory.
  4. The file will contain export statements for default exports from TypeScript files in the directory.

Configuration

The Index Generator Plugin provides a configuration to customize its behavior.

  1. Go to Preferences or Settings in IntelliJ IDEA.
  2. Navigate to the Tools section.
  3. Select Index Generator from the left menu.

In the configuration settings, you can:

  • Specify the icon for the "Generate index.ts" action.
  • Customize the text and description of the action.
  • Configure the tool window behavior and appearance.

Contributing

Contributions to the Index Generator Plugin are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the GitHub repository.

License

This plugin is open-source and is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages