Merge pull request #292 from ojvribeiro/feat/configurable-src-directory

feat: configurable `src` directory
ojvribeiro · Sep 9, 2024 · f930b25 · f930b25
2 parents e666c64 + a7641f6
commit f930b25
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 53 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -35,7 +35,7 @@
  "vue": "3.4.21",
  "vue-loader": "17.4.2",
  "vue-router": "4.4.0",
- "vulxi": "0.0.12",
+ "vulxi": "0.1.0",
  "yargs": "17.7.1",
  "yarpm": "1.2.0"
  },

diff --git a/src/config/aliases.js b/src/config/aliases.js
@@ -4,40 +4,41 @@ const { absoluteVulmixPaths } = require('./paths')
 const VulmixAliases = () => {
  const ABSOLUTE_ROOT_PATH = absoluteVulmixPaths().absoluteRootPath
  const ABSOLUTE_PACKAGE_PATH = absoluteVulmixPaths().absolutePackagePath
+ const ABSOLUTE_SRC_PATH = absoluteVulmixPaths().absoluteSrcPath
 
  return {
  '~': ABSOLUTE_ROOT_PATH,
- '@': ABSOLUTE_ROOT_PATH,
+ '@': ABSOLUTE_SRC_PATH,
  '@@': `${ABSOLUTE_PACKAGE_PATH}/src`,
- '@appFile': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/app.vue`)
- ? `${ABSOLUTE_ROOT_PATH}/app.vue`
- : fs.existsSync(`${ABSOLUTE_ROOT_PATH}/pages/index.vue`) &&
- !fs.existsSync(`${ABSOLUTE_ROOT_PATH}/app.vue`)
+ '@appFile': fs.existsSync(`${ABSOLUTE_SRC_PATH}/app.vue`)
+ ? `${ABSOLUTE_SRC_PATH}/app.vue`
+ : fs.existsSync(`${ABSOLUTE_SRC_PATH}/pages/index.vue`) &&
+ !fs.existsSync(`${ABSOLUTE_SRC_PATH}/app.vue`)
  ? `${ABSOLUTE_PACKAGE_PATH}/src/vue/pages/app.vue`
  : `${ABSOLUTE_PACKAGE_PATH}/src/vue/pages/404.vue`,
- '@assets': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/assets`)
- ? `${ABSOLUTE_ROOT_PATH}/assets`
+ '@assets': fs.existsSync(`${ABSOLUTE_SRC_PATH}/assets`)
+ ? `${ABSOLUTE_SRC_PATH}/assets`
  : false,
- '@icons': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/assets/icons`)
- ? `${ABSOLUTE_ROOT_PATH}/assets/icons`
+ '@icons': fs.existsSync(`${ABSOLUTE_SRC_PATH}/assets/icons`)
+ ? `${ABSOLUTE_SRC_PATH}/assets/icons`
  : false,
- '@components': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/components`)
- ? `${ABSOLUTE_ROOT_PATH}/components`
+ '@components': fs.existsSync(`${ABSOLUTE_SRC_PATH}/components`)
+ ? `${ABSOLUTE_SRC_PATH}/components`
  : false,
- '@composables': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/composables`)
- ? `${ABSOLUTE_ROOT_PATH}/composables`
+ '@composables': fs.existsSync(`${ABSOLUTE_SRC_PATH}/composables`)
+ ? `${ABSOLUTE_SRC_PATH}/composables`
  : false,
- '@layouts': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/layouts`)
- ? `${ABSOLUTE_ROOT_PATH}/layouts`
+ '@layouts': fs.existsSync(`${ABSOLUTE_SRC_PATH}/layouts`)
+ ? `${ABSOLUTE_SRC_PATH}/layouts`
  : false,
- '@pages': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/pages`)
- ? `${ABSOLUTE_ROOT_PATH}/pages`
+ '@pages': fs.existsSync(`${ABSOLUTE_SRC_PATH}/pages`)
+ ? `${ABSOLUTE_SRC_PATH}/pages`
  : false,
- '@plugins': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/plugins`)
- ? `${ABSOLUTE_ROOT_PATH}/plugins`
+ '@plugins': fs.existsSync(`${ABSOLUTE_SRC_PATH}/plugins`)
+ ? `${ABSOLUTE_SRC_PATH}/plugins`
  : false,
- '@404': fs.existsSync(`${ABSOLUTE_ROOT_PATH}/404.vue`)
- ? `${ABSOLUTE_ROOT_PATH}/404.vue`
+ '@404': fs.existsSync(`${ABSOLUTE_SRC_PATH}/404.vue`)
+ ? `${ABSOLUTE_SRC_PATH}/404.vue`
  : `${ABSOLUTE_PACKAGE_PATH}/src/vue/pages/404.vue`,
  }
 }

diff --git a/src/config/imports.js b/src/config/imports.js
@@ -4,7 +4,7 @@ const { absoluteVulmixPaths, relativeVulmixPaths } = require('./paths.js')
 module.exports.UnpluginAutoImports = () => {
  const ABSOLUTE_ROOT_PATH = absoluteVulmixPaths().absoluteRootPath
  const ABSOLUTE_PACKAGE_PATH = absoluteVulmixPaths().absolutePackagePath
- const RELATIVE_ROOT_PATH = relativeVulmixPaths().relativeRootPath
+ const RELATIVE_SRC_PATH = relativeVulmixPaths().relativeSrcPath
 
  const VULMIX_CONFIG_PATH = `${ABSOLUTE_ROOT_PATH}/.vulmix/vulmix.config.js`
  const VulmixConfig = require(VULMIX_CONFIG_PATH).default
@@ -13,8 +13,8 @@ module.exports.UnpluginAutoImports = () => {
  require('unplugin-vue-components/webpack').default({
  version: 3,
  dirs: [
- `${RELATIVE_ROOT_PATH}/.vulmix/runtime/components`,
- `${RELATIVE_ROOT_PATH}/components`,
+ `${RELATIVE_SRC_PATH}/.vulmix/runtime/components`,
+ `${RELATIVE_SRC_PATH}/components`,
  ],
  extensions: ['vue', 'ts', 'js'],
  directoryAsNamespace: true,
@@ -41,7 +41,7 @@ module.exports.UnpluginAutoImports = () => {
  ...(VulmixConfig.imports?.dirs || []),
  `${ABSOLUTE_PACKAGE_PATH}/src/vue/composables/**`,
  `${ABSOLUTE_PACKAGE_PATH}/src/vue/utils/**`,
- `${ABSOLUTE_ROOT_PATH}/composables/**`,
+ `${RELATIVE_SRC_PATH}/composables/**`,
  `${ABSOLUTE_PACKAGE_PATH}/src/vue/composables/**`,
  ],
  dts: `${ABSOLUTE_ROOT_PATH}/.vulmix/types/auto-imports.d.ts`,

diff --git a/src/config/paths.js b/src/config/paths.js
@@ -6,34 +6,53 @@ const normalizePath = originalPath => {
 }
 
 const absoluteVulmixPaths = () => {
- return {
- absoluteRootPath: normalizePath(path.resolve(__dirname, '../../../..')),
-
- absolutePackagePath: normalizePath(path.resolve(__dirname, '../..')),
+ const absoluteRootPath = normalizePath(path.resolve(__dirname, '../../../..'))
+ const VULMIX_CONFIG_PATH = `${absoluteRootPath}/.vulmix/vulmix.config.js`
+ const VulmixConfig = require(VULMIX_CONFIG_PATH).default
+ const absolutePackagePath = normalizePath(path.resolve(__dirname, '../..'))
+ const absolutePublicPath = normalizePath(
+ path.resolve(__dirname, `${absoluteRootPath}/_dist`)
+ )
+ const absoluteSrcPath = normalizePath(
+ path.resolve(
+ __dirname,
+ `${absoluteRootPath}/${VulmixConfig?.dirs?.src || ''}`
+ )
+ )
 
- absolutePublicPath: normalizePath(
- path.resolve(__dirname, '../../../../_dist')
- ),
+ return {
+ absoluteRootPath,
+ absolutePackagePath,
+ absolutePublicPath,
+ absoluteSrcPath,
  }
 }
 
 const relativeVulmixPaths = () => {
  const ABSOLUTE_ROOT_PATH = absoluteVulmixPaths().absoluteRootPath
  const ABSOLUTE_PACKAGE_PATH = absoluteVulmixPaths().absolutePackagePath
  const ABSOLUTE_PUBLIC_PATH = absoluteVulmixPaths().absolutePublicPath
+ const ABSOLUTE_SRC_PATH = absoluteVulmixPaths().absoluteSrcPath
+
+ const relativePackagePath = getRelativePath(
+ ABSOLUTE_ROOT_PATH,
+ ABSOLUTE_PACKAGE_PATH
+ )
+ const relativePublicPath = getRelativePath(
+ ABSOLUTE_ROOT_PATH,
+ ABSOLUTE_PUBLIC_PATH
+ )
+ const relativeRootPath = getRelativePath(
+ ABSOLUTE_ROOT_PATH,
+ ABSOLUTE_ROOT_PATH
+ )
+ const relativeSrcPath = getRelativePath(ABSOLUTE_ROOT_PATH, ABSOLUTE_SRC_PATH)
 
  return {
- relativePackagePath: getRelativePath(
- ABSOLUTE_ROOT_PATH,
- ABSOLUTE_PACKAGE_PATH
- ),
-
- relativePublicPath: getRelativePath(
- ABSOLUTE_ROOT_PATH,
- ABSOLUTE_PUBLIC_PATH
- ),
-
- relativeRootPath: getRelativePath(ABSOLUTE_ROOT_PATH, ABSOLUTE_ROOT_PATH),
+ relativePackagePath,
+ relativePublicPath,
+ relativeRootPath,
+ relativeSrcPath,
  }
 }
 

diff --git a/src/mix.js b/src/mix.js
@@ -40,6 +40,9 @@ class VulmixInit {
  register() {
  const VULMIX_CONFIG_PATH = `${ABSOLUTE_ROOT_PATH}/.vulmix/vulmix.config.js`
 
+ /**
+ * @type {import('../types/vulmix-config').VulmixConfig}
+ */
  const VulmixConfig = require(VULMIX_CONFIG_PATH).default
  const APP_PUBLIC_PATH = VulmixConfig.dirs?.public
  ? `${ABSOLUTE_ROOT_PATH}/${VulmixConfig.dirs?.public?.replace('/', '')}/`

diff --git a/types/vulmix-config.d.ts b/types/vulmix-config.d.ts
@@ -11,6 +11,7 @@ export interface VulmixConfig {
 
  dirs?: {
  public?: string
+ src?: string
  },
 
  head?: {

diff --git a/utils/tsconfig.json b/utils/tsconfig.json
@@ -13,15 +13,6 @@
  "noImplicitAny": false,
  "outDir": "../../.vulmix/client",
  "baseUrl": "../..",
- "paths": {
- "~/*": ["./*"],
- "@/*": ["./*"],
- "@assets/*": ["./assets/*"],
- "@components/*": ["./components/*"],
- "@composables/*": ["./composables/*"],
- "@layouts/*": ["./layouts/*"],
- "@pages/*": ["./pages/*"]
- }
  },
  "include": [
  "../../**/*",