πŸ“„ 'Advanced New File' extension for Visual Studio Code
Clone or download

README.md

Build Status All Contributors Version Installs Ratings

logo

Advanced New File - Visual Studio Code Extension

Making the creation of a new file even easier. Specify the name of the file on creation and if you define a path that doesn't exist yet the folders will be created. Before using the extension please make sure to read the Disclaimer.

Inspired by Scott Kuroda's AdvancedNewFile for Sublime.

How to use

demo

  1. a) Press the Shortcut Cmd+Alt+N or run the Files: Advanced New File command.

  2. b) Right click in the explorer menu and choose 'Advanced New File'.

  3. Enter a relative file path or stick with the default. If you have a file open it will guess the extension based on the current extension.

  4. An empty file will be created and the cursor will be placed into the new file.

  5. Happy Coding! :)

Configuration

You can configure the default behavior through various settings in your settings.json:

{
  "newFile.defaultBaseFileName": "newFile",
  "newFile.relativeTo": "file", // "root" or "project"
  "newFile.defaultFileExtension": ".ts",
  "newFile.rootDirectory": "~",
  "newFile.showPathRelativeTo": "root", // "project" or "none"
  "newFile.expandBraces": false // setting to true will allow for creating multiple files such as `new-folder/{file1,file2}.js`
}

You can also set a new keyboard shortcut for the command in keybindings.json:

[
  {
    "key": "cmd+n",
    "command": "newFile.createNewFile"
  }
]

Frequently Asked Questions (FAQ)

The dialog closes everytime I switch windows. Is this intended?

This is the default behavior of VS Code. To not close the input box when removing focus from VSCode, you need to add "workbench.quickOpen.closeOnFocusLost": false in your settings file. Setting it to true will result in the dialogs like the "Quick Open" to automatically close once it loses focus.

How to contribute

  1. Download source code and install dependencies
git clone git@github.com:dkundel/vscode-new-file.git
cd vscode-new-file
npm install
code .
  1. Make the respective code changes.
  2. Go to the debugger in VS Code, choose Launch Extension and click run. You can test your changes.
  3. Choose Launch Tests to run the tests.
  4. Submit a PR.

Backlog

  • Add additional tests

Disclaimer

Important: This extension due to the nature of it's purpose will create files on your hard drive and if necessary create the respective folder structure. While it should not override any files during this process, I'm not giving any guarantees or take any responsibility in case of lost data.

Contributors

Thanks goes to these wonderful people (emoji key):


Carl Henderson

πŸ’»

Chris Walker

πŸ’»

Telokis

πŸ’»

Patrick Hulce

πŸ’» πŸ€”

Sarbbottam Bandyopadhyay

πŸ’» πŸ€” πŸ›

Kian Ostad

πŸ€”

Harry Coultas Blum

πŸ›

David Khourshid

πŸ’»

Ngoc Pham

πŸ›

Akshay Kadam

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT