Skip to content

Commit b9d28ff

Browse files
authored
lil updates (#724)
* cleanup after yarn * update comparison
1 parent 7adbc2c commit b9d28ff

File tree

9 files changed

+15
-20
lines changed

9 files changed

+15
-20
lines changed

.cursorrules

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
- This project uses yarn package manager.
1+
- This project uses bun package manager.
2+
- When debugging, you can directly import index.tsx if using the bun CLI without needing a build step to run experimental scripts.
3+
- All scripts can be written in TypeScript since Bun handles it natively.
4+
- Use `bun run test` to run the tests.

.gitignore

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ coverage/
66
*.log
77
package-lock.json
88

9-
# yarn
10-
.yarn/*
11-
!.yarn/patches
12-
!.yarn/plugins
13-
!.yarn/releases
14-
!.yarn/sdks
15-
!.yarn/versions
16-
179
# ephemeral files
1810
dist/
1911
docs/markdown-to-jsx.js

AGENT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ Each markdown element is handled by a rule with this structure:
129129

130130
### Build Process
131131

132-
1. `yarn build`: uses microbundle, needed for benchmarking
133-
2. `yarn size`: Automated bundle size checking
134-
3. `yarn benchmark`: Performance comparison against a recent version of markdown-to-jsx
132+
1. `bun run build`: uses microbundle, needed for benchmarking
133+
2. `bun run size`: Automated bundle size checking
134+
3. `bun run benchmark`: Performance comparison against a recent version of markdown-to-jsx
135135

136136
## Contributing Guidelines
137137

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A good pull request should include a description of the change, any relevant lin
1919

2020
markdown-to-jsx uses semantic versioning. If you're releasing a bugfix, a PATCH version (x.x.X) is sufficient. For new functionality, a MINOR version is warranted (x.X.0). Finally, breaking changes should release a MAJOR version (X.0.0). All maintainers should sign off on breaking changes to ensure they've been thought-through appropriately.
2121

22-
Use the `yarn publish` command to automate the process of building the JS and website, and defining the new version string. Once publish is complete, amend the rebuilt site JS (`git add . && git commit --amend`) and push to main.
22+
Use the `bun run publish` command to automate the process of building the JS and website, and defining the new version string. Once publish is complete, amend the rebuilt site JS (`git add . && git commit --amend`) and push to main.
2323

2424
Then go to the GitHub Releases panel and add a new one with the same version number. Copy and paste the relevant commits from git history with links to the pull requests and make sure you thank the contributor that added them.
2525

bun.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"jest-serializer-html": "^7.1.0",
2323
"jest-watch-typeahead": "^2.2.2",
2424
"markdown-it": "^14.0.0",
25-
"markdown-to-jsx-latest": "npm:markdown-to-jsx@7.7.16",
25+
"markdown-to-jsx-latest": "npm:markdown-to-jsx@8.0.0",
2626
"microbundle": "^0.15.1",
2727
"microtime": "^3.1.1",
2828
"mkdirp": "^3.0.1",
@@ -1163,7 +1163,7 @@
11631163

11641164
"markdown-it": ["[email protected]", "", { "dependencies": { "argparse": "^2.0.1", "entities": "^4.4.0", "linkify-it": "^5.0.0", "mdurl": "^2.0.0", "punycode.js": "^2.3.1", "uc.micro": "^2.1.0" }, "bin": { "markdown-it": "bin/markdown-it.mjs" } }, "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg=="],
11651165

1166-
"markdown-to-jsx-latest": ["markdown-to-jsx@7.7.16", "", { "peerDependencies": { "react": ">= 0.14.0" }, "optionalPeers": ["react"] }, "sha512-2YLPWjSAdJqVCTIQtP3zPPYfLUWuu74Ms7E9vr/RqLTWzPT5clZWNIlgxyzUKD/Gv+P12TNgpnRgtaNNj/vn8A=="],
1166+
"markdown-to-jsx-latest": ["markdown-to-jsx@8.0.0", "", { "peerDependencies": { "react": ">= 0.14.0" }, "optionalPeers": ["react"] }, "sha512-hWEaRxeCDjes1CVUQqU+Ov0mCqBqkGhLKjL98KdbwHSgEWZZSJQeGlJQatVfeZ3RaxrfTrZZ3eczl2dhp5c/pA=="],
11671167

11681168
"math-intrinsics": ["[email protected]", "", {}, "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g=="],
11691169

bunfig.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[install]
22
minimumReleaseAge = 259200 # 3d
3-
minimumReleaseAgeExcludes = ["markdown-to-jsx-latest"]
3+
minimumReleaseAgeExcludes = ["markdown-to-jsx"]

notes/FUZZING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## Quick Stats
66

77
- **36 comprehensive tests**
8-
- **Run**: `yarn test:fuzz`
8+
- **Run**: `bun run test:fuzz`
99
- **Timeout**: 100ms per test
1010
- **Categories**: HTML parsing, inline formatting, combined attacks, repetitive delimiters, random fuzzing
1111

notes/performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ Every attempt made things slower:
7070
## Profiling Tools
7171

7272
```bash
73-
yarn profile # Generate CPU profile
74-
yarn metrics # Show parse time, memory, GC stats
73+
bun run profile # Generate CPU profile
74+
bun run metrics # Show parse time, memory, GC stats
7575
```
7676

7777
View profiles in Speedscope or Chrome DevTools Performance tab.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
"jest-serializer-html": "^7.1.0",
7979
"jest-watch-typeahead": "^2.2.2",
8080
"markdown-it": "^14.0.0",
81-
"markdown-to-jsx-latest": "npm:markdown-to-jsx@7.7.16",
81+
"markdown-to-jsx-latest": "npm:markdown-to-jsx@8.0.0",
8282
"microbundle": "^0.15.1",
8383
"microtime": "^3.1.1",
8484
"mkdirp": "^3.0.1",

0 commit comments

Comments
 (0)