imliam / vscode-fileflow

An extension for Visual Studio Code that lets you quickly flow between files, allowing you to make smooth coding presentations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

File Flow for VSCode

File Flow for VSCode

An extension for Visual Studio Code that lets you quickly flow between files, allowing you to make smooth coding presentations.

Commands supplied by File Flow

File Flow is designed to make it easier to give presentations within VSCode itself. You can prepare some files and seamlessly transition through them from one to the next with a quick key press.

Think of it like very simple slideshows for VSCode.

Commands

The primary functionality of File Flow lies in the "Go to Next File" command (think of this as going to the next slide). This command will find the next file in your current directory and open it in the editor window.

Command Description
Go to Next File
fileFlow.goToNextFile
Open the next file in the current directory
Go to Previous File
fileFlow.goToPreviousFile
Open the previous file in the current directory
Go to Next Folder
fileFlow.goToNextFolder
Open the first file in the next folder of the parent directory
Go to Previous Folder
fileFlow.goToPreviousFolder
Open the last file in the previous folder of the parent directory
Go to First File
fileFlow.goToFirstFile
Open the first file in the current directory
Go to Last File
fileFlow.goToLastFile
Open the last file in the current directory

ℹ️ Try binding the goToNextFile and goToPreviousFile commands to keyboard shortcuts to make presenting your code smoother!

Out of Bounds

What happens when you're on the last file in a directory and you try to go to the next file? Or if you're on the first file and you try to go back? There are some settings to decide how you want to handle this:

  • fileFlow.none will not do anything, keeping the current file in view
  • fileFlow.loopCurrentFolder will go back to the first or last file in the current directory
  • fileFlow.goToNextFolder will automatically find the first file in the next subdirectory of the parent directory
    • You might want to use this if you have multiple "chapters" of a presentation and want to separate them but still be able to transition smoothly from one to the next
    • Check the examples/subfolders directory to see how this might work

Previews

By default, VSCode will display the selected file in the regular code editor, but if you change the fileFlow.previewFiles setting from none to all or custom, File Flow will automatically open them in preview mode.

ℹ️ If you set this option to custom, File Flow will only try to preview the specific file extensions you choose in the fileFlow.previewCustomFileExtensions setting. By default, this includes .md and .html files.

This means you can have beautiful markdown or HTML files rendered inline, allowing you to have great title slides without limitations.

It even supports HTML!

Write some CSS inline, or pull in a CSS library to make it work; the only limit is HTML!

Credits / Links

License

The MIT License (MIT). Please see the license file for more information.

About

An extension for Visual Studio Code that lets you quickly flow between files, allowing you to make smooth coding presentations

License:MIT License


Languages

Language:TypeScript 89.3%Language:JavaScript 10.7%