diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6fb51239271..140e32ff3fb3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -344,18 +344,11 @@ When adding new features, the documentation should be part of a new PR, which wi ### Analyzers and lint rules -To know the technical details of how our analyzer works, how to create a rule and how to write tests, please check our [internal -documentation page](https://rustdocs.rome.tools/biome_analyze/index.html) - -### JavaScript Parser - -To know the technical details of how our JavaScript works and how to write test, please check our [internal -documentation page](https://rustdocs.rome.tools/biome_js_parser/index.html) +To know the technical details of how our analyzer works, how to create a rule and how to write tests, please check our [contribution page](https://github.com/biomejs/biome/blob/main/crates/biome_analyze/CONTRIBUTING.md) ### Formatter -To know the technical details of how our formatter works and how to write test, please check our [internal -documentation page](https://rustdocs.rome.tools/biome_js_formatter/index.html) +To know the technical details of how our formatter works and how to write test, please check our [contribution page](https://github.com/biomejs/biome/blob/main/crates/biome_js_formatter/CONTRIBUTING.md) ### Versioning diff --git a/scripts/timetravel.sh b/scripts/timetravel.sh deleted file mode 100755 index c8858f96ba24..000000000000 --- a/scripts/timetravel.sh +++ /dev/null @@ -1,84 +0,0 @@ -#! /bin/bash - -# Suggestions: - -# All Changes to a particular file -# git log --pretty=format:"%H" --follow | ../timetravel.sh check test.js - -# Last N commits -# git log -n 10 --pretty=format:"%H" | ../timetravel.sh check test.js - -rm target/result.md - -# get current branch to restore it later -current="$(git rev-parse --abbrev-ref HEAD)" - -allruns=() -IFS=$'\n' -set -f - -IDX=1 -while read i -do - # change to a specific commit - git checkout "$i" -q - git log -1 --pretty=%s - - # check if a compiled version of this commit already exists - if [ ! -f "target/$i" ]; then - cargo build -p biome_cli --release 2>&1 > /dev/null - cp target/release/biome "target/$i" - fi - - # Print details about this commit - title=$(git log -1 --pretty=%s) - echo "# $IDX - $title" >> target/result.md - - echo "## Details" >> target/result.md - - git log -1 --pretty=%b >> target/result.md - echo "" >> target/result.md - git log -1 --pretty=%ai >> target/result.md - - # Run this commit version and print the result - echo "## Result" >> target/result.md - echo "\`\`\`" >> target/result.md - eval "target/$i" check $1 &>> target/result.md - echo "\`\`\`" >> target/result.md - echo "" >> target/result.md - echo "" >> target/result.md - - # Save how to run this version to use it - # later with hyperfine - allruns+=("target/$i check $1") - allruns+=("--command-name") - allruns+=("$IDX") - ((IDX++)) -done - -# restore original branch -git checkout "$current" -q - -# Run hyperfine and generate a report -echo "# Performance" >> target/result.md -hyperfine ${allruns[*]} -i --shell=none --export-markdown target/hyperfine.md --export-json target/hyperfine.json -cat target/hyperfine.md >> target/result.md -rm target/hyperfine.md -echo "" >> target/result.md - -# Plot hyperfine result -python3 << EOF -#!/usr/bin/env python -import json -import matplotlib.pyplot as plt -f = open("target/hyperfine.json") -results = json.load(f)["results"] -labels=[b["command"] for b in results] -plt.boxplot([b["times"] for b in results]) -plt.plot(list(range(1, len(results) + 1)), [b["mean"] for b in results]) -plt.savefig("target/whisker.png") -EOF - -echo "" >> target/result.md -echo "![benchmark](whisker.png)" >> target/result.md -echo "" >> target/result.md