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

Jump to bottom

fix(prettier compat): format may return Promise #777

Closed
wants to merge 1 commit into from
Closed

fix(prettier compat): format may return Promise #777

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
4 changes: 2 additions & 2 deletions __tests__/standalone.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ describe('maybeLoadExistingEslintRc', () => {
});
});

test('backupExistingEslintrc creates a scoped & formatted backup', () => {
test('backupExistingEslintrc creates a scoped & formatted backup', async () => {
const writeFileSyncMock = jest.fn();
jest.spyOn(fs, 'writeFileSync').mockImplementation(writeFileSyncMock);

Expand All @@ -103,7 +103,7 @@ test('backupExistingEslintrc creates a scoped & formatted backup', () => {
});
const mockConfig = { foo: 'bar' };

backupExistingEslintrc(mockConfig, mockFormat);
await backupExistingEslintrc(mockConfig, mockFormat);

expect(mockFormat).toHaveBeenCalledWith(
JSON.stringify(mockConfig),
Expand Down
29 changes: 19 additions & 10 deletions src/utils/standalone.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,20 @@ export const maybeLoadExistingEslintrc = (
}
};

export const backupExistingEslintrc = (
export const backupExistingEslintrc = async (
config: Record<string, unknown>,
format: (str: string, options?: Record<string, unknown>) => string
): void => {
format: (str: string, options?: Record<string, unknown>) => Promise<string>
): Promise<void> => {
const name = `./.eslintrc-${Date.now()}-bak.json`;
const targetPath = resolve(name);

log(`backing existing ".eslintrc.json" up at "${name}"`);

writeFileSync(targetPath, format(JSON.stringify(config), prettierOptions));
const formattedOptions = await format(
JSON.stringify(config),
prettierOptions
);
writeFileSync(targetPath, formattedOptions);
};

export async function generateStandalone(): Promise<void> {
Expand All @@ -74,20 +78,25 @@ export async function generateStandalone(): Promise<void> {
const targetPath = resolve(defaultEslintRcJsonPath);

const existingConfig = maybeLoadExistingEslintrc(targetPath);
const format = await loadPrettier();
// TODO: Remove type overwrite after updating prettier
const format = (await loadPrettier()) as unknown as (
str: string,
options?: Record<string, unknown>
) => Promise<string>;

if (existingConfig) {
backupExistingEslintrc(existingConfig, format);
await backupExistingEslintrc(existingConfig, format);
}

const config = createConfig(settings ?? undefined);
const finalConfig = existingConfig ? merge(config, existingConfig) : config;

writeFileSync(
targetPath,
format(JSON.stringify(finalConfig), prettierOptions)
const formattedFinalConfig = await format(
JSON.stringify(finalConfig),
prettierOptions
);

writeFileSync(targetPath, formattedFinalConfig);

log(`wrote ".eslintrc.json" to "${targetPath}"`);
} catch (error) {
/* istanbul ignore next only throwing errors so... */
Expand Down