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

Run local prettier script #63959

Merged
merged 9 commits into from
Apr 21, 2020
21 changes: 21 additions & 0 deletions scripts/prettier_on_changed.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

require('../src/setup_node_env/babel_register');
require('../src/dev/run_prettier_on_changed');
File renamed without changes.
5 changes: 3 additions & 2 deletions src/dev/eslint/lint_files.js → src/dev/eslint/lint_files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@

import { CLIEngine } from 'eslint';

import { createFailError } from '@kbn/dev-utils';
import { createFailError, ToolingLog } from '@kbn/dev-utils';
import { File } from '../file';
import { REPO_ROOT } from '../constants';

/**
Expand All @@ -30,7 +31,7 @@ import { REPO_ROOT } from '../constants';
* @param {Array<File>} files
* @return {undefined}
*/
export function lintFiles(log, files, { fix } = {}) {
export function lintFiles(log: ToolingLog, files: File[], { fix }: { fix?: boolean } = {}) {
const cli = new CLIEngine({
cache: true,
cwd: REPO_ROOT,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,20 @@
* specific language governing permissions and limitations
* under the License.
*/

import { CLIEngine } from 'eslint';

import { ToolingLog } from '@kbn/dev-utils';
import { File } from '../file';

/**
* Filters a list of files to only include lintable files.
*
* @param {ToolingLog} log
* @param {Array<File>} files
* @return {Array<File>}
*/
export function pickFilesToLint(log, files) {
const cli = new CLIEngine();
export function pickFilesToLint(log: ToolingLog, files: File[]) {
const cli = new CLIEngine({});

return files.filter(file => {
if (!file.isJs() && !file.isTypescript()) {
Expand Down
83 changes: 83 additions & 0 deletions src/dev/run_prettier_on_changed.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import execa from 'execa';
// @ts-ignore
import SimpleGit from 'simple-git';
import { run } from '@kbn/dev-utils';
import dedent from 'dedent';
import Util from 'util';

import pkg from '../../package.json';
import { REPO_ROOT } from './constants';
import { File } from './file';
import * as Eslint from './eslint';

run(async function getChangedFiles({ log }) {
const simpleGit = new SimpleGit(REPO_ROOT);

const getStatus = Util.promisify(simpleGit.status.bind(simpleGit));
const gitStatus = await getStatus();

if (gitStatus.files.length > 0) {
throw new Error(
dedent(`You should run prettier formatter on a clean branch.
Found not committed changes to:
${gitStatus.files.map((f: { path: string }) => f.path).join('\n')}`)
);
}

const revParse = Util.promisify(simpleGit.revparse.bind(simpleGit));
const currentBranch = await revParse(['--abbrev-ref', 'HEAD']);
const headBranch = pkg.branch;

const diff = Util.promisify(simpleGit.diff.bind(simpleGit));

const changedFileStatuses: string = await diff([
'--name-status',
`${headBranch}...${currentBranch}`,
]);

const changedFiles = changedFileStatuses
.split('\n')
// Ignore blank lines
.filter(line => line.trim().length > 0)
// git diff --name-status outputs lines with two OR three parts
// separated by a tab character
.map(line => line.trim().split('\t'))
.map(([status, ...paths]) => {
// ignore deleted files
if (status === 'D') {
return undefined;
}

// the status is always in the first column
// .. If the file is edited the line will only have two columns
// .. If the file is renamed it will have three columns
// .. In any case, the last column is the CURRENT path to the file
return new File(paths[paths.length - 1]);
})
.filter((file): file is File => Boolean(file));

const pathsToLint = Eslint.pickFilesToLint(log, changedFiles).map(f => f.getAbsolutePath());
mshustov marked this conversation as resolved.
Show resolved Hide resolved

if (pathsToLint.length > 0) {
await execa('npx', ['[email protected]', '--write', ...pathsToLint]);
}
mshustov marked this conversation as resolved.
Show resolved Hide resolved
});