Skip to content

Auto Import Relative Path is a time-saving extension that simplifies importing relative paths in your code. With this tool, you can easily import files without the need to type out lengthy and complex paths. It's a great solution for projects of any size and can help streamline your workflow.

License

Notifications You must be signed in to change notification settings

ElecTreeFrying/auto-import-relative-path

Repository files navigation

Auto Import Relative Path (vscode extension)

Current version of Auto Import Relative Path Current installs of Auto Import Relative Path Current downloads of Auto Import Relative Path Current ratings of Auto Import Relative Path

Auto Import Relative Path, is an extension for VS Code that makes importing relative paths much easier and less tedious. With this extension, you can say goodbye to long and complicated import statements and file paths. It provides a simple and efficient way to import files without having to manually type out the entire path. Whether you're working on a small project or a large one with many files, this extension can save you a lot of time and effort

Supported file extensions

File extension
Programming Language .js, .jsx, .ts, .tsx
Markup Language .html, .md
Stylesheet .css, .scss

Usage

  1. Press Ctrl+Shift+A on a file in Explorer, then press Ctrl+I in your active text editor to import it. → Click here to see it in action.
  2. Alternatively, press Alt+D to automatically import the file in your active text editor. → Click here to see it in action.

auto-import-demo

Active text editor Supported file extensions More examples
.html .js, .css, .gif, .jpeg, .jpg, .png, .webp click here
.md self, .gif, .jpeg, .jpg, .png, .webp click here
.js, .ts self
.jsx self, .js, .json
.css,.sass .scss
.png, .jpg, .gif, .svg, .webp
.woff, .woff2, .ttf, .eot
.md, .yml, .yaml, .html
.tsx self, .ts, .js, .json
.css, .sass .scss
.png, .jpg, .gif, .svg, .webp
.woff, .woff2, .ttf, .eot
.md, .yml, .yaml, .html
.css self, .gif, .jpeg, .jpg, .png, .webp
.scss self, .css, .gif, .jpeg, .jpg, .png, .webp

Commands

Command Key Binding Description See in action
Auto Import: Copy Ctrl+Shift+A Copy the relative path of the selected file in Explorer. click here
Auto Import: Paste Ctrl+I Paste the import statement into your active text editor. click here
Auto Import: Auto Alt+D Auto copy and paste the import statement of a file from Explorer to your active text editor. click here

Configuration Settings

General settings

  • preferences.importStatementPlacement: Choose where you want your import statements to be placed in your code with this setting. You can choose to place them at the 'top' of the import list, at the 'bottom', or on the current position of the mouse cursor with the 'Cursor' option.

Import statements

Scripts: Javascript, React Javascript, Typescript, React Typescript

  • importStatements.script.preserveFileExtension: (Boolean) default → false

  • importStatements.script.javascriptImportStyle

    • import $1 from '_relativePath_'; → default
    • import { $1 } from '_relativePath_';
    • import { $1 as $2 } from '_relativePath_';
    • import * as $1 from '_relativePath_';
    • import '_relativePath_';
    • var $1 = require('_relativePath_');
    • const $1 = require('_relativePath_');
    • var $1 = import('_relativePath_');
    • const $1 = import('_relativePath_');
  • importStatements.script.typescriptImportStyle

    • import $1 from '_relativePath_';
    • import { $1 } from '_relativePath_'; → default
    • import { $1 as $2 } from '_relativePath_';
    • import * as $1 from '_relativePath_';
    • import '_relativePath_';

Stylesheets: CSS, SCSS

  • importStatements.styleSheet.preserveFileExtension: (Boolean) default → false

  • importStatements.styleSheet.cssImportStyle

    • @import '_relativePath_'; → default
    • @import url('_relativePath_');
  • importStatements.styleSheet.cssImageImportStyle

    • url('_relativePath_') → default
  • importStatements.styleSheet.scssImportStyle

    • @import '_relativePath_'; → default
    • @import url('_relativePath_');
    • @use '_relativePath_';
    • @use '_relativePath_' as *;
  • importStatements.styleSheet.scssImageImportStyle

    • url('_relativePath_')'; → default

Markup: HTML, Markdown

  • importStatements.markup.htmlScriptImportStyle

    • <script type="text/javascript" src="_relativePath_"></script> → default
  • importStatements.markup.htmlImageImportStyle

    • <img src="_relativePath_" alt="sample"> → default
  • importStatements.markup.htmlStyleSheetImportStyle

    • <link href="_relativePath_" rel="stylesheet"> → default
  • importStatements.markup.markdownImportStyle

    • ![text](_relativePath_) → default
  • importStatements.markup.markdownImageImportStyle

    • ![alt-text](_relativePath_ "Hover text") → default
    • ![alt-text][image] / [image]: _relativePath_ "Hover text"

Installation

  1. Install VS Code v1.76.0 or higher
  2. Launch Visual Studio Code
  3. Enter command Ctrl+Shift+P (Windows, Linux) or Cmd+Shift+P (OSX)
  4. Select → Extensions: Install Extensions.
  5. Choose Auto Import Relative Path by ElecTreeFrying
  6. Reload Visual Studio Code

Changelog

See CHANGELOG for more information.

Contributing

Related

More extensions of mine

License

MIT

About

Auto Import Relative Path is a time-saving extension that simplifies importing relative paths in your code. With this tool, you can easily import files without the need to type out lengthy and complex paths. It's a great solution for projects of any size and can help streamline your workflow.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published