Skip to content

Commit

Permalink
feat: adds helpful error message when files is overridden or empty (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
tyler-reitz authored and Kent C. Dodds committed Jun 19, 2018
1 parent 2c9f476 commit 3f2ae00
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/util/__tests__/config-file.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ const NoNameConfigFile = {
contributorsPerLine: 6,
contributors: [],
}
const NoFilesConfigFile = {
projectOwner: 'jfmengels',
projectName: 'all-contributors-cli',
imageSize: 100,
commit: false,
contributorsPerLine: 6,
contributors: [],
files: [],
}

test('Reading an absent configuration file throws a helpful error', () => {
expect(() => configFile.readConfig(absentFile)).toThrowError(
Expand All @@ -41,3 +50,11 @@ test('Should throw error and not allow editing config file if project name or ow
configFile.writeConfig(incompleteConfigFilePath, NoNameConfigFile),
).toThrow(`Error! Project name is not set in ${incompleteConfigFilePath}`)
})

test(`throws if 'files' was overridden in .all-contributorsrc and is empty`, () => {
expect(() =>
configFile.writeConfig(incompleteConfigFilePath, NoFilesConfigFile),
).toThrow(
`Error! Project files was overridden and is empty in ${incompleteConfigFilePath}`,
)
})
5 changes: 5 additions & 0 deletions src/util/config-file.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ function writeConfig(configPath, content) {
if (!content.projectName) {
throw new Error(`Error! Project name is not set in ${configPath}`)
}
if (!content.files.length) {
throw new Error(
`Error! Project files was overridden and is empty in ${configPath}`,
)
}
return pify(fs.writeFile)(configPath, `${JSON.stringify(content, null, 2)}\n`)
}

Expand Down

0 comments on commit 3f2ae00

Please sign in to comment.