Skip to content

Commit

Permalink
Replace ESLint and Prettier with Biome (#665)
Browse files Browse the repository at this point in the history
  • Loading branch information
wojtekmaj committed Jun 5, 2024
1 parent 1d6b663 commit 42efbfb
Show file tree
Hide file tree
Showing 24 changed files with 203 additions and 1,502 deletions.
51 changes: 6 additions & 45 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,11 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Cache Yarn cache
uses: actions/cache@v4
env:
cache-name: yarn-cache
with:
path: ~/.yarn/berry/cache
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Enable Corepack
run: corepack enable

- name: Install dependencies
run: yarn --immutable

- name: Build package
run: yarn build
- name: Setup Biome
uses: biomejs/setup-biome@v2

- name: Run tests
run: yarn lint
run: biome lint

typescript:
name: Type checking
Expand Down Expand Up @@ -88,29 +67,11 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Cache Yarn cache
uses: actions/cache@v4
env:
cache-name: yarn-cache
with:
path: ~/.yarn/berry/cache
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Enable Corepack
run: corepack enable

- name: Install dependencies
run: yarn --immutable
- name: Setup Biome
uses: biomejs/setup-biome@v2

- name: Run formatting
run: yarn format
run: biome format

unit:
name: Unit tests
Expand Down
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1 +1 @@
yarn lint-staged
yarn format --staged --no-errors-on-unmatched --write
3 changes: 0 additions & 3 deletions .lintstagedrc.json

This file was deleted.

3 changes: 0 additions & 3 deletions .prettierignore

This file was deleted.

4 changes: 0 additions & 4 deletions .prettierrc.json

This file was deleted.

2 changes: 1 addition & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"recommendations": ["dbaeumer.vscode-eslint", "eamodio.gitlens", "esbenp.prettier-vscode"],
"recommendations": ["biomejs.biome", "eamodio.gitlens"],
"unwantedRecommendations": ["dbaeumer.jshint"]
}
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.defaultFormatter": "biomejs.biome",
"editor.formatOnSave": true,
"search.exclude": {
"**/.yarn": true
Expand Down
43 changes: 43 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
"files": {
"ignore": [".tsimp", "coverage", "dist", ".pnp.cjs", ".pnp.loader.mjs"]
},
"formatter": {
"lineWidth": 100,
"indentStyle": "space"
},
"linter": {
"rules": {
"complexity": {
"noUselessSwitchCase": "off"
},
"suspicious": {
"noConsoleLog": "warn"
}
}
},
"javascript": {
"formatter": {
"quoteStyle": "single"
}
},
"overrides": [
{
"include": ["**/package.json"],
"formatter": {
"lineWidth": 1
}
},
{
"include": ["**/vite.config.ts"],
"linter": {
"rules": {
"suspicious": {
"noConsoleLog": "off"
}
}
}
}
]
}
7 changes: 1 addition & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,7 @@
"unit": "yarn workspaces foreach --all run unit"
},
"devDependencies": {
"husky": "^9.0.0",
"lint-staged": "^15.0.0",
"prettier": "^3.2.0"
},
"resolutions": {
"eslint-plugin-import": "npm:eslint-plugin-i@^2.28.0"
"husky": "^9.0.0"
},
"packageManager": "[email protected]"
}
2 changes: 0 additions & 2 deletions packages/react-date-picker/.eslintignore

This file was deleted.

3 changes: 0 additions & 3 deletions packages/react-date-picker/.eslintrc.json

This file was deleted.

1 change: 0 additions & 1 deletion packages/react-date-picker/.prettierignore

This file was deleted.

8 changes: 3 additions & 5 deletions packages/react-date-picker/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@
"build-js-cjs-package": "echo '{\n \"type\": \"commonjs\"\n}' > dist/cjs/package.json",
"clean": "rimraf dist",
"copy-styles": "cpy 'src/**/*.css' dist",
"format": "prettier --check . --cache",
"lint": "eslint . --ext .js,.jsx,.ts,.tsx",
"format": "biome format",
"lint": "biome lint",
"prepack": "yarn clean && yarn build",
"test": "yarn lint && yarn tsc && yarn format && yarn unit",
"tsc": "tsc",
Expand Down Expand Up @@ -115,18 +115,16 @@
"update-input-width": "^1.4.0"
},
"devDependencies": {
"@biomejs/biome": "^1.8.0",
"@testing-library/dom": "^10.0.0",
"@testing-library/jest-dom": "^6.0.0",
"@testing-library/react": "^15.0.0",
"@testing-library/user-event": "^14.5.0",
"@types/node": "*",
"@types/react": "*",
"cpy-cli": "^5.0.0",
"eslint": "^8.56.0",
"eslint-config-wojtekmaj": "^1.0.0",
"happy-dom": "^12.6.0",
"nodemon": "^3.0.0",
"prettier": "^3.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"rimraf": "^3.0.0",
Expand Down
9 changes: 3 additions & 6 deletions packages/react-date-picker/src/DateInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ function renderCustomInputs(

return placeholder.split(pattern).reduce<React.ReactNode[]>((arr, element, index) => {
const divider = element && (
// eslint-disable-next-line react/no-array-index-key
// biome-ignore lint/suspicious/noArrayIndexKey: index is stable here
<Divider key={`separator_${index}`}>{element}</Divider>
);
arr.push(divider);
Expand Down Expand Up @@ -240,6 +240,7 @@ export default function DateInput({
setIsCalendarOpen(isCalendarOpenProps);
}, [isCalendarOpenProps]);

// biome-ignore lint/correctness/useExhaustiveDependencies: useEffect intentionally triggered on props change
useEffect(() => {
const nextValue = getDetailValueFrom({
value: valueProps,
Expand Down Expand Up @@ -568,7 +569,6 @@ export default function DateInput({
key="day"
{...commonInputProps}
ariaLabel={dayAriaLabel}
// eslint-disable-next-line jsx-a11y/no-autofocus
autoFocus={index === 0 && autoFocus}
inputRef={dayInput}
month={month}
Expand All @@ -591,7 +591,6 @@ export default function DateInput({
key="month"
{...commonInputProps}
ariaLabel={monthAriaLabel}
// eslint-disable-next-line jsx-a11y/no-autofocus
autoFocus={index === 0 && autoFocus}
inputRef={monthSelect}
locale={locale}
Expand All @@ -610,7 +609,6 @@ export default function DateInput({
key="month"
{...commonInputProps}
ariaLabel={monthAriaLabel}
// eslint-disable-next-line jsx-a11y/no-autofocus
autoFocus={index === 0 && autoFocus}
inputRef={monthInput}
placeholder={monthPlaceholder}
Expand All @@ -627,7 +625,6 @@ export default function DateInput({
key="year"
{...commonInputProps}
ariaLabel={yearAriaLabel}
// eslint-disable-next-line jsx-a11y/no-autofocus
autoFocus={index === 0 && autoFocus}
inputRef={yearInput}
placeholder={yearPlaceholder}
Expand Down Expand Up @@ -666,7 +663,7 @@ export default function DateInput({
}

return (
// eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions
// biome-ignore lint/a11y/useKeyWithClickEvents: This interaction is designed for mouse users only
<div className={className} onClick={onClick}>
{renderNativeInput()}
{renderCustomInputsInternal()}
Expand Down
3 changes: 1 addition & 2 deletions packages/react-date-picker/src/DateInput/Input.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ import { useEffect, useLayoutEffect } from 'react';
import clsx from 'clsx';
import updateInputWidth, { getFontShorthand } from 'update-input-width';

/* eslint-disable jsx-a11y/no-autofocus */

type InputProps = {
ariaLabel?: string;
autoFocus?: boolean;
Expand Down Expand Up @@ -172,6 +170,7 @@ export default function Input({
<input
aria-label={ariaLabel}
autoComplete="off"
// biome-ignore lint/a11y/noAutofocus: This is up to developers' decision
autoFocus={autoFocus}
className={clsx(
`${className}__input`,
Expand Down
3 changes: 1 addition & 2 deletions packages/react-date-picker/src/DateInput/MonthSelect.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { getYear, getMonthHuman } from '@wojtekmaj/date-utils';
import { formatMonth, formatShortMonth } from '../shared/dateFormatter.js';
import { safeMin, safeMax } from '../shared/utils.js';

/* eslint-disable jsx-a11y/no-autofocus */

type MonthSelectProps = {
ariaLabel?: string;
autoFocus?: boolean;
Expand Down Expand Up @@ -56,6 +54,7 @@ export default function MonthSelect({
return (
<select
aria-label={ariaLabel}
// biome-ignore lint/a11y/noAutofocus: This is up to developers' decision
autoFocus={autoFocus}
className={clsx(`${className}__input`, `${className}__${name}`)}
data-input="true"
Expand Down
1 change: 0 additions & 1 deletion packages/react-date-picker/src/DatePicker.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ describe('DatePicker', () => {
});

it('passes autoFocus flag to DateInput', () => {
// eslint-disable-next-line jsx-a11y/no-autofocus
const { container } = render(<DatePicker autoFocus />);

const customInputs = container.querySelectorAll('input[data-input]');
Expand Down
9 changes: 7 additions & 2 deletions packages/react-date-picker/src/DatePicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const iconProps = {
};

const CalendarIcon = (
// biome-ignore lint/a11y/noSvgWithoutTitle: Purely decorative icon
<svg
{...iconProps}
className={`${baseClassName}__calendar-button__icon ${baseClassName}__button__icon`}
Expand All @@ -42,6 +43,7 @@ const CalendarIcon = (
);

const ClearIcon = (
// biome-ignore lint/a11y/noSvgWithoutTitle: Purely decorative icon
<svg
{...iconProps}
className={`${baseClassName}__clear-button__icon ${baseClassName}__button__icon`}
Expand Down Expand Up @@ -528,7 +530,6 @@ export default function DatePicker(props: DatePickerProps) {
<DateInput
{...ariaLabelProps}
{...placeholderProps}
// eslint-disable-next-line jsx-a11y/no-autofocus
autoFocus={autoFocus}
className={`${baseClassName}__inputGroup`}
disabled={disabled}
Expand Down Expand Up @@ -620,7 +621,11 @@ export default function DatePicker(props: DatePickerProps) {
);
}

const eventProps = useMemo(() => makeEventProps(otherProps), [otherProps]);
const eventProps = useMemo(
() => makeEventProps(otherProps),
// biome-ignore lint/correctness/useExhaustiveDependencies: FIXME
[otherProps],
);

return (
<div
Expand Down
2 changes: 0 additions & 2 deletions test/.eslintignore

This file was deleted.

3 changes: 0 additions & 3 deletions test/.eslintrc.json

This file was deleted.

1 change: 0 additions & 1 deletion test/.prettierignore

This file was deleted.

2 changes: 0 additions & 2 deletions test/Test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ const placeholderProps = {
const nineteenNinetyFive = new Date(1995, now.getUTCMonth() + 1, 15, 12);
const fifteenthOfNextMonth = new Date(now.getUTCFullYear(), now.getUTCMonth() + 1, 15, 12);

/* eslint-disable no-console */

type ReturnValue = 'start' | 'end' | 'range';

export default function Test() {
Expand Down
8 changes: 3 additions & 5 deletions test/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"scripts": {
"build": "vite build",
"dev": "vite",
"format": "prettier --check . --cache",
"lint": "eslint . --ext .js,.jsx,.ts,.tsx",
"format": "biome format",
"lint": "biome lint",
"preview": "vite preview",
"test": "yarn lint && yarn tsc && yarn format",
"tsc": "tsc"
Expand All @@ -25,11 +25,9 @@
"react-dom": "^18.2.0"
},
"devDependencies": {
"@biomejs/biome": "^1.8.0",
"@types/react": "*",
"@vitejs/plugin-react": "^4.2.0",
"eslint": "^8.56.0",
"eslint-config-wojtekmaj": "^1.0.0",
"prettier": "^3.2.0",
"typescript": "^5.4.2",
"vite": "^5.0.0"
}
Expand Down
Loading

0 comments on commit 42efbfb

Please sign in to comment.