# universal-alias-loader

> Alisas loader that works for both CSS\Sass\Less & JS files and resolves aliases

Latest version **1.2.2** (published 2017-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install universal-alias-loader
pnpm add universal-alias-loader
yarn add universal-alias-loader
bun add universal-alias-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2017-08-01 |
| First published | 2017-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | vsevolod-trofimov |
| Maintainers | vsevolod-trofimov |
| Keywords | webpack, alias, loader, js, es6, css, sass, less |

## Links

- npm: https://www.npmjs.com/package/universal-alias-loader
- Repository: https://github.com/VsevolodTrofimov/universal-alias-loader
- Homepage: https://github.com/VsevolodTrofimov/universal-alias-loader#readme
- Issues: https://github.com/VsevolodTrofimov/universal-alias-loader/issues
- npm.io page: https://npm.io/package/universal-alias-loader

## Dependencies (1)

- [loader-utils](https://npm.io/package/loader-utils.md) ^1.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.2 (latest) — 2017-08-01
- 1.2.1 — 2017-07-30
- 1.2.0 — 2017-07-28
- 1.1.1 — 2017-07-25
- 1.1.0 — 2017-07-22
- 1.0.2 — 2017-07-20
- 1.0.1 — 2017-06-23
- 1.0.0 — 2017-06-23
- 0.1.1 — 2017-06-20
- 0.1.0 — 2017-06-20
- 0.0.0 — 2017-06-20

## README

# universal-alias-loader • [![Build Status](https://travis-ci.org/VsevolodTrofimov/universal-alias-loader.svg?branch=master)](https://travis-ci.org/VsevolodTrofimov/universal-alias-loader)
Loader that will replace aliases in your css and js files, supports absolute, relative and url paths

Turn this
```javascript
import { ru, en } from '../../../utils/i18n'
```

Into this
```javascript
import { ru, en } from '@utils/i18n'
```

## Installation
```bash
npm i universal-alias-loader
```

## API
Like any other loader
```javascript
{
  enforce: 'pre', //so it will run before other loaders
  test: /\.(css|js|jsx)$/, //yep, it parses syntax from filename (but you can set syntax yourself)
  exclude: /(node_modules|bower_components)/,
  use: {
    loader: 'universal-alias-loader',  
    query: {
      alias {
        '@redux': path.join(__dirname, 'src/redux'), //or simply
        '@components': 'src/components'
        '@cdn': 'http://your.awsome.cdn.com',
      }
    }
  }
}
```

## What can be an alias?
### String
Any string, no matter how long, but keep in mind that if you set `/` or `\\` as alias universal-alias-loader WILL replace them
### Function
Should return path string

Arguments passed for the function would be `(alias, importPath, filePath)`
 - `importPath` is a string with contents of found import \ url expression
 - `filePath` is a string with path to file currently being processed
 - `alias` alias this function should handle, basically `key` in `options.alias` this function is paired with

 **Example usage**
 ```javascript
 alias: {
   //we use folder structure like src/pages/{pagename}/**
   //this alias replaces @thispage with path to that page
  '@thisPage': (alias, importPath, filePath) => {
              let splitFilePath = filePath.split(path.sep)
              let pagePath = splitFilePath
                .slice(0, splitFilePath.indexOf('pages') + 2)
                .join('/')

              return importPath.replace(alias, pagePath)
            }
}
 ```
 I really use it this way in one of my project, because we have one complex page with visual storytelling and sometimes files like `{pagename}/story/stages/0.js` need to access `{pagename}/utils` but we want to keep them movable and avoid unclear `../`

## Options (Query)1
| Name | Type     | Default       | Description                                                                                                      |
|-----------------|----------|---------------|------------------------------------------------------------------------------------------------------------------|
| alias           | {Object} | {}            | Object keys are aliases, values are resolves {'@alias': 'resolve'}                                               |
| syntax          | {String} | auto          | **js** for ES6 `import` & CommonJS `require()`. **css** for css `@import` & css `url()` css-modules `from` replacements. **auto** determines syntax for each file individually based on the file extension|


## Syntax support
| Syntax                 | Example                                                                                            | Supported          |
|------------------------|----------------------------------------------------------------------------------------------------|--------------------|
| CSS url()              | background: url('@cdn/pics/main-bg.png'); /* With double, single, no quotes */                     | :heavy_check_mark: |
| CSS Import             | @import '@src/reset.css'; @import url(@cdn/Roboto.css); @import "@utils/print-layout.css" print;   | :heavy_check_mark: |
| CSS Modules from       | composes: className from '@components/btn.css';                                                    | :heavy_check_mark: |
| ES6 imports            | import {   Foo as Bar, Qux} from "~/constants" //multiline will be ok                              | :heavy_check_mark: |
| CommonJS require       | require(`@components/${name}`)                                                                     | :heavy_check_mark: |
| webpack magic comments | import(/* webpackChunkName: 'Anything' */ '@alias')                                               | :heavy_check_mark:                |

Webpack magic comments are on the way, but PRs are welcome (modify js-require & js-es6import pathfinders)

## Tips
If your `webpack.confing.js` is not your project in root make sure to [have the context property in your confing set to the project root](https://github.com/gokulkrishh/how-to-setup-webpack-2)

Alias staring with `http://`, `https://`, `ws://`, `wss://`, `ftp://`, `ftps://` are determined as absolute

---
_Source: https://npm.io/package/universal-alias-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._