Skip to content

fix(sass-imports): resolve module imports relative to file being processed #478

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

Merged
merged 3 commits into from
Jun 28, 2022
Merged

fix(sass-imports): resolve module imports relative to file being processed #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b7fee5
fix(sass-imports): resolve module imports relative to file being proc…
Jun 13, 2022
c5d1a69
test(vue2): adding e2e tests for sass-importer
Jun 24, 2022
a7d6851
test(vue3): adding e2e tests for sass-importer
Jun 24, 2022
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
4 changes: 4 additions & 0 deletions e2e/2.x/sass-importer/entry/babel-transformer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
const { createTransformer } = require('babel-jest').default
module.exports = createTransformer({
presets: ['@babel/preset-env']
})
24 changes: 24 additions & 0 deletions e2e/2.x/sass-importer/entry/components/Entry.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<template>
<div>
<h1 class="entry">Entry</h1>
<lib-component />
</div>
</template>

<script>
import LibComponent from 'vue2-sass-importer-lib/index.vue'

export default {
components: {
LibComponent
}
}
</script>

<style lang="scss" module>
@import '~vue2-sass-importer-sass-lib/index.scss';

.entry {
@include my-v2-mixin;
}
</style>
49 changes: 49 additions & 0 deletions e2e/2.x/sass-importer/entry/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"name": "vue2-sass-importer-entry",
"version": "1.0.0",
"license": "MIT",
"private": true,
"scripts": {
"test": "jest --no-cache --coverage test.js"
},
"dependencies": {
"vue": "^2.5.21",
"vue-template-compiler": "^2.5.21",
"vue2-sass-importer-lib": "file:../lib",
"vue2-sass-importer-sass-lib": "file:../sass-lib-v2"
},
"devDependencies": {
"@babel/core": "^7.9.0",
"@babel/preset-env": "^7.9.0",
"@vue/test-utils": "^1.1.0",
"babel-jest": "^28.0.2",
"jest": "28.x",
"jest-environment-jsdom": "28.0.2",
"postcss": "^7.0.13",
"postcss-color-function": "^4.0.1",
"sass": "^1.23.7",
"@vue/vue2-jest": "^28.0.0"
},
"jest": {
"testEnvironment": "jsdom",
"moduleFileExtensions": [
"js",
"json",
"vue"
],
"transformIgnorePatterns": [
"/node_modules/.*(?<!.vue)$"
],
"transform": {
"^.+\\.js$": "./babel-transformer.js",
"^.+\\.vue$": "@vue/vue2-jest"
},
"globals": {
"vue-jest": {
"transform": {
"^js$": "./babel-transformer.js"
}
}
}
}
}
7 changes: 7 additions & 0 deletions e2e/2.x/sass-importer/entry/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { mount } from '@vue/test-utils'
import Entry from './components/Entry.vue'

test('processes sass imports relative to current file', () => {
const wrapper = mount(Entry)
expect(wrapper).toBeDefined()
})
11 changes: 11 additions & 0 deletions e2e/2.x/sass-importer/lib/index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<div class="lib-class">Lib Component</div>
</template>

<style lang="scss" module>
@import '~vue2-sass-importer-sass-lib/index.scss';

.lib-class {
@include my-v1-mixin;
}
</style>
19 changes: 19 additions & 0 deletions e2e/2.x/sass-importer/lib/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "vue2-sass-importer-lib",
"version": "1.0.0",
"license": "MIT",
"private": true,
"main": "index.vue",
"files": [
"index.vue"
],
"scripts": {
"test": "echo 'No tests found.'"
},
"dependencies": {
"vue2-sass-importer-sass-lib": "file:../sass-lib-v1"
},
"peerDependencies": {
"vue": "^2.5.21"
}
}
3 changes: 3 additions & 0 deletions e2e/2.x/sass-importer/sass-lib-v1/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@mixin my-v1-mixin {
color: blue;
}
12 changes: 12 additions & 0 deletions e2e/2.x/sass-importer/sass-lib-v1/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "vue2-sass-importer-sass-lib",
"version": "1.0.0",
"license": "MIT",
"private": true,
"files": [
"index.scss"
],
"scripts": {
"test": "echo 'No tests found.'"
}
}
3 changes: 3 additions & 0 deletions e2e/2.x/sass-importer/sass-lib-v2/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@mixin my-v2-mixin {
color: red;
}
12 changes: 12 additions & 0 deletions e2e/2.x/sass-importer/sass-lib-v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "vue2-sass-importer-sass-lib",
"version": "2.0.0",
"license": "MIT",
"private": true,
"files": [
"index.scss"
],
"scripts": {
"test": "echo 'No tests found.'"
}
}
4 changes: 4 additions & 0 deletions e2e/3.x/sass-importer/entry/babel-transformer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
const { createTransformer } = require('babel-jest').default
module.exports = createTransformer({
presets: ['@babel/preset-env']
})
24 changes: 24 additions & 0 deletions e2e/3.x/sass-importer/entry/components/Entry.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<template>
<div>
<h1 class="entry">Entry</h1>
<lib-component />
</div>
</template>

<script>
import LibComponent from 'vue3-sass-importer-lib/index.vue'

export default {
components: {
LibComponent
}
}
</script>

<style lang="scss" module>
@import '~vue3-sass-importer-sass-lib/index.scss';

.entry {
@include my-v2-mixin;
}
</style>
48 changes: 48 additions & 0 deletions e2e/3.x/sass-importer/entry/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"name": "vue3-sass-importer-entry",
"version": "1.0.0",
"license": "MIT",
"private": true,
"scripts": {
"test": "jest --no-cache --coverage test.js"
},
"dependencies": {
"vue": "^3.2.22",
"vue3-sass-importer-lib": "file:../lib",
"vue3-sass-importer-sass-lib": "file:../sass-lib-v2"
},
"devDependencies": {
"@babel/core": "^7.9.0",
"@babel/preset-env": "^7.9.0",
"@vue/test-utils": "^2.0.0-rc.10",
"babel-jest": "^28.0.2",
"jest": "28.x",
"jest-environment-jsdom": "28.0.2",
"postcss": "^7.0.13",
"postcss-color-function": "^4.0.1",
"sass": "^1.23.7",
"@vue/vue3-jest": "^28.0.0"
},
"jest": {
"testEnvironment": "jsdom",
"moduleFileExtensions": [
"js",
"json",
"vue"
],
"transformIgnorePatterns": [
"/node_modules/.*(?<!.vue)$"
],
"transform": {
"^.+\\.js$": "./babel-transformer.js",
"^.+\\.vue$": "@vue/vue3-jest"
},
"globals": {
"vue-jest": {
"transform": {
"^js$": "./babel-transformer.js"
}
}
}
}
}
7 changes: 7 additions & 0 deletions e2e/3.x/sass-importer/entry/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { mount } from '@vue/test-utils'
import Entry from './components/Entry.vue'

test('processes sass imports relative to current file', () => {
const wrapper = mount(Entry)
expect(wrapper).toBeDefined()
})
11 changes: 11 additions & 0 deletions e2e/3.x/sass-importer/lib/index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<div class="lib-class">Lib Component</div>
</template>

<style lang="scss" module>
@import '~vue3-sass-importer-sass-lib/index.scss';

.lib-class {
@include my-v1-mixin;
}
</style>
19 changes: 19 additions & 0 deletions e2e/3.x/sass-importer/lib/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "vue3-sass-importer-lib",
"version": "1.0.0",
"license": "MIT",
"private": true,
"main": "index.vue",
"files": [
"index.vue"
],
"scripts": {
"test": "echo 'No tests found.'"
},
"dependencies": {
"vue3-sass-importer-sass-lib": "file:../sass-lib-v1"
},
"peerDependencies": {
"vue": "^3.2.22"
}
}
3 changes: 3 additions & 0 deletions e2e/3.x/sass-importer/sass-lib-v1/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@mixin my-v1-mixin {
color: blue;
}
12 changes: 12 additions & 0 deletions e2e/3.x/sass-importer/sass-lib-v1/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "vue3-sass-importer-sass-lib",
"version": "1.0.0",
"license": "MIT",
"private": true,
"files": [
"index.scss"
],
"scripts": {
"test": "echo 'No tests found.'"
}
}
3 changes: 3 additions & 0 deletions e2e/3.x/sass-importer/sass-lib-v2/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@mixin my-v2-mixin {
color: red;
}
12 changes: 12 additions & 0 deletions e2e/3.x/sass-importer/sass-lib-v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "vue3-sass-importer-sass-lib",
"version": "2.0.0",
"license": "MIT",
"private": true,
"files": [
"index.scss"
],
"scripts": {
"test": "echo 'No tests found.'"
}
}
8 changes: 6 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@
"workspaces": {
"packages": [
"packages/*",
"e2e/**"
"e2e/2.x/*",
"e2e/2.x/**/entry",
"e2e/3.x/*",
"e2e/3.x/**/entry"
],
"nohoist": [
"**/vue"
"**/vue",
"**/vue2-sass-importer-sass-lib"
]
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/vue2-jest/lib/module-name-mapper-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function resolveSass(to, importPath, fileType) {

for (const filename of filenames) {
try {
return require.resolve(path.join(dirname, filename))
return require.resolve(path.join(dirname, filename), { paths: [to] })
} catch (_) {}
}
}
Expand Down
4 changes: 3 additions & 1 deletion packages/vue3-jest/lib/module-name-mapper-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ function resolve(to, importPath, fileType) {
if (path.isAbsolute(importPath)) {
return importPath
} else if (matchModuleImport.test(importPath)) {
return require.resolve(importPath.replace(matchModuleImport, ''))
return require.resolve(importPath.replace(matchModuleImport, ''), {
paths: [to]
})
}
return path.join(path.dirname(to), importPath)
}
Expand Down
22 changes: 22 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10865,6 +10865,28 @@ vue-template-es2015-compiler@^1.9.0:
resolved "https://registry.yarnpkg.com/vue-template-es2015-compiler/-/vue-template-es2015-compiler-1.9.1.tgz#1ee3bc9a16ecbf5118be334bb15f9c46f82f5825"
integrity sha512-4gDntzrifFnCEvyoO8PqyJDmguXgVPxKiIxrBKjIowvL9l+N66196+72XVYR8BBf1Uv1Fgt3bGevJ+sEmxfZzw==

"vue2-sass-importer-lib@file:e2e/2.x/sass-importer/lib":
version "1.0.0"
dependencies:
vue2-sass-importer-sass-lib "file:../../.cache/yarn/v6/npm-vue2-sass-importer-lib-1.0.0-1087f856-8699-4ac6-a0fa-2288988256c2-1656107462461/node_modules/sass-lib-v1"

"vue2-sass-importer-sass-lib@file:e2e/2.x/sass-importer/sass-lib-v1":
version "1.0.0"

"vue2-sass-importer-sass-lib@file:e2e/2.x/sass-importer/sass-lib-v2":
version "2.0.0"

"vue3-sass-importer-lib@file:e2e/3.x/sass-importer/lib":
version "1.0.0"
dependencies:
vue3-sass-importer-sass-lib "file:../../.cache/yarn/v6/npm-vue3-sass-importer-lib-1.0.0-c866bb73-f527-47b9-932d-498dea4cf3d0-1656107462461/node_modules/sass-lib-v1"

"vue3-sass-importer-sass-lib@file:e2e/3.x/sass-importer/sass-lib-v1":
version "1.0.0"

"vue3-sass-importer-sass-lib@file:e2e/3.x/sass-importer/sass-lib-v2":
version "2.0.0"

vue@^2.4.2, vue@^2.5.21:
version "2.6.14"
resolved "https://registry.yarnpkg.com/vue/-/vue-2.6.14.tgz#e51aa5250250d569a3fbad3a8a5a687d6036e235"
Expand Down