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.

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

#67 next export unused script mistakenly failed builds #72

Merged
merged 1 commit into from
Dec 14, 2020
Merged

#67 next export unused script mistakenly failed builds #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ test/sample/netlify-automatic-functions
test/sample/my-publish-dir
test/sample/.next
test/sample/.netlify
next.config.js

# Logs
logs
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ node_modules
__mocks__
test/fixtures
test/sample
next.config.js
9 changes: 7 additions & 2 deletions helpers/isStaticExportProject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@

const isStaticExportProject = ({ build, scripts }) => {
const NEXT_EXPORT_COMMAND = 'next export'
const isSetInNetlifyConfig = build && build.command && build.command.includes(NEXT_EXPORT_COMMAND)

if (!build.command) return false

const isSetInNetlifyConfig = build.command.includes(NEXT_EXPORT_COMMAND)

const isSetInNpmScript = Object.keys(scripts).find((script) => {
return scripts[script].includes(NEXT_EXPORT_COMMAND)
const scriptValue = scripts[script]
return build.command.includes(script) && scriptValue.includes(NEXT_EXPORT_COMMAND)
})
return isSetInNetlifyConfig || isSetInNpmScript
}
Expand Down
4 changes: 3 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ module.exports = {
const { name, scripts = {}, dependencies = {} } = packageJson

if (isStaticExportProject({ build, scripts })) {
return failBuild(`** Static HTML export next.js projects do not require this plugin **`)
return failBuild(
`Static HTML export Next.js projects do not require this plugin. Check your project's build command for 'next export'.`,
)
}

const hasNextOnNetlifyInstalled = dependencies['next-on-netlify'] !== undefined
Expand Down
32 changes: 24 additions & 8 deletions test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,31 @@ afterEach(async () => {
})

const DUMMY_PACKAGE_JSON = { name: 'dummy', version: '1.0.0' }
const netlifyConfig = { build: {} }

describe('preBuild()', () => {
test('fail build if the app has static html export in npm script', async () => {
await expect(
plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig: { build: { command: 'npm run build' } },
packageJson: { ...DUMMY_PACKAGE_JSON, scripts: { build: 'next export' } },
utils,
constants: { FUNCTIONS_SRC: 'out_functions' },
}),
).rejects.toThrow('** Static HTML export next.js projects do not require this plugin **')
).rejects.toThrow(
`Static HTML export Next.js projects do not require this plugin. Check your project's build command for 'next export'.`,
)
})

test('do not fail build if the app has next export in an unused script', async () => {
await expect(
plugin.onPreBuild({
netlifyConfig,
packageJson: { ...DUMMY_PACKAGE_JSON, scripts: { export: 'next export' } },
utils,
constants: {},
}),
).resolves
})

test('fail build if the app has static html export in toml/ntl config', async () => {
Expand All @@ -79,7 +93,9 @@ describe('preBuild()', () => {
utils,
constants: { FUNCTIONS_SRC: 'out_functions' },
}),
).rejects.toThrow('** Static HTML export next.js projects do not require this plugin **')
).rejects.toThrow(
`Static HTML export Next.js projects do not require this plugin. Check your project's build command for 'next export'.`,
)
})

test('fail build if app has next-on-netlify installed', async () => {
Expand All @@ -88,7 +104,7 @@ describe('preBuild()', () => {
}
await expect(
plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig,
packageJson,
utils,
}),
Expand All @@ -103,7 +119,7 @@ describe('preBuild()', () => {
}
await expect(
plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig,
packageJson,
utils,
}),
Expand All @@ -115,7 +131,7 @@ describe('preBuild()', () => {
test('fail build if the app has no package.json', async () => {
await expect(
plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig,
packageJson: {},
utils,
constants: { FUNCTIONS_SRC: 'out_functions' },
Expand All @@ -125,7 +141,7 @@ describe('preBuild()', () => {

test('create next.config.js with correct target if file does not exist', async () => {
await plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig,
packageJson: DUMMY_PACKAGE_JSON,
utils,
constants: { FUNCTIONS_SRC: 'out_functions' },
Expand All @@ -140,7 +156,7 @@ describe('preBuild()', () => {
await useFixture(fixtureName)
await expect(
plugin.onPreBuild({
netlifyConfig: {},
netlifyConfig,
packageJson: DUMMY_PACKAGE_JSON,
utils,
constants: { FUNCTIONS_SRC: 'out_functions' },
Expand Down