Skip to content

feat: deprecate @ alias in favor of the imports field in package.json #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat: deprecate @ alias in favor of the imports field in package.json #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46791d7
feat: use package.json imports instead of `@` as alias to `src`
haoqunjiang Dec 26, 2023
d117304
Merge branch 'main' into feat-package-json-imports
haoqunjiang Nov 13, 2024
28b5aaf
feat!: use `#/src` instead
haoqunjiang Nov 13, 2024
04ec3be
Revert "feat!: use `#/src` instead"
haoqunjiang Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions template/base/jsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"compilerOptions": {
"paths": {
// TODO: no longer needed after TS 5.4
"#src/*": ["./src/*"],
// Deprecated, use `#src` instead (configured in `package.json` `imports` field)
"@/*": ["./src/*"]
}
},
Expand Down
3 changes: 3 additions & 0 deletions template/base/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"private": true,
"type": "module",
"imports": {
"#src/": "./src/"
},
"scripts": {
"dev": "vite",
"build": "vite build",
Expand Down
1 change: 1 addition & 0 deletions template/base/vite.config.js.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export default defineConfig({
],
resolve: {
alias: {
// Deprecated, use `#src` instead (configured in `package.json` `imports` field)
'@': fileURLToPath(new URL('./src', import.meta.url))
},
},
Expand Down
2 changes: 1 addition & 1 deletion template/code/router/src/App.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import HelloWorld from './components/HelloWorld.vue'

<template>
<header>
<img alt="Vue logo" class="logo" src="@/assets/logo.svg" width="125" height="125" />
<img alt="Vue logo" class="logo" src="#src/assets/logo.svg" width="125" height="125" />

<div class="wrapper">
<HelloWorld msg="You did it!" />
Expand Down
2 changes: 1 addition & 1 deletion template/code/typescript-router/src/App.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import HelloWorld from './components/HelloWorld.vue'

<template>
<header>
<img alt="Vue logo" class="logo" src="@/assets/logo.svg" width="125" height="125" />
<img alt="Vue logo" class="logo" src="#src/assets/logo.svg" width="125" height="125" />

<div class="wrapper">
<HelloWorld msg="You did it!" />
Expand Down
2 changes: 1 addition & 1 deletion template/config/cypress-ct/cypress/support/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import './commands'
// require('./commands')

// Import global styles
import '@/assets/main.css'
import '#src/assets/main.css'

import { mount } from 'cypress/vue'

Expand Down
2 changes: 1 addition & 1 deletion template/config/cypress-ct/cypress/support/component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import './commands'
// require('./commands')

// Import global styles
import '@/assets/main.css'
import '#src/assets/main.css'

import { mount } from 'cypress/vue'

Expand Down
3 changes: 3 additions & 0 deletions template/tsconfig/base/tsconfig.app.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",

"paths": {
// TODO: no longer needed after TS 5.4
"#src/*": ["./src/*"],
// Deprecated, use `#src` instead (configured in `package.json` `imports` field)
"@/*": ["./src/*"]
}
}
Expand Down
3 changes: 3 additions & 0 deletions template/tsconfig/nightwatch-ct/tsconfig.app.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",

"paths": {
// TODO: no longer needed after TS 5.4
"#src/*": ["./src/*"],
// Deprecated, use `#src` instead (configured in `package.json` `imports` field)
"@/*": ["./src/*"]
}
}
Expand Down