Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 3.78 KB

paths.md

File metadata and controls

115 lines (75 loc) · 3.78 KB
Raw

Configure paths

Create and maintain your tsconfig.json's paths configuration

alias cli

Alias HQ piggybacks the Microsoft-designed ts/jsconfig.json configuration files.

These describe a wide variety of options designed for JavaScript and TypeScript projects, and will be familiar to VS Code users, though you do not have to use VS Code to use Alias HQ.

Alias HQ transparently reads and writes from this single config file for all API and CLI operations.

See the notes section at the end for more information on the configuration format.

Create config

If you do not already have a ts/jsconfig.json file, Alias HQ can create one for you.

Follow the prompts and you will end up with a basic file like this:

{
  "compilerOptions": {
    "baseUrl": "",
    "paths": {}
  }
}

Update config

The next menu option lets you configure your project's path aliases.

It has three steps: Base Url, Paths and Alias Prefix.

Base URL

The baseUrl is folder from which all paths will start from, and is generally either:

  • your src/ folder (pre-filled if this folder exists)
  • your root folder (just enter . )

Paths

Your paths config is the physical map of alias names to file system folders.

You have various ways to enter them:

  • type folder paths, relative to your baseUrl folder
  • drag-and-drop folders (absolute paths) from your Finder / Explorer
  • copy/paste relative or absolute paths.

Note that:

  • the paste limit is often 1024 characters
  • line breaks do not seem to be supported
  • separate paths with spaces instead, quoting if necessary

Alias HQ will process your input then show you a preview of valid paths (those that exist, and are below the project root):

? Paths [ type folders / drag from filesystem ]: ../packages app foo

    ✔ packages      - /Volumes/Data/AliasHQ/demos/alias-hq-demo/packages
    ✔ app           - /Volumes/Data/AliasHQ/demos/alias-hq-demo/src/app
    ✘ foo           - /Volumes/Data/AliasHQ/demos/alias-hq-demo/src/foo

You cannot continue with invalid paths; they will be removed and you will have to repeat the step.

Alias prefix

Finally, you will want to prefix your aliases.

The convention is @ and is the default suggestion.

Preview config

Once you complete these steps, Alias HQ will show you a preview of the new configuration and give you the option to save it:

{
  "rootUrl": "/Volumes/Data/AliasHQ/demos/alias-hq-demo",
  "baseUrl": "src",
  "paths": {
    "@packages/*": [ "../packages/*" ],
    "@/*": [ "/*" ],
    "@app/*": [ "app/*" ],
    "@data/*": [ "app/data/*" ],
    ...
  }
}

Notes

These notes provide some practical and conceptual advice about Microsoft's configuration format.

Folders:

  • The baseUrl is a relative folder path to the project's absolute rootUrl such as "." or "src"
  • Any paths must resolve from the baseUrl, so if you need to go up a level from src, something like this is fine: ../packages
  • The format supports multiple paths, though
    • the CLI will only write a single path
    • Jest v25+ is the only library to utilise this

Content:

  • You may add non-TypeScript paths (such as assets, for use in Webpack) here; TypeScript will ignore them but Alias HQ will use them
  • Aliases also support files, so you can enter something like this: core/config/settings.js and it will be aliased to @settings

Naming:

  • Alias names can be any valid folder name; you don't have to use a @ character, but the convention is to use one to make them recognisable
  • To resolve folder content, both the alias name and path components require trailing wildcards