refactor: imports paths to avoid ../../ hell

Ref: https://nodejs.org/api/packages.html#imports
leon-ai · Nov 14, 2023 · e0ca31b · e0ca31b
1 parent c9e25a8
commit e0ca31b
Show file tree

Hide file tree

Showing 34 changed files with 103 additions and 103 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -23,5 +23,3 @@ jobs:
 
       - name: 'Build'
         run: 'npm run build'
-
-      - run: 'npm run build:typescript'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -30,8 +30,6 @@ jobs:
       - name: 'Build'
         run: 'npm run build'
 
-      - run: 'npm run build:typescript'
-
       - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
         run: 'npm audit signatures'
 

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -3,4 +3,3 @@
 
 npm run lint:staged
 npm run build
-npm run build:typescript
diff --git a/package.json b/package.json
@@ -40,14 +40,16 @@
     "!**/*.test.js",
     "!**/*.map"
   ],
+  "imports": {
+    "#src/*": "./build/*"
+  },
   "main": "build/index.js",
   "bin": {
     "leon": "build/index.js"
   },
   "scripts": {
-    "build": "rimraf ./build && swc ./src --out-dir ./build",
+    "build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
     "build:dev": "swc ./src --out-dir ./build --watch",
-    "build:typescript": "tsc",
     "start": "node --enable-source-maps build/index.js",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",

diff --git a/src/cli.ts b/src/cli.ts
@@ -1,15 +1,15 @@
 import { Builtins, Cli } from 'clipanion'
 
-import { Leon } from './services/Leon.js'
-import { packageJSON } from './packageJSON.js'
-import { CreateBirthCommand } from './commands/create/birth.js'
-import { CheckCommand } from './commands/check.js'
-import { HelpCommand } from './commands/help.js'
-import { InfoCommand } from './commands/info.js'
-import { DeleteCommand } from './commands/delete.js'
-import { RunCommand } from './commands/run.js'
-import { StartCommand } from './commands/start.js'
-import { UpdateCommand } from './commands/update.js'
+import { Leon } from '#src/services/Leon.js'
+import { packageJSON } from '#src/packageJSON.js'
+import { CreateBirthCommand } from '#src/commands/create/birth.js'
+import { CheckCommand } from '#src/commands/check.js'
+import { HelpCommand } from '#src/commands/help.js'
+import { InfoCommand } from '#src/commands/info.js'
+import { DeleteCommand } from '#src/commands/delete.js'
+import { RunCommand } from '#src/commands/run.js'
+import { StartCommand } from '#src/commands/start.js'
+import { UpdateCommand } from '#src/commands/update.js'
 
 export const cli = new Cli({
   binaryLabel: Leon.NAME,

diff --git a/src/commands/__test__/check.test.ts b/src/commands/__test__/check.test.ts
@@ -1,8 +1,8 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import { cli } from '../../cli.js'
-import { CheckCommand } from '../check.js'
+import { cli } from '#src/cli.js'
+import { CheckCommand } from '#src/commands/check.js'
 
 await test('leon check', async (t) => {
   await t.test('should be instance of the command', async () => {

diff --git a/src/commands/__test__/delete.test.ts b/src/commands/__test__/delete.test.ts
@@ -5,14 +5,14 @@ import sinon from 'sinon'
 import fsMock from 'mock-fs'
 import chalk from 'chalk'
 
-import { cli } from '../../cli.js'
-import { DeleteCommand } from '../delete.js'
-import type { ConfigData } from '../../services/Config.js'
-import { config } from '../../services/Config.js'
-import type { LeonInstanceOptions } from '../../services/LeonInstance.js'
-import { LeonInstance } from '../../services/LeonInstance.js'
-import { isExistingPath } from '../../utils/isExistingPath.js'
-import { Log } from '../../services/Log.js'
+import { cli } from '#src/cli.js'
+import { DeleteCommand } from '#src/commands/delete.js'
+import type { ConfigData } from '#src/services/Config.js'
+import { config } from '#src/services/Config.js'
+import type { LeonInstanceOptions } from '#src/services/LeonInstance.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
+import { Log } from '#src/services/Log.js'
 
 await test('leon delete', async (t) => {
   t.afterEach(() => {

diff --git a/src/commands/__test__/help.test.ts b/src/commands/__test__/help.test.ts
@@ -1,8 +1,8 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import { HelpCommand } from '../help.js'
-import { cli } from '../../cli.js'
+import { HelpCommand } from '#src/commands/help.js'
+import { cli } from '#src/cli.js'
 
 await test('leon help', async (t) => {
   await t.test('should be instance of the command', async () => {

diff --git a/src/commands/__test__/info.test.ts b/src/commands/__test__/info.test.ts
@@ -7,14 +7,14 @@ import chalk from 'chalk'
 import { table } from 'table'
 import date from 'date-and-time'
 
-import { cli } from '../../cli.js'
-import { InfoCommand } from '../info.js'
-import type { ConfigData } from '../../services/Config.js'
-import { config } from '../../services/Config.js'
-import type { LeonInstanceOptions } from '../../services/LeonInstance.js'
-import { LeonInstance } from '../../services/LeonInstance.js'
-import { Log } from '../../services/Log.js'
-import { isExistingPath } from '../../utils/isExistingPath.js'
+import { cli } from '#src/cli.js'
+import { InfoCommand } from '#src/commands/info.js'
+import type { ConfigData } from '#src/services/Config.js'
+import { config } from '#src/services/Config.js'
+import type { LeonInstanceOptions } from '#src/services/LeonInstance.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
 
 const leonInstanceOptions: LeonInstanceOptions = {
   name: 'random-name',

diff --git a/src/commands/__test__/run.test.ts b/src/commands/__test__/run.test.ts
@@ -1,8 +1,8 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import { RunCommand } from '../run.js'
-import { cli } from '../../cli.js'
+import { RunCommand } from '#src/commands/run.js'
+import { cli } from '#src/cli.js'
 
 await test('leon run', async (t) => {
   await t.test('should be instance of the command', async () => {

diff --git a/src/commands/__test__/start.test.ts b/src/commands/__test__/start.test.ts
@@ -5,13 +5,13 @@ import sinon from 'sinon'
 import fsMock from 'mock-fs'
 import chalk from 'chalk'
 
-import { StartCommand } from '../start.js'
-import { cli } from '../../cli.js'
-import type { ConfigData } from '../../services/Config.js'
-import { config } from '../../services/Config.js'
-import type { LeonInstanceOptions } from '../../services/LeonInstance.js'
-import { LeonInstance } from '../../services/LeonInstance.js'
-import { isExistingPath } from '../../utils/isExistingPath.js'
+import { StartCommand } from '#src/commands/start.js'
+import { cli } from '#src/cli.js'
+import type { ConfigData } from '#src/services/Config.js'
+import { config } from '#src/services/Config.js'
+import type { LeonInstanceOptions } from '#src/services/LeonInstance.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
 
 const leonInstanceOptions: LeonInstanceOptions = {
   name: 'random-name',

diff --git a/src/commands/__test__/update.test.ts b/src/commands/__test__/update.test.ts
@@ -1,8 +1,8 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import { UpdateCommand } from '../update.js'
-import { cli } from '../../cli.js'
+import { UpdateCommand } from '#src/commands/update.js'
+import { cli } from '#src/cli.js'
 
 await test('leon update', async (t) => {
   await t.test('should be instance of the command', async () => {

diff --git a/src/commands/check.ts b/src/commands/check.ts
@@ -1,7 +1,7 @@
 import { Command, Option } from 'clipanion'
 
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
 
 export class CheckCommand extends Command {
   public static override paths = [['check']]

diff --git a/src/commands/create/__test__/birth.test.ts b/src/commands/create/__test__/birth.test.ts
@@ -1,8 +1,8 @@
 import test from 'node:test'
 import assert from 'node:assert/strict'
 
-import { cli } from '../../../cli.js'
-import { CreateBirthCommand } from '../birth.js'
+import { cli } from '#src/cli.js'
+import { CreateBirthCommand } from '#src/commands/create/birth.js'
 
 await test('leon create birth', async (t) => {
   await t.test('should be instance of the command', async () => {

diff --git a/src/commands/create/birth.ts b/src/commands/create/birth.ts
@@ -1,8 +1,8 @@
 import { Command, Option } from 'clipanion'
 import chalk from 'chalk'
 
-import { Leon } from '../../services/Leon.js'
-import { Log } from '../../services/Log.js'
+import { Leon } from '#src/services/Leon.js'
+import { Log } from '#src/services/Log.js'
 
 export class CreateBirthCommand extends Command {
   public static override paths = [['create', 'birth']]

diff --git a/src/commands/delete.ts b/src/commands/delete.ts
@@ -1,8 +1,8 @@
 import { Command, Option } from 'clipanion'
 
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
-import { Prompt } from '../services/Prompt.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
+import { Prompt } from '#src/services/Prompt.js'
 
 export class DeleteCommand extends Command {
   public static override paths = [['delete']]

diff --git a/src/commands/info.ts b/src/commands/info.ts
@@ -1,9 +1,9 @@
 import { Command, Option } from 'clipanion'
 import chalk from 'chalk'
 
-import { config } from '../services/Config.js'
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
+import { config } from '#src/services/Config.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
 
 export class InfoCommand extends Command {
   public static override paths = [['info']]

diff --git a/src/commands/run.ts b/src/commands/run.ts
@@ -1,10 +1,10 @@
 import { Command, Option } from 'clipanion'
 import { execaCommand } from 'execa'
 
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
-import { CheckCommand } from './check.js'
-import { StartCommand } from './start.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
+import { CheckCommand } from '#src/commands/check.js'
+import { StartCommand } from '#src/commands/start.js'
 
 interface Builtin {
   [key: string]: (leonInstance: LeonInstance) => Promise<void>

diff --git a/src/commands/start.ts b/src/commands/start.ts
@@ -1,8 +1,8 @@
 import * as typanion from 'typanion'
 import { Command, Option } from 'clipanion'
 
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
 
 export class StartCommand extends Command {
   public static override paths = [['start']]

diff --git a/src/commands/update.ts b/src/commands/update.ts
@@ -1,9 +1,9 @@
 import { Command, Option } from 'clipanion'
 import chalk from 'chalk'
 
-import { Leon } from '../services/Leon.js'
-import { LeonInstance } from '../services/LeonInstance.js'
-import { Log } from '../services/Log.js'
+import { Leon } from '#src/services/Leon.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { Log } from '#src/services/Log.js'
 
 export class UpdateCommand extends Command {
   public static override paths = [['update']]

diff --git a/src/e2e/classic.test.e2e.ts b/src/e2e/classic.test.e2e.ts
@@ -1,8 +1,8 @@
-import { test1CreateBirth } from './tests/1-create-birth.js'
-import { test2Update } from './tests/2-update.js'
-import { test3Start } from './tests/3-start.js'
-import { test4Check } from './tests/4-check.js'
-import { test5Run } from './tests/5-run.js'
+import { test1CreateBirth } from '#src/e2e/tests/1-create-birth.js'
+import { test2Update } from '#src/e2e/tests/2-update.js'
+import { test3Start } from '#src/e2e/tests/3-start.js'
+import { test4Check } from '#src/e2e/tests/4-check.js'
+import { test5Run } from '#src/e2e/tests/5-run.js'
 
 await test1CreateBirth()
 await test2Update()

diff --git a/src/e2e/docker.test.e2e.ts b/src/e2e/docker.test.e2e.ts
@@ -1,7 +1,7 @@
-import { test1CreateBirth } from './tests/1-create-birth.js'
-import { test2Update } from './tests/2-update.js'
-import { test3Start } from './tests/3-start.js'
-import { test4Check } from './tests/4-check.js'
+import { test1CreateBirth } from '#src/e2e/tests/1-create-birth.js'
+import { test2Update } from '#src/e2e/tests/2-update.js'
+import { test3Start } from '#src/e2e/tests/3-start.js'
+import { test4Check } from '#src/e2e/tests/4-check.js'
 
 await test1CreateBirth({ useDocker: true })
 await test2Update()

diff --git a/src/e2e/tests/1-create-birth.ts b/src/e2e/tests/1-create-birth.ts
@@ -4,8 +4,8 @@ import path from 'node:path'
 
 import { execa } from 'execa'
 
-import { Leon } from '../../services/Leon.js'
-import { isExistingPath } from '../../utils/isExistingPath.js'
+import { Leon } from '#src/services/Leon.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
 
 interface Options {
   useDocker?: boolean

diff --git a/src/e2e/tests/2-update.ts b/src/e2e/tests/2-update.ts
@@ -5,7 +5,7 @@ import path from 'node:path'
 
 import { execa } from 'execa'
 
-import { LeonInstance } from '../../services/LeonInstance.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
 
 const TWENTY_MINUTES = 20 * 60 * 1000
 

diff --git a/src/index.ts b/src/index.ts
@@ -2,8 +2,8 @@
 import { Cli } from 'clipanion'
 import updateNotifier from 'update-notifier'
 
-import { cli } from './cli.js'
-import { packageJSON } from './packageJSON.js'
+import { cli } from '#src/cli.js'
+import { packageJSON } from '#src/packageJSON.js'
 
 const [, , ...arguments_] = process.argv
 

diff --git a/src/services/Config.ts b/src/services/Config.ts
@@ -3,7 +3,7 @@ import Conf from 'conf'
 import type { Static } from '@sinclair/typebox'
 import { Type } from '@sinclair/typebox'
 
-import { packageJSON } from '../packageJSON.js'
+import { packageJSON } from '#src/packageJSON.js'
 
 export const instanceModes = [Type.Literal('classic'), Type.Literal('docker')]
 

diff --git a/src/services/Leon.ts b/src/services/Leon.ts
@@ -6,11 +6,11 @@ import ora from 'ora'
 import { simpleGit, CheckRepoActions } from 'simple-git'
 import { readPackage } from 'read-pkg'
 
-import { isExistingPath } from '../utils/isExistingPath.js'
-import { LeonInstance } from './LeonInstance.js'
-import { LogError } from '../utils/LogError.js'
-import { Requirements } from './Requirements.js'
-import { config } from './Config.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
+import { LogError } from '#src/utils/LogError.js'
+import { Requirements } from '#src/services/Requirements.js'
+import { config } from '#src/services/Config.js'
 
 export interface LeonOptions {
   useDevelopGitBranch?: boolean

diff --git a/src/services/LeonInstance.ts b/src/services/LeonInstance.ts
@@ -8,10 +8,10 @@ import { readPackage } from 'read-pkg'
 import { table } from 'table'
 import chalk from 'chalk'
 
-import { config } from './Config.js'
-import { LogError } from '../utils/LogError.js'
-import { isExistingPath } from '../utils/isExistingPath.js'
-import type { Leon } from './Leon.js'
+import { config } from '#src/services/Config.js'
+import { LogError } from '#src/utils/LogError.js'
+import { isExistingPath } from '#src/utils/isExistingPath.js'
+import type { Leon } from '#src/services/Leon.js'
 
 export type InstanceType = 'classic' | 'docker'
 

diff --git a/src/services/Log.ts b/src/services/Log.ts
@@ -1,8 +1,8 @@
 import Conf from 'conf'
 import chalk from 'chalk'
 
-import { LogError } from '../utils/LogError.js'
-import { Leon } from './Leon.js'
+import { LogError } from '#src/utils/LogError.js'
+import { Leon } from '#src/services/Leon.js'
 import { packageJSON } from '../packageJSON.js'
 
 interface LogErrorOptions {

diff --git a/src/services/__test__/LeonInstance.test.ts b/src/services/__test__/LeonInstance.test.ts
@@ -3,10 +3,10 @@ import assert from 'node:assert/strict'
 
 import fsMock from 'mock-fs'
 
-import type { ConfigData } from '../Config.js'
-import { config } from '../Config.js'
-import type { LeonInstanceOptions } from '../LeonInstance.js'
-import { LeonInstance } from '../LeonInstance.js'
+import type { ConfigData } from '#src/services/Config.js'
+import { config } from '#src/services/Config.js'
+import type { LeonInstanceOptions } from '#src/services/LeonInstance.js'
+import { LeonInstance } from '#src/services/LeonInstance.js'
 
 const leonInstanceOptions: LeonInstanceOptions = {
   name: 'random-name',