Skip to content

Commit 17c3617

Browse files
frankieyanfrankieyan
committed
Initial commit
0 parents  commit 17c3617

10 files changed

Lines changed: 177 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @{username-or-team-name}

‎.github/dependabot.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "{choose-package-ecosystem}"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

‎.github/workflows/ci.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
tags: [ v* ]
7+
pull_request:
8+
branches: [ main ]
9+
10+
jobs:
11+
lint:
12+
name: Lint
13+
runs-on: ubuntu-latest
14+
timeout-minutes: 60
15+
steps:
16+
- uses: actions/checkout@v4
17+
- run: exit 1 # {todo}
18+
19+
test:
20+
name: Test
21+
needs: lint
22+
runs-on: ubuntu-latest
23+
timeout-minutes: 60
24+
steps:
25+
- uses: actions/checkout@v4
26+
- run: exit 1 # {todo}
27+
28+
publish:
29+
name: Publish new version
30+
needs: test
31+
if: startsWith(github.ref, 'refs/tags/v')
32+
runs-on: ubuntu-latest
33+
timeout-minutes: 60
34+
steps:
35+
- uses: actions/checkout@v4
36+
- run: exit 1 # {todo}
37+
38+
release:
39+
name: Create a release
40+
needs: publish
41+
runs-on: ubuntu-latest
42+
timeout-minutes: 60
43+
steps:
44+
- uses: actions/checkout@v4
45+
- uses: actions/create-release@v1
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
with:
49+
tag_name: ${{ github.ref }}
50+
release_name: ${{ github.ref }}

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Build output
5+
dist/
6+
7+
# Test coverage
8+
coverage/
9+
10+
# IDE
11+
.idea/
12+
.vscode/
13+
*.swp
14+
*.swo
15+
16+
# OS
17+
.DS_Store
18+
Thumbs.db
19+
20+
# Logs
21+
*.log
22+
npm-debug.log*
23+
24+
# Environment
25+
.env
26+
.env.*
27+
28+
# Cache
29+
.eslintcache
30+
*.tsbuildinfo
31+
32+
# Claude
33+
.claude/plans/

‎.node-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
This file documents all notable changes, following the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
4+
5+
## [Unreleased]
6+
7+
-

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Doist
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# React Compiler Tracker
2+
3+
While it's safe to opt out of using memoization hooks such as `useCallback` and `useMemo` in code optimized by the [React Compiler](https://react.dev/learn/react-compiler/introduction), it is easy to introduce violations that cause the compiler to bail out, leading to performance issues when values are not memoized.
4+
5+
Designed to run as a part of Git hooks and CI, this tool helps prevent this and progressively adopt the React Compiler by tracking and warning against newly introduced compilation errors.
6+
7+
## License
8+
9+
Released under the [MIT License](https://opensource.org/licenses/MIT).

‎SECURITY.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
At the moment, we only officially support the latest version of the project with security updates.
6+
7+
## Reporting a vulnerability
8+
9+
Please report any vulnerabilities by [opening an issue]({repository-url}/issues/new) and including as many details as you can. We will prioritize security reports over other issues.
10+
11+
We don't currently offer a bounty for OSS vulnerabilities, but if it affects [one of the eligible targets, you might qualify for a reward](https://todoist.com/help/articles/doist-bug-bounty-policy).

‎package.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "@doist/react-compiler-tracker",
3+
"version": "0.0.0",
4+
"description": "A React Compiler violation tracker to help migrations and prevent regressions",
5+
"type": "module",
6+
"main": "dist/index.js",
7+
"bin": {
8+
"react-compiler-tracker": "dist/index.js"
9+
},
10+
"scripts": {
11+
"test": "echo \"Error: no test specified\" && exit 1"
12+
},
13+
"repository": {
14+
"type": "git",
15+
"url": "git+https://github.com/Doist/react-compiler-tracker.git"
16+
},
17+
"keywords": [
18+
"react",
19+
"react-compiler",
20+
"eslint",
21+
"memoization",
22+
"performance"
23+
],
24+
"author": "Doist Developers <dev@doist.com>",
25+
"license": "MIT",
26+
"bugs": {
27+
"url": "https://github.com/Doist/react-compiler-tracker/issues"
28+
},
29+
"homepage": "https://github.com/Doist/react-compiler-tracker#readme",
30+
"engines": {
31+
"node": ">=22"
32+
},
33+
"files": [
34+
"dist",
35+
"README.md",
36+
"LICENSE"
37+
]
38+
}

0 commit comments

Comments
 (0)