Auto Barrel adds support for creating a barrel (index.[tj]s) in a folder and optionally keeping it up to date automatically.
Please note the *raison d'etre' for this extension is the Automated maintenance of barrel files. While it provides two commands for creating and updating barrel files it was not intended for manual barrel management. There are several other extensions that may provide better support for manual barrel management.
Create Barrel - Right click on any folder in Explorer viewlet and this command allows you to create a new barrel with export statements for all other modules of the same language or Vue.js modules.
Auto Barrel - Start - From the command pallete execute this command to have Auto Barrel automatically add and delete export statements as files are added or deleted from the folder.
Auto Barrel - Stop - From the command pallete execute this command to stop automatic management of barrel files.
Update Barrel - Righ click on a barrel file in Exporer viewlet and this command allows you to update the barrel to include new files added manually. Perfect if you forget to start Auto Barrel before adding new files.
You can also prevent Auto Barrel from treating existing index.[tj]s files as barrels by adding a comment to the file
As of v1.4.0 Auto Barrel supports including files in sub folders in a barrel file. When Auto Barrel - Start is active and this feature is enabled (it is enabled by default) Auto Barrel walks up the folder tree to find the nearest ancestor index.[jt]s file to manage. This can lead to a file with the name index.* being incorrectly identified as a barrel. If this happens the file will need to be excluded using either the setting or an appropriate comment as described below.
As of v1.5.0 Auto Barrel recognises barrel files in nested folders and imports the folder rather than individual files in the folder. However this requires recursive barrelling to be enabled.
The following settings can be configured to control the behaviour of Auto Barrel.
This defaults to false. If this is set to true then the Create Barrel command will not attempt to determine the language extension it will create a barrel file with the appropriate language specified.
For example to ignore .js files change it to **/src/**/.ts* or to ignore .ts files change it to ***/src/**/.ts
A comma separated list of path fragments that should be ignored. This defaults to .spec,.test so that test files located next to the source file are not included in barrels as is the default when using tools such as angular-cli to generate components.
The setting is used to prevent files where the full path contains any of the fragments from being added to new or existing barrel files.
This defaults to false. If this is set to true then instead of simply exporting files included in the barral like this
We import the file with an alias derived from the name and export the alias something like this
The alias uses both dots and hyphens as word separators to build the alias. A file name like login-page.actions will result in an alias of LoginPageActions
This defaults to false.
If this is set to true then files in sub folders below the barrel file will not be included when using the Create Barrel command. Also when the Auto Barrel - Start command is active only barrel files in the same folder as a new or deleted file will be affected, Auto Barrel will not walk up the folder tree looking for a barrel file.
This defaults to false.
If enabled then semi colons will not be included at the end of statements generated in barrel files.
This defaults to '.vue';
This should be a comma separated string of extensions (including the dot) that should be included on generating an export statement. When a file is processed if the extension is included in this list then the extension will be included in the file path of the export statement.
Ignoring Potential Barrel Files
If your workspace/s contain existing index.ts or index.js files that are matched by the autoBarrel.watchGlob pattern, but they are not barrel files you can tell Auto Barrel to ignore them during automatic monitoring by adding the following comment as the first line of the file.
If Auto Barrel detects a file creation in a folder containing a potential barrel file and the barrel file contains this comment as the first line it will abort processing and make no further attempt to add an export for the new file. This can also be achieved using the ignoreFilePathContainingAnyOf setting introduced in v1.0.3 but this method is still valid.
If you would like to have Auto Barrel start monitoring for changes when you open a workspace we recommend the excellent Auto Run Command extension. With the extension installed simply add a rule something like this to User Settings