Skip to content

initial oxlint and oxfmt #9

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

Merged
elf-pavlik merged 4 commits into from
Nov 13, 2025
Merged

initial oxlint and oxfmt #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6f5fc80
initial oxlint and oxfmt
elf-pavlik Nov 11, 2025
8097597
fix linting errors
elf-pavlik Nov 12, 2025
15a6df4
oxfmt - add experimentalSortImports
elf-pavlik Nov 12, 2025
b6d41a9
run formatter
elf-pavlik Nov 12, 2025
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
8 changes: 7 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
pull_request:

jobs:
test:
check:
runs-on: ubuntu-latest

steps:
Expand All @@ -20,5 +20,11 @@ jobs:
- name: Install dependencies
run: npm ci

- name: Run lint
run: npm run lint -- --deny-warnings

- name: Run format
run: npm run format -- --check

- name: Run tests
run: npm test
14 changes: 14 additions & 0 deletions .oxfmtrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"printWidth": 100,
"singleQuote": true,
"tabWidth": 2,
"semi": false,
"trailingComma": "all",
"experimentalSortImports": {
"partitionByComment": false,
"sortSideEffects": false,
"order": "asc",
"ignoreCase": true
}
}
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Before commit
Copy link
Copy Markdown
Contributor

@jacoscaz jacoscaz Nov 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than before commit, I would encourage collaborators to lint and format before submitting a PR for review by maintainers. IMHO, as long as someone is working on their own branch they should be free to reason about their code without having to consider linting and formatting, committing as many times as they want.

Copy link
Copy Markdown
Contributor

@jacoscaz jacoscaz Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than this everything LGTM!

Copy link
Copy Markdown
Member Author

@elf-pavlik elf-pavlik Nov 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fine tune the CONTRIBUTING.md later. The CI workflow runs on any push and PR, if people don't lint and format before commit, whenever they push changes to their fork, they will get notifications about failing build.


Run linter

```shell
npm run lint
```

run formatter

```shell
npm run format
```


2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
npm run build
node dist/bin/start.js
```

Please see [CONTRIBUTING](CONTRIBUTING.md)
Loading