{"_id":"@gulp-plugin/alias","_rev":"2828671","name":"@gulp-plugin/alias","description":"Use Gulp to resolve Typescript path aliases during compilation.","dist-tags":{"latest":"2.2.2"},"maintainers":[{"name":"david_katz","email":"dhkatz.16@gmail.com"}],"time":{"modified":"2022-09-06T14:39:47.000Z","created":"2021-07-14T05:31:25.058Z","2.2.2":"2021-07-25T18:47:18.529Z","2.2.0":"2021-07-14T05:31:25.058Z"},"users":{},"author":{"name":"David Katz","url":"https://github.com/dhkatz"},"repository":{"type":"git","url":"git+https://github.com/gulp-plugin/alias.git"},"versions":{"2.2.2":{"name":"@gulp-plugin/alias","version":"2.2.2","description":"Use Gulp to resolve Typescript path aliases during compilation.","main":"./lib/index.js","types":"./typings/index.d.ts","scripts":{"build":"npm run build:types && npm run build:js","build:types":"tsc --emitDeclarationOnly","build:js":"tsc","lint":"eslint src/**/* && tsc --noEmit","test":"jest --ci --verbose --forceExit --detectOpenHandles --coverage","test:coverage":"coveralls < coverage/lcov.info","prepublishOnly":"npm run build"},"author":{"name":"David Katz","url":"https://github.com/dhkatz"},"repository":{"type":"git","url":"git+https://github.com/gulp-plugin/alias.git"},"license":"MIT","keywords":["gulpplugin","gulp","typescript","ts","resolve","relative","paths"],"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"devDependencies":{"@types/jest":"^26.0.19","@types/node":"^16.3.1","@types/vinyl":"^2.0.2","@typescript-eslint/eslint-plugin":"^4.28.2","@typescript-eslint/parser":"^4.28.2","coveralls":"^3.0.6","eslint":"^7.30.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","jest":"^26.6.3","prettier":"^2.3.2","ts-jest":"^26.4.4","vinyl":"^2.2.0"},"dependencies":{"typescript":"^4.3.5"},"eslintConfig":{"extends":["plugin:@typescript-eslint/recommended","plugin:prettier/recommended"],"parser":"@typescript-eslint/parser","rules":{}},"prettier":{"semi":false,"singleQuote":true,"printWidth":100},"jest":{"preset":"ts-jest","globals":{"ts-jest":{"tsconfig":"./tsconfig.json"}},"testEnvironment":"node","collectCoverage":true,"testRegex":"/test/.*\\.test\\.[jt]s$","moduleFileExtensions":["ts","js"],"collectCoverageFrom":["src/**/*.{js,ts}","!<rootDir>/node_modules/"]},"gitHead":"5dd393f1392dc9418921429f7ffba7d4606b998e","bugs":{"url":"https://github.com/gulp-plugin/alias/issues"},"homepage":"https://github.com/gulp-plugin/alias#readme","_id":"@gulp-plugin/alias@2.2.2","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"shasum":"b4dca2a5206cf921716209ec58fb44da0f00bf12","size":8502,"noattachment":false,"key":"/@gulp-plugin/alias/-/@gulp-plugin/alias-2.2.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/@gulp-plugin/alias/download/@gulp-plugin/alias-2.2.2.tgz"},"_npmUser":{"name":"david_katz","email":"dhkatz.16@gmail.com"},"directories":{},"maintainers":[{"name":"david_katz","email":"dhkatz.16@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/alias_2.2.2_1627238838332_0.9737292423437305"},"_hasShrinkwrap":false,"publish_time":1627238838529,"_cnpm_publish_time":1627238838529,"_cnpmcore_publish_time":"2021-12-16T11:32:00.719Z"},"2.2.0":{"name":"@gulp-plugin/alias","version":"2.2.0","description":"Use Gulp to resolve Typescript path aliases during compilation.","main":"./lib/index.js","types":"./typings/index.d.ts","scripts":{"build":"npm run build:types && npm run build:js","build:types":"tsc --emitDeclarationOnly","build:js":"tsc","lint":"eslint src/**/* && tsc --noEmit","test":"jest --ci --verbose --forceExit --detectOpenHandles --coverage","test:coverage":"coveralls < coverage/lcov.info","prepublishOnly":"npm run build"},"author":{"name":"David Katz","url":"https://github.com/dhkatz"},"repository":{"type":"git","url":"git+https://github.com/gulp-plugin/alias.git"},"license":"MIT","keywords":["gulpplugin","gulp","typescript","ts","resolve","relative","paths"],"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"devDependencies":{"@types/jest":"^26.0.19","@types/node":"^16.3.1","@types/vinyl":"^2.0.2","@typescript-eslint/eslint-plugin":"^4.28.2","@typescript-eslint/parser":"^4.28.2","coveralls":"^3.0.6","eslint":"^7.30.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","jest":"^26.6.3","prettier":"^2.3.2","ts-jest":"^26.4.4","vinyl":"^2.2.0"},"dependencies":{"typescript":"^3.2.2"},"eslintConfig":{"extends":["plugin:@typescript-eslint/recommended","plugin:prettier/recommended"],"parser":"@typescript-eslint/parser","rules":{}},"prettier":{"semi":false,"singleQuote":true,"printWidth":100},"jest":{"preset":"ts-jest","globals":{"ts-jest":{"tsconfig":"./tsconfig.json"}},"testEnvironment":"node","collectCoverage":true,"testRegex":"/test/.*\\.test\\.[jt]s$","moduleFileExtensions":["ts","js"],"collectCoverageFrom":["src/**/*.{js,ts}","!<rootDir>/node_modules/"]},"gitHead":"43d4b8a9d0e79b3d9179cf5ed2db9e4dbcf166db","bugs":{"url":"https://github.com/gulp-plugin/alias/issues"},"homepage":"https://github.com/gulp-plugin/alias#readme","_id":"@gulp-plugin/alias@2.2.0","_nodeVersion":"14.17.1","_npmVersion":"6.14.13","dist":{"shasum":"54890a4a892e703c7b09f43817173bc08e1aded5","size":8276,"noattachment":false,"key":"/@gulp-plugin/alias/-/@gulp-plugin/alias-2.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/@gulp-plugin/alias/download/@gulp-plugin/alias-2.2.0.tgz"},"_npmUser":{"name":"david_katz","email":"dhkatz.16@gmail.com"},"directories":{},"maintainers":[{"name":"david_katz","email":"dhkatz.16@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/alias_2.2.0_1626240684935_0.709147809993528"},"_hasShrinkwrap":false,"publish_time":1626240685058,"_cnpm_publish_time":1626240685058,"_cnpmcore_publish_time":"2021-12-16T11:32:00.925Z"}},"readme":"# @gulp-plugin/alias ![npm (custom registry)](https://img.shields.io/npm/v/@gulp-plugin/alias?logo=npm) [![GitHub Package Registry version](https://img.shields.io/github/release/gulp-plugin/alias.svg?label=gpr&logo=github)](https://github.com/gulp-plugin/alias/packages/896973)\n\n\n[![Build](https://github.com/dhkatz/gulp-ts-alias/actions/workflows/node.js.yml/badge.svg)](https://github.com/dhkatz/gulp-ts-alias/actions/workflows/node.js.yml)\n[![Coverage Status](https://coveralls.io/repos/github/dhkatz/gulp-ts-alias/badge.svg?branch=master)](https://coveralls.io/github/dhkatz/gulp-ts-alias?branch=master) [![dependencies Status](https://david-dm.org/gulp-plugin/alias/status.svg)](https://david-dm.org/gulp-plugin/alias)\n\nResolve TypeScript import aliases and paths defined in `tsconfig`.\n\n## Install\n\n`npm install --save-dev @gulp-plugin/alias`\n\n## Information\n\n### Features\n\n* Supports all import types: `import`, `require`, `await import()`\n* Supports wild card aliases\n\n### Motivation\n\nThere have been previous attempts at releasing Gulp plugins that accomplish something similar, but all have become unmaintained.\n\nFor legacy’s sake, here is a list of previous packages/scripts that have been considered:\n\n[gulp-ts-paths](https://www.npmjs.com/package/gulp-ts-paths)\n\n[path-alias-resolver](https://gist.github.com/azarus/f369ee2ab0283ba0793b0ccf0e9ec590)\n\n**Note:** Imports within multiline comments may also be replaced.\n\n## Usage\n\n```javascript\nconst typescript = require('gulp-typescript');\nconst sourcemaps = require('gulp-sourcemaps');\nconst alias = require('@gulp-plugin/alias');\n\nconst { config } = typescript.createProject('tsconfig.json');\n\nfunction build() {\n  const compiled = src('./src/**/*.ts')\n    .pipe(alias(config))\n    // or .pipe(alias('tsconfig.json'))\n    // or even .pipe(alias())\n    .pipe(sourcemaps.init())\n    .pipe(project());\n\n  return compiled.js\n    .pipe(sourcemaps.write({ sourceRoot: file => path.relative(path.join(file.cwd, file.path), file.base) }))\n    .pipe(dest('build/'))\n}\n```\n\n## Example\n\nThe following configuration is common in `tsconfig` configuration files\n\n```json\n{\n  \"rootDir\": \"./src\",\n  \"baseUrl\": \".\",\n  \"paths\": {\n    \"@/*\": [\"src/*\"]\n  }\n}\n```\n\nIn practice, these path aliases are often used in this fashion\n\nInput:\n\n```typescript\nimport express from 'express';\n\nimport A from './file'; // Normal relative import\n\n// Aliased import, resolves to some relative path to rootDir\nimport B from '@/components';\n```\n\nOutput:\n\n```typescript\nimport express from 'express';\n\nimport A from './file';\n\n// gulp-ts-alias finds the correct relative path\n// and replaces it before compilation\nimport B from '../../components';\n```\n","_attachments":{},"homepage":"https://github.com/gulp-plugin/alias#readme","bugs":{"url":"https://github.com/gulp-plugin/alias/issues"},"license":"MIT"}