Skip to content
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.

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

Warn on duplicate Sass deps #16398

Merged
merged 3 commits into from
Aug 20, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
33 changes: 33 additions & 0 deletions errors/duplicate-sass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Duplicate Sass Dependencies

#### Why This Error Occurred

Your project has a direct dependency on both `sass` and `node-sass`, two
different package that both compile Sass files!

Next.js will only use one of these, so it is suggested you remove one or the
other.

#### Possible Ways to Fix It

The `sass` package is a modern implementation of Sass in JavaScript that
supports all the new features and does not require any native dependencies.

Since `sass` is now the canonical implementation, we suggest removing the older
`node-sass` package, which should speed up your builds and project install time.

**Via npm**

```bash
npm uninstall node-sass
```

**Via Yarn**

```bash
yarn remove node-sass
```

### Useful Links

- [`sass` package documentation](https://github.com/sass/dart-sass)
12 changes: 12 additions & 0 deletions packages/next/cli/next-dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,18 @@ const nextDev: cliCommand = (argv) => {
)
}
}

const [sassVersion, nodeSassVersion] = await Promise.all([
getPackageVersion({ cwd: dir, name: 'sass' }),
getPackageVersion({ cwd: dir, name: 'node-sass' }),
])
if (sassVersion && nodeSassVersion) {
Log.warn(
'Your project has both `sass` and `node-sass` installed as dependencies, but should only use one or the other. ' +
'Please remove the `node-sass` dependency from your project. ' +
' Read more: https://err.sh/next.js/duplicate-sass'
)
}
}

const port = args['--port'] || 3000
Expand Down
1 change: 1 addition & 0 deletions test/integration/cli/duplicate-sass/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!node_modules

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions test/integration/cli/duplicate-sass/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"dependencies": {
"node-sass": "*",
"sass": "*"
}
}
3 changes: 3 additions & 0 deletions test/integration/cli/duplicate-sass/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Home() {
return <p>Hello</p>
}
17 changes: 17 additions & 0 deletions test/integration/cli/test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const dirOldReact = join(__dirname, '../old-react')
const dirOldReactDom = join(__dirname, '../old-react-dom')
const dirExperimentalReact = join(__dirname, '../experimental-react')
const dirExperimentalReactDom = join(__dirname, '../experimental-react-dom')
const dirDuplicateSass = join(__dirname, '../duplicate-sass')

describe('CLI Usage', () => {
describe('no command', () => {
Expand Down Expand Up @@ -295,6 +296,22 @@ describe('CLI Usage', () => {

await killApp(instance)
})

test('duplicate sass deps', async () => {
const port = await findPort()

let stderr = ''
let instance = await launchApp(dirDuplicateSass, port, {
stderr: true,
onStderr(msg) {
stderr += msg
},
})

expect(stderr).toMatch('both `sass` and `node-sass` installed')

await killApp(instance)
})
})

describe('export', () => {
Expand Down