-
Notifications
You must be signed in to change notification settings - Fork 50.8k
Failing to run prettier should block CI #9187
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f365e52
Add prettier script
acdlite ecf2e44
CI should fail if prettier wasn't run
acdlite 7cf2950
Pass args as an array
acdlite c71a8ec
Add prettier instructions to PR template and contribution guide
acdlite 0e5be28
Exit with failing code if prettier throws to ensure CI is blocked
acdlite cbdddbe
(test) Commit changes without running prettier to see if CI fails
acdlite 8802c20
Run `yarn prettier` to format code
acdlite File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /** | ||
| * Copyright (c) 2014-present, Facebook, Inc. All rights reserved. | ||
| * | ||
| * This source code is licensed under the BSD-style license found in the | ||
| * LICENSE file in the root directory of this source tree. An additional grant | ||
| * of patent rights can be found in the PATENTS file in the same directory. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| // Based on similar script in Jest | ||
| // https://github.com/facebook/jest/blob/master/scripts/prettier.js | ||
|
|
||
| const chalk = require('chalk'); | ||
| const glob = require('glob'); | ||
| const path = require('path'); | ||
| const execFileSync = require('child_process').execFileSync; | ||
|
|
||
| const shouldWrite = process.argv[2] === 'write'; | ||
| const isWindows = process.platform === 'win32'; | ||
| const prettier = isWindows ? 'prettier.cmd' : 'prettier'; | ||
| const prettierCmd = path.resolve(__dirname, '../../node_modules/.bin/' + prettier); | ||
| const defaultOptions = { | ||
| 'bracket-spacing': 'false', | ||
| 'single-quote': 'true', | ||
| 'jsx-bracket-same-line': 'true', | ||
| 'trailing-comma': 'all', | ||
| 'print-width': 80, | ||
| }; | ||
| const config = { | ||
| default: { | ||
| patterns: ['src/**/*.js'], | ||
| ignore: [ | ||
| '**/third_party/**', | ||
| '**/node_modules/**', | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| function exec(command, args) { | ||
| console.log('> ' + [command].concat(args).join(' ')); | ||
| var options = {}; | ||
| return execFileSync(command, args, options).toString(); | ||
| } | ||
|
|
||
| Object.keys(config).forEach(key => { | ||
| const patterns = config[key].patterns; | ||
| const options = config[key].options; | ||
| const ignore = config[key].ignore; | ||
|
|
||
| const globPattern = patterns.length > 1 | ||
| ? `{${patterns.join(',')}}` | ||
| : `${patterns.join(',')}`; | ||
| const files = glob.sync(globPattern, {ignore}); | ||
|
|
||
| const args = Object.keys(defaultOptions).map( | ||
| k => `--${k}=${(options && options[k]) || defaultOptions[k]}` | ||
| ); | ||
| args.push(`--${shouldWrite ? 'write' : 'l'}`); | ||
|
|
||
| try { | ||
| exec(prettierCmd, [...args, ...files]); | ||
| } catch (e) { | ||
| if (!shouldWrite) { | ||
| console.log( | ||
| '\n' + | ||
| chalk.red( | ||
| ` This project uses prettier to format all JavaScript code.\n` | ||
| ) + | ||
| chalk.dim(` Please run `) + | ||
| chalk.reset('yarn prettier') + | ||
| chalk.dim(` and add changes to files listed above to your commit.`) + | ||
| `\n` | ||
| ); | ||
| process.exit(1); | ||
| } | ||
| throw e; | ||
| } | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this barely more helpful without the .join but if you like this then we can keep it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Me too except it truncates some of the file names without it.