Skip to content

rustfmt: Add CI scripts and format onion_utils.rs#2877

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
TheBlueMatt merged 5 commits into from
Feb 22, 2024
Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5344dc
Add `rustfmt` to CI, ignore all files
tnull Feb 5, 2024
997389f
Add `rustfmt` instructions to CONTRIBUTING.md
tnull Feb 6, 2024
627028d
Add `rustfmt::skip` and small adjustments where needed
tnull Feb 6, 2024
18721ba
Run `rustfmt` on `onion_utils.rs`
tnull Feb 12, 2024
5d50e9e
Remove `onion_utils.rs` from exclusion list
tnull Feb 6, 2024
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
17 changes: 17 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
- name: Run default clippy linting
run: |
cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

rustfmt:
runs-on: ubuntu-latest
env:
TOOLCHAIN: 1.63.0
steps:
- name: Checkout source code
uses: actions/checkout@v3
- name: Install Rust ${{ env.TOOLCHAIN }} toolchain
run: |
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
rustup override set ${{ env.TOOLCHAIN }}
- name: Install rustfmt
run: |
rustup component add rustfmt
- name: Run rustfmt checks
run: ci/rustfmt.sh
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down
13 changes: 13 additions & 0 deletions ci/rustfmt.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail

@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.


# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files

@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.


# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
echo "Checking formatting of $file"
rustfmt +1.63.0 --check $file
done
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
`rustfmt`: Add CI scripts and format `onion_utils.rs` by tnull · Pull Request #2877 · lightningdevkit/rust-lightning · GitHub
Skip to content
rustfmt: Add CI scripts and format onion_utils.rs#2877

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

TheBlueMatt
merged 5 commits into

from

Feb 22, 2024
 Merged

rustfmt: Add CI scripts and format onion_utils.rs#2877
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d5344dc

Add `rustfmt` to CI, ignore all files


tnull Feb 5, 2024
997389f

Add `rustfmt` instructions to CONTRIBUTING.md


tnull Feb 6, 2024
627028d

Add `rustfmt::skip` and small adjustments where needed


tnull Feb 6, 2024
18721ba

Run `rustfmt` on `onion_utils.rs`


tnull Feb 12, 2024
5d50e9e

Remove `onion_utils.rs` from exclusion list


tnull Feb 6, 2024

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


17 changes: 17 additions & 0 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -216,3 +216,20 @@ jobs:
 - name: Run default clippy linting
 run: |
 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err

 rustfmt:
 runs-on: ubuntu-latest
 env:
 TOOLCHAIN: 1.63.0
 steps:
 - name: Checkout source code
 uses: actions/checkout@v3
 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 run: |
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
 rustup override set ${{ env.TOOLCHAIN }}
 - name: Install rustfmt
 run: |
 rustup component add rustfmt
 - name: Run rustfmt checks
 run: ci/rustfmt.sh

10 changes: 9 additions & 1 deletion
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -120,7 +120,15 @@ Coding Conventions
------------------

Use tabs. If you want to align lines, use spaces. Any desired alignment should
display fine at any tab-length display setting.
display fine at any tab-length display setting. We use `rustfmt` to establish
uniform coding standards throughout the codebase. Please run

```bash
./ci/rustfmt.sh
```

before committing and pushing any changes, as compliance will also be checked
and enforced by our CI scripts.

Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
linting
Expand Down

13 changes: 13 additions & 0 deletions
ci/rustfmt.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -eox pipefail
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The set -eox pipefail command includes the -x option, which prints commands and their arguments as they are executed. This can inadvertently leak sensitive information in logs. Consider removing -x unless debugging.

# Generate initial exclusion list
#find . -name '*.rs' -type f |sort >rustfmt_excluded_files
@coderabbitaicoderabbitaiBotFeb 6, 2024

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The commented-out find command (#find . -name '*.rs' -type f |sort >rustfmt_excluded_files) suggests an initial approach to generating the exclusion list. If this step is necessary for setup or future use, provide instructions or automate its execution rather than leaving it commented out.

# Run fmt
TMP_FILE=$(mktemp)
find . -name '*.rs' -type f |sort >$TMP_FILE
for file in $(comm -23 $TMP_FILE rustfmt_excluded_files); do
	echo "Checking formatting of $file"
	rustfmt +1.63.0 --check $file
done
Loading