From 560cffd1b769d195b85ac6f3369f29e9d4cb3f24 Mon Sep 17 00:00:00 2001 From: Diego Date: Wed, 13 Apr 2022 06:27:29 -0400 Subject: [PATCH] Feat register script --- docs/integrations.md | 30 ++++++++++++++++++++++++++++++ package.json | 2 +- register.js | 11 +++++++++++ 3 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 register.js diff --git a/docs/integrations.md b/docs/integrations.md index f009e75..745322e 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -203,6 +203,36 @@ Setup is simple; add the following line in your application's main file, before require('alias-hq').get('module-alias') ``` +Also is possible to register your paths from any package script just like [module-alias](https://www.npmjs.com/package/module-alias): + +```json +{ + "scripts": { + "dev": "ts-node -r alias-hq/register src/index.ts" + }, +} +``` + +For the `dist` app, update your `package.json` like: + +```json +{ + "scripts": { + "start": "node -r alias-hq/register src/index.js" + }, +} +``` + +If you are using nodemon: + +```json +{ + "scripts": { + "dev": "nodemon --exec ts-node -r alias-hq/register src/index.ts", + }, +} +``` + ## JSON-only For libraries or setups that require JSON, you can use the [CLI](cli/cli.md): diff --git a/package.json b/package.json index af94126..6ec3b87 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "alias-hq", - "version": "5.3.2", + "version": "5.4.0", "description": "The end-to-end solution for configuring, refactoring, maintaining and using path aliases", "main": "src/index.js", "bin": "bin/alias-hq", diff --git a/register.js b/register.js new file mode 100644 index 0000000..cb180d4 --- /dev/null +++ b/register.js @@ -0,0 +1,11 @@ +/** + * + * Alias-hq: Register + * @description provides a script to easily register paths from any package script + * + * Usage: ts-node -r alias-hq/register src/index + * with nodemon: nodemon --exec ts-node -r alias-hq/register src/index + * + */ + +require('./src/index').get('module-alias')