Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
cache: npm
node-version-file: .node-version
registry-url: https://npm.pkg.github.com/
scope: '@doist'
scope: "@doist"

- name: Publish package to GitHub Packages registry
run: npm publish
Expand Down
2 changes: 0 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
Expand Down
5 changes: 0 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,13 @@ If you intend to change the public API, or make any non-trivial changes to the i
## Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:

- [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

## Project Setup

Before you can contribute to the codebase, you will need to fork the react-compiler-tracker repository, and the following steps will help you hit the ground running:

1. Fork the repository (click the <kbd>Fork</kbd> button at the top right of [this page](https://github.com/Doist/react-compiler-tracker));

2. Clone your fork locally;
Expand All @@ -50,7 +48,6 @@ cd react-compiler-tracker
## Development Workflow

After cloning react-compiler-tracker and installing all dependencies, several commands are at your disposal:

- `npm run build`: Builds the `@doist/react-compiler-tracker` package for publishing to [npm](https://www.npmjs.com/);
- `npm run check`: Validates code quality and types with Biome and TypeScript;
- `npm run fix`: Automatically fixes linting issues with Biome;
Expand All @@ -66,7 +63,6 @@ The release process for react-compiler-tracker is automated with [release-please
Pull requests are actively monitored, and only need the approval of one or more core team members. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

Before submitting a pull request, please take the following into consideration:

- Fork [the repository](https://github.com/Doist/react-compiler-tracker) and create your branch from `main`;
- Follow the [Commit Message Guidelines](#commit-message-guidelines) below;
- Add tests for code that should be tested (like bug fixes);
Expand All @@ -78,7 +74,6 @@ Before submitting a pull request, please take the following into consideration:
#### Atomic Commits

If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:

- A commit should not mix whitespace and/or code style changes with functional code changes;
- A commit should contain exactly one self-contained functional change;
- A commit should not create an inconsistent state (e.g., test errors, linting errors, partial fix, etc.).
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Create a `.react-compiler-tracker.config.json` file in your project root to cust

All fields are optional. Default values are shown above.

| Option | Description | Default |
|--------|-------------|---------|
| `recordsFile` | Path to the records file | `.react-compiler.rec.json` |
| `sourceGlob` | Glob pattern for source files | `src/**/*.{js,jsx,ts,tsx}` |
| Option | Description | Default |
| ------------- | ----------------------------- | -------------------------- |
| `recordsFile` | Path to the records file | `.react-compiler.rec.json` |
| `sourceGlob` | Glob pattern for source files | `src/**/*.{js,jsx,ts,tsx}` |

### Monorepo Usage

Expand Down Expand Up @@ -134,9 +134,9 @@ In `package.json`:

```json
{
"lint-staged": {
"*.{js,jsx,ts,tsx}": "npm exec --no -- @doist/react-compiler-tracker --stage-record-file"
}
"lint-staged": {
"*.{js,jsx,ts,tsx}": "npm exec --no -- @doist/react-compiler-tracker --stage-record-file"
}
}
```

Expand All @@ -147,11 +147,11 @@ With lint-staged, the matched files are automatically passed as arguments to the
```yaml
- name: Check React Compiler violations
run: |
# Get changed files in the PR
FILES=$(git diff --name-only origin/main...HEAD -- '*.tsx' '*.ts' '*.jsx' '*.js' | tr '\n' ' ')
if [ -n "$FILES" ]; then
npm exec --no -- @doist/react-compiler-tracker --check-files $FILES
fi
# Get changed files in the PR
FILES=$(git diff --name-only origin/main...HEAD -- '*.tsx' '*.ts' '*.jsx' '*.js' | tr '\n' ' ')
if [ -n "$FILES" ]; then
npm exec --no -- @doist/react-compiler-tracker --check-files $FILES
fi
```

### Pre-commit hook (manual)
Expand Down
13 changes: 10 additions & 3 deletions biome.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
{
"$schema": "https://biomejs.dev/schemas/2.4.16/schema.json",
"$schema": "https://biomejs.dev/schemas/2.6.2/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"includes": ["**", "!node_modules", "!dist", "!package.json", "!package-lock.json"]
"includes": [
"**",
"!node_modules",
"!dist",
"!package.json",
"!package-lock.json",
"!CHANGELOG.md"
]
},
"assist": { "actions": { "source": { "organizeImports": "on" } } },
"linter": {
"enabled": true,
"rules": {
"recommended": true
"preset": "recommended"
}
},
"formatter": {
Expand Down
108 changes: 72 additions & 36 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"@babel/core": "7.29.7",
"@babel/preset-react": "7.29.7",
"@babel/preset-typescript": "7.29.7",
"@biomejs/biome": "2.5.15",
"@biomejs/biome": "2.6.2",
"@doist/tsconfig": "2.0.1",
"@types/babel__core": "7.20.5",
"@types/node": "25.9.9",
Expand Down
Loading